https://emissary-ingress.dev/docs/4.1/topics/running/statistics/ Recent content in Statistics and monitoring on Hugo en https://emissary-ingress.dev/docs/4.1/topics/running/statistics/envoy-statsd/ Mon, 01 Jan 0001 00:00:00 +0000 https://emissary-ingress.dev/docs/4.1/topics/running/statistics/envoy-statsd/ <blockquote> <p>For an overview of other options for gathering statistics on Emissary, see the <a href="https://emissary-ingress.dev/docs/4.1/topics/running/">Statistics and Monitoring</a> overview.</p> </blockquote> <p>At the core of Emissary is <a href="https://www.envoyproxy.io">Envoy Proxy</a>, which has built-in support for exporting a multitude of statistics about its own operations to StatsD (or to the modified DogStatsD used by Datadog).</p> <p>If enabled, then Emissary has Envoy expose this information via the <a href="https://github.com/etsy/statsd">StatsD</a> protocol. To enable this, you will simply need to set the environment variable <code>STATSD_ENABLED=true</code> in Emissary&rsquo;s deployment YAML:</p> https://emissary-ingress.dev/docs/4.1/topics/running/statistics/8877-metrics/ Mon, 01 Jan 0001 00:00:00 +0000 https://emissary-ingress.dev/docs/4.1/topics/running/statistics/8877-metrics/ <blockquote> <p>For an overview of other options for gathering statistics on Emissary, see the <a href="https://emissary-ingress.dev/docs/4.1/topics/running/">Statistics and Monitoring</a> overview.</p> </blockquote> <p>Each Emissary pod exposes statistics and metrics for that pod at <code>http://{POD}:8877/metrics</code>. The response is in the text-based Prometheus <a href="https://prometheus.io/docs/instrumenting/exposition_formats/">exposition format</a>.</p> <h2 id="understanding-the-statistics">Understanding the statistics</h2> <p>The Prometheus exposition format includes special &ldquo;HELP&rdquo; lines that make the file self-documenting as to what specific statistics mean.</p> <!-- TODO(lukeshu): Go in to more detail about Envoy's statistics; the discoverability of them in Envoy's docs is really bad. The best thing to grep for in envoy.git is: git grep -E ', *(Gauge|Counter|Histogram) *,' docs --> <ul> <li><code>envoy_*</code>: See the <a href="https://www.envoyproxy.io/docs/envoy/v1.23.0/operations/admin.html#get--stats-prometheus">Envoy documentation</a>.</li> <li><code>ambassador_*</code>: <ul> <li><code>ambassador_edge_stack_*</code> (not present in Emissary): <ul> <li><code>ambassador_edge_stack_go_*</code>: See [<code>promethus.NewGoCollector()</code>][].</li> <li><code>ambassador_edge_stack_promhttp_*</code> See <a href="https://godoc.org/github.com/prometheus/client_golang/prometheus/promhttp#Handler"><code>promhttp.Handler()</code></a>.</li> <li><code>ambassador_edge_stack_process_*</code>: See [<code>promethus.NewProcessCollector()</code>][]..</li> </ul> </li> <li><code>ambassador_*_time_seconds</code> (for <code>*</code> = one of <code>aconf</code>, <code>diagnostics</code>, <code>econf</code>, <code>fetcher</code>, <code>ir</code>, or <code>reconfiguration</code>): Gauges of how long the various core operations take in the diagd process.</li> <li><code>ambassador_diagnostics_(errors|notices)</code>: The number of diagnostics errors and notices that would be shown in the diagnostics UI or the Edge Policy Console.</li> <li><code>ambassador_diagnostics_info</code>: <a href="https://github.com/prometheus/client_python#info">Info</a> about the Emissary install; all information is presented in labels; the value of the Gauge is always &ldquo;1&rdquo;.</li> <li><code>ambassador_process_*</code>: See <a href="https://github.com/prometheus/client_python#process-collector"><code>prometheus_client.ProcessCollector</code></a>.</li> </ul> </li> </ul> <h2 id="polling-the-8877metrics-endpoint-with-prometheus">Polling the <code>:8877/metrics</code> endpoint with Prometheus</h2> <p>To scrape metrics directly, follow the instructions for <a href="../../../../howtos/prometheus">Monitoring with Prometheus and Grafana</a>.</p>