Skip to content

Commit 2188654

Browse files
authored
Update the envoy and istio specs to more descriptive (#21866)
* spec update to make clear that these options should be used separately * spec sync * changelog
1 parent 10f0323 commit 2188654

File tree

7 files changed

+14
-8
lines changed

7 files changed

+14
-8
lines changed

envoy/assets/configuration/spec.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ files:
2121
It must be accessible:
2222
https://www.envoyproxy.io/docs/envoy/latest/operations/admin
2323
Add a `?usedonly` on the end if you wish to ignore
24-
unused metrics instead of reporting them as `0`.
24+
unused metrics instead of reporting them as `0`. Cannot be used in combination with `openmetrics_endpoint`
25+
in the same instance.
2526
2627
Note: see the configuration options specific to this option here,
2728
https://github.com/DataDog/integrations-core/blob/7.33.x/envoy/datadog_checks/envoy/data/conf.yaml.example

envoy/changelog.d/21866.fixed

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Update the envoy and istio specs to more descriptive of restrictions

envoy/datadog_checks/envoy/data/conf.yaml.example

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,8 @@ instances:
5555
## It must be accessible:
5656
## https://www.envoyproxy.io/docs/envoy/latest/operations/admin
5757
## Add a `?usedonly` on the end if you wish to ignore
58-
## unused metrics instead of reporting them as `0`.
58+
## unused metrics instead of reporting them as `0`. Cannot be used in combination with `openmetrics_endpoint`
59+
## in the same instance.
5960
##
6061
## Note: see the configuration options specific to this option here,
6162
## https://github.com/DataDog/integrations-core/blob/7.33.x/envoy/datadog_checks/envoy/data/conf.yaml.example

istio/assets/configuration/spec.yaml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ files:
1111
description: |
1212
Use the OpenMetrics V2 implementation for more features and better performance.
1313
This implementation is only available for Istio >= 1.5, and should be used with
14-
`istiod_endpoint` and/or `istio_mesh_endpoint`.
14+
`istiod_endpoint` or `istio_mesh_endpoint`.
1515
value:
1616
example: true
1717
display_default: false
@@ -20,14 +20,15 @@ files:
2020
- name: istiod_endpoint
2121
description: |
2222
Collect mixer, galley, pilot, and citadel metrics available from the istiod deployment.
23-
Only available for Istio >= v1.5.
23+
Only available for Istio >= v1.5. Cannot be used in combination with `istio_mesh_endpoint` in the same instance.
2424
value:
2525
display_default: null
2626
example: http://istiod.istio-system:15014/metrics
2727
type: string
2828
- name: istio_mesh_endpoint
2929
description: |
3030
To enable Istio metrics you must specify the url exposing the API.
31+
Cannot be used in combination with `istiod_endpoint` in the same instance.
3132
Note for RHEL and SUSE users: due to compatibility issues, the check does not make use of
3233
the CPP extension to process Protocol buffer messages coming from the api. Depending
3334
on the metrics volume, the check may run very slowly.
@@ -83,7 +84,7 @@ files:
8384
description: |
8485
Use the OpenMetrics V2 implementation for more features and better performance.
8586
This implementation is only available for Istio >= 1.5, and should be used with
86-
`istiod_endpoint` and/or `istio_mesh_endpoint`.
87+
`istiod_endpoint` or `istio_mesh_endpoint`.
8788
value:
8889
example: true
8990
display_default: false

istio/changelog.d/21866.fixed

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Update the envoy and istio specs to more descriptive of restrictions

istio/datadog_checks/istio/data/auto_conf.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ instances:
1919
## @param use_openmetrics - boolean - optional - default: false
2020
## Use the OpenMetrics V2 implementation for more features and better performance.
2121
## This implementation is only available for Istio >= 1.5, and should be used with
22-
## `istiod_endpoint` and/or `istio_mesh_endpoint`.
22+
## `istiod_endpoint` or `istio_mesh_endpoint`.
2323
#
2424
# use_openmetrics: true
2525

istio/datadog_checks/istio/data/conf.yaml.example

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,18 +48,19 @@ instances:
4848
## @param use_openmetrics - boolean - optional - default: false
4949
## Use the OpenMetrics V2 implementation for more features and better performance.
5050
## This implementation is only available for Istio >= 1.5, and should be used with
51-
## `istiod_endpoint` and/or `istio_mesh_endpoint`.
51+
## `istiod_endpoint` or `istio_mesh_endpoint`.
5252
#
5353
- use_openmetrics: true
5454

5555
## @param istiod_endpoint - string - optional
5656
## Collect mixer, galley, pilot, and citadel metrics available from the istiod deployment.
57-
## Only available for Istio >= v1.5.
57+
## Only available for Istio >= v1.5. Cannot be used in combination with `istio_mesh_endpoint` in the same instance.
5858
#
5959
# istiod_endpoint: http://istiod.istio-system:15014/metrics
6060

6161
## @param istio_mesh_endpoint - string - optional
6262
## To enable Istio metrics you must specify the url exposing the API.
63+
## Cannot be used in combination with `istiod_endpoint` in the same instance.
6364
## Note for RHEL and SUSE users: due to compatibility issues, the check does not make use of
6465
## the CPP extension to process Protocol buffer messages coming from the api. Depending
6566
## on the metrics volume, the check may run very slowly.

0 commit comments

Comments
 (0)