Merge pull request #178 from bstasyszyn/metricsprovider

docs: Updated metrics parameters
trustbloc · Nov 15, 2022 · 1256d0e · 1256d0e
2 parents 452b8ad + 5ff64ea
commit 1256d0e
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 6 deletions.
diff --git a/readthedocs/source/orb/parameters.md b/readthedocs/source/orb/parameters.md
@@ -113,13 +113,26 @@ Anchor credential signature suite (required).
 
 Below are the optional parameters for an Orb server. If not specified then the default value is used.
 
-### host-metrics-url
+### metrics-provider-name
 
-| Arg                | Env                  | Default |
-|--------------------|----------------------|---------|
-| --host-metrics-url | ORB_HOST_METRICS_URL |         |
+| Arg                     | Env                       | Default |
+|-------------------------|---------------------------|---------|
+| --metrics-provider-name | ORB_METRICS_PROVIDER_NAME |         |
 
-URL that exposes the metrics endpoint. Format: HostName:Port.
+The name of the metrics provider. If not set then metrics are not gathered.
+
+Valid values:
+
+- prometheus - [Prometheus](https://prometheus.io/) metrics provider. Parameter [prom-http-url](#prom-http-url) must be set.
+
+### prom-http-url
+
+| Arg              | Env               | Default |
+|------------------|-------------------|---------|
+| --prom-http-url  | ORB_PROM_HTTP_URL |         |
+
+URL that exposes the Prometheus metrics endpoint. Format: host:port. A [Prometheus](https://prometheus.io/) server
+may be used to periodically read the metrics at this URL. (Note that the metrics endpoint would be at http://host:port/metrics.)
 
 ### sync-timeout
 

diff --git a/readthedocs/source/orb/system/metrics.md b/readthedocs/source/orb/system/metrics.md
@@ -1,6 +1,7 @@
 # Metrics
 
-An Orb server records performance metrics at each subsystem. A [Prometheus](https://prometheus.io/) server may be used to periodically read the metrics at the URL specified by the startup parameter, [host-metrics-url](../parameters.html#host-metrics-url). Below are the metrics defined at each subsystem.
+An Orb server records performance metrics at each subsystem if the startup parameter [metrics-provider-name](../parameters.html#metrics-provider-name)
+is set. Below are the metrics defined at each subsystem.
 
 ## ActivityPub