Metrics

How are metrics emitted?

CBAS emits custom metrics via Actuator API and Micrometer. Most metrics are emitted from MicrometerMetrics.java class.

See Micrometer documentation for different types of metrics that can be emitted.

How to find these metrics in Azure Portal?

Instructions are here.

List of metrics

Below are list of metrics emitted from CBAS via Micrometer as of 2024-07-02:

Event/Counter metrics

Metric name	Description
records_per_request	Number of record IDs in submission request
inputs_per_request	Number of inputs in submission request
outputs_per_request	Number of outputs in submission request
runs_submitted_successfully_per_run_set	Runs that were successfully submitted to Cromwell from a RunSet
run_callback	Records callbacks received from Cromwell
run_smartpoller_update	Run status update performed by SmartPoller
dockstore_method_import_error	Number of Dockstore method import error
github_method_import_error	Number of GitHub method import error
run_set_updates_required	Number of RunSets whose status update needs to be done
run_set_updates_polled	Number of RunSets that were polled for status update
run_updates_required	Number of Runs whose status update needs to be done
run_updates_polled	Number of Runs that were polled for status update
files_updated_in_wds	Number of file outputs that were written back to WDS

Timer metrics

Metric name	Description
post_method_response_timing	Response timing for POST /method API
post_runset_response_timing	Response timing for POST /run_set API
wes_runSummary	Response timing for outbound API call to /wes/runSummary
wds_fetch_records_timer	Total time to fetch records from WDS per submission
cromwell_request_to_initial_submission_timer	Time between when the submission request is received and when the first workflow batch in that submission is submitted to Cromwell
cromwell_request_to_final_submission_timer	Time between when the submission request is received and when the last workflow batch in that submission is submitted to Cromwell
cromwell_submit_runs_timer	Total time to submit all workflows in a submission to Cromwell
bio_terra_cbas_runsets_results_RunCompletionHandler_updateResults	Method timing for updateResults()
bio_terra_cbas_runsets_monitoring_SmartRunSetsPoller_updateRunSets	Method timing for updateRunSets()
bio_terra_cbas_runsets_monitoring_SmartRunsPoller_updateRuns	Method timing for updateRuns()
bio_terra_cbas_runsets_monitoring_SmartRunSetsPoller_updateRunSet	Method timing for updateRunSet()
bio_terra_cbas_runsets_monitoring_SmartRunsPoller_updateDatabaseRunStatus	Method timing for updateDatabaseRunStatus()