Add docs

neutrons · Sep 26, 2024 · e10f498 · e10f498
1 parent 7e8d7f7
commit e10f498
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git 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
@@ -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)