g3/g3proxy/doc/metrics/index.rst
Zhang Jingqiang 7abd5e5131 update doc
2023-12-21 18:39:36 +08:00

83 lines
1.3 KiB
ReStructuredText

.. _metrics:
#######
Metrics
#######
Currently we only support send metrics to statsd, see :ref:`stat <configuration_stat>` for more details.
The following is the common tags for all metrics:
.. _metrics_tag_daemon_group:
* daemon_group
This tag is the same as the daemon group specified in config file or command args.
.. _metrics_tag_stat_id:
* stat_id
A machine local unique stat_id for dedup purpose. It should be **dropped** by statsd, and the metrics with the same
remaining tags should be aggregated.
.. _metrics_tag_transport:
* transport
Show the transport layer protocol. Values are:
- tcp
- udp
.. _metrics_tag_connection:
* connection
Show the client connection type. Values are:
- http
- socks
.. _metrics_tag_request:
* request
Show the request type. Values ars:
- http_forward
- https_forward
- http_connect
- socks_tcp_connect
- socks_udp_connect
- socks_udp_associate
.. _metrics_tag_quantile:
* quantile
Show the quantile value for histogram stats.
The following values are always persent:
- min
- max
- mean
Values can be added by :ref:`histogram metrics <conf_value_histogram_metrics>` config.
If not set, the following values are added by default:
- 0.50
- 0.80
- 0.90
- 0.95
- 0.99
.. toctree::
server
escaper
resolver
user
user_site
logger