From e10f4981dc61041f96e31e3346562eb46f465285 Mon Sep 17 00:00:00 2001 From: Ross Whitfield Date: Thu, 26 Sep 2024 15:53:36 +1000 Subject: [PATCH] Add docs --- docs/index.rst | 1 + docs/metrics.rst | 11 +++++++++++ 2 files changed, 12 insertions(+) create mode 100644 docs/metrics.rst diff --git a/docs/index.rst b/docs/index.rst index c1ee151e..b5ac721e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -16,6 +16,7 @@ Welcome to Web Monitor's documentation! developer/index users/usecases/index admin + metrics Indices and tables ================== diff --git a/docs/metrics.rst b/docs/metrics.rst new file mode 100644 index 00000000..5def56b3 --- /dev/null +++ b/docs/metrics.rst @@ -0,0 +1,11 @@ +Metrics +======= + +In order to assist in monitoring a collections of metrics is collected and returned in json. + +* https://monitor.sns.gov/metrics/ (for all the data at once) +* https://monitor.sns.gov/metrics/workflow_diagnostics/ (for workflow diagnostics) +* https://monitor.sns.gov/metrics/postprocessing_diagnostics/ (for postprocessing diagnostics) +* https://monitor.sns.gov/metrics/instrument_status/ (for instrument status) +* https://monitor.sns.gov/metrics/run_statuses/ (return the count of the current reduction statuses for all the run started in the last hour) +* https://monitor.sns.gov/metrics/run_statuses/{n}/ (return the count of current reduction statuses for all the run started in the last *n* minutes, *e.g.* https://monitor.sns.gov/metrics/run_statuses/525600/ will return the last year)