Update docs with example outputs

Author: jacomago

src/site/sphinx/config.rst

@@ -145,46 +145,84 @@ For named policy PVs, the AA plugin will first check that the named policy exist
       # no archiver tag so PV sent to archiver in aa.default_alias
    }
 
+Metrics
+^^^^^^^
 
-EPICS PV Access Server
-----------------------
+Metrics can be exposed by setting the `management.endpoints.web.exposure.include=prometheus` property.
 
-ChannelFinder provides an EPICS PV Access Server to access the api through pvAccess.
-There are a number of options that can be set such EPICS_PVA_ADDR_LIST. To see the
-full list go to `PVASettings javadoc <https://javadoc.io/doc/org.phoebus/core-pva/latest/org/epics/pva/PVASettings.html>`_.
+.. code-block::
 
-Since it is common to run ChannelFinder inside a docker container which by default does not support IPv6 you may have
-error messages in the logs about launching the EPICS PV Access service. If you only wish to have the EPICS Service available on
-IPv4 you can set the environment variable
+    management.endpoints.web.exposure.include=prometheus, metrics, health, info
 
-    EPICS_PVAS_INTF_ADDR_LIST="0.0.0.0"
+Adding the prometheus property will expose the prometheus endpoint which can be scraped by prometheus.
 
-Or to not have the EPICS PV Access Server listen, then:
+The default metrics exposed by specifying "metrics" are:
 
-    EPICS_PVAS_INTF_ADDR_LIST="0.0.0.0"
+.. code-block::
 
-Metrics
-^^^^^^^
+    cf.total.channel.count - Count of all ChannelFinder channels
+    cf.property.count - Count of all Property Names
+    cf.tag.count - Count of all tags
 
-Metrics can be exposed by setting the `management.endpoints.web.exposure.include=prometheus` property. 
+Tag Metrics
+"""""""""""
 
-.. code-block::
+You can also set the metrics.tags to add counts of number of channels per tag. These are exposed as
+`cf.tag_on_channels.count{tag=tagName}`. For example
 
-    management.endpoints.web.exposure.include=prometheus, metrics, health, info
+.. code-block::
 
-Adding the prometheus property will expose the prometheus endpoint which can be scraped by prometheus.
+    metrics.tags=Accelerator, Beamline1, Beamline2, Beamline3
 
-You can also set the metrics.tags to add counts of number of channels per tag. These are exposed as
-`cf_channel_count{tag=tagName}` 
+Would produce metrics:
 
 .. code-block::
 
-    metrics.tags=Accelerator, Beamline, Beamline1, Beamline2, Beamline3
+    cf.tag_on_channels.count=109
+    cf.tag_on_channels.count{tag=Accelerator} = 100
+    cf.tag_on_channels.count{tag=Beamline1} = 3
+    cf.tag_on_channels.count{tag=Beamline2} = 3
+    cf.tag_on_channels.count{tag=Beamline3} = 3
+
+Property Metrics
+""""""""""""""""
 
 You can also set the metrics.properties to add counts of number of channels per property and value. These are exposed as
-`cf_propertyName_channels_count{propertyName=propertyValue}`. 
+`cf_propertyName_channels_count{propertyName=propertyValue}`. For example:
+
+
+.. code-block::
 
+    metrics.properties=pvStatus:Active, Inactive; archive: default, fast, slow; archiver: aa_beamline, aa_acccelerator
+
+Would produce metrics:
 
 .. code-block::
 
-    metrics.properties=pvStatus:Active, Inactive; archive: default, fast, slow; archiver: aa_beamline, aa_acccelerator
+    cf.pvStatus.channel.count=100
+    cf.pvStatus.channel.count{pvStatus=Active}=50
+    cf.pvStatus.channel.count{pvStatus=Active}=50
+    cf.archive.channel.count=21
+    cf.archive.channel.count{archive=default}=1
+    cf.archive.channel.count{archive=fast}=10
+    cf.archive.channel.count{archive=slow}=10
+    cf.archiver.channel.count=20
+    cf.archive.channel.count{archive=aa_beamline}=10
+    cf.archive.channel.count{archive=aa_acccelerator}=10
+
+EPICS PV Access Server
+----------------------
+
+ChannelFinder provides an EPICS PV Access Server to access the api through pvAccess.
+There are a number of options that can be set such EPICS_PVA_ADDR_LIST. To see the
+full list go to `PVASettings javadoc <https://javadoc.io/doc/org.phoebus/core-pva/latest/org/epics/pva/PVASettings.html>`_.
+
+Since it is common to run ChannelFinder inside a docker container which by default does not support IPv6 you may have
+error messages in the logs about launching the EPICS PV Access service. If you only wish to have the EPICS Service available on
+IPv4 you can set the environment variable
+
+    EPICS_PVAS_INTF_ADDR_LIST="0.0.0.0"
+
+Or to not have the EPICS PV Access Server listen, then:
+
+    EPICS_PVAS_INTF_ADDR_LIST="0.0.0.0"