diff --git a/envoy/README.md b/envoy/README.md index 39cc772b944fa..944e8726b8f1b 100644 --- a/envoy/README.md +++ b/envoy/README.md @@ -12,7 +12,12 @@ The Envoy check is included in the [Datadog Agent][2] package, so you don't need #### Istio -If you are using Envoy as part of [Istio][3], be sure to use the appropriate [Envoy admin endpoint][4] for the `stats_url`. +If you are using Envoy as part of [Istio][3], configure the Envoy integration to collect metrics from the Istio proxy metrics endpoint. + + ```yaml + instances: + - openmetrics_endpoint: localhost:15090/stats/prometheus + ``` #### Standard @@ -100,45 +105,16 @@ To configure this check for an Agent running on a host: init_config: instances: - ## @param stats_url - string - required - ## The admin endpoint to connect to. It must be accessible: - ## https://www.envoyproxy.io/docs/envoy/latest/operations/admin - ## Add a `?usedonly` on the end if you wish to ignore - ## unused metrics instead of reporting them as `0`. - # - - stats_url: http://localhost:80/stats + ## @param openmetrics_endpoint - string - required + ## The URL exposing metrics in the OpenMetrics format. + # + - openmetrics_endpoint: http://localhost:8001/stats/prometheus + ``` 2. Check if the Datadog Agent can access Envoy's [admin endpoint][5]. 3. [Restart the Agent][9]. -###### Metric filtering - -Metrics can be filtered with the parameters`included_metrics` or `excluded_metrics` using regular expressions. If both parameters are used, `included_metrics` is applied first, then `excluded_metrics` is applied on the resulting set. - -The filtering occurs before tag extraction, so you have the option to have certain tags decide whether or not to keep or ignore metrics. An exhaustive list of all metrics and tags can be found in [metrics.py][10]. Let's walk through an example of Envoy metric tagging! - -```python -... -'cluster.grpc.success': { - 'tags': ( - ('', ), - ('', '', ), - (), - ), - ... -}, -... -``` - -Here there are `3` tag sequences: `('')`, `('', '')`, and empty `()`. The number of sequences corresponds exactly to how many metric parts there are. For this metric, there are `3` parts: `cluster`, `grpc`, and `success`. Envoy separates everything with a `.`, hence the final metric name would be: - -`cluster..grpc...success` - -If you care only about the cluster name and grpc service, you would add this to your `included_metrics`: - -`^cluster\.\.grpc\.\.` - ##### Log collection