integrations-core/coredns/assets/configuration/spec.yaml at f3e67530ab47e4b6ec0c7e986ed6c887a29237bd · DataDog/integrations-core · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
name: CoreDNS
files:
- name: coredns.yaml
  options:
  - template: init_config
    options:
      - template: init_config/openmetrics
  - template: instances
    options:
    - template: instances/openmetrics
      overrides:
        openmetrics_endpoint.required: false
        openmetrics_endpoint.enabled: true
        openmetrics_endpoint.display_priority: 3
        openmetrics_endpoint.value.example: http://%%host%%:9153/metrics
        openmetrics_endpoint.description: The URL where CoreDNS exposes Prometheus metrics.
        tags.display_priority: 1
        tags.value.example:
          - "dns-pod:%%host%%"
        extra_metrics.value.example:
          - coredns_template_matches: template_matches
          - coredns_template_template_failures: template_templating_failures
          - coredns_template_rr_failures: template_resource_record_failures
    - template: instances/openmetrics_legacy_base
      hidden: true
      overrides:
        prometheus_url.required: false
        prometheus_url.hidden: false
- name: auto_conf.yaml
  options:
  - template: ad_identifiers
    overrides:
      value.example:
      - coredns
  - template: init_config
    options: []
  - template: instances
    options:
    - name: prometheus_url
      description: |
        To enable CoreDNS metrics using the legacy OpenMetricsBaseCheckV1 you must specify the prometheus url
        and enable the plugin within coredns.
        See: https://coredns.io/plugins/metrics/

        Either `prometheus_url` or `openmetrics_endpoint` must be specified.
        See documentation: https://docs.datadoghq.com/integrations/coredns

      enabled: true
      legacy: true
      value:
        type: string
        example: "http://%%host%%:9153/metrics"
    - name: tags
      description: |
        List of tags to attach to every metric and service check emitted by this integration.

        Learn more about tagging: https://docs.datadoghq.com/tagging/
      required: True
      value:
        type: array
        items:
          type: string
        example:
          - "dns-pod:%%host%%"
    - name: send_histograms_buckets
      description: (Legacy OpenMetricsBaseCheckV1) Set send_histograms_buckets to true to send the histograms bucket.
      legacy: true
      value:
        type: boolean
        example: True
    - name: send_monotonic_counter
      description: |
        (Legacy OpenMetricsBaseCheckV1) To send counters as monotonic counter
        see: https://github.com/DataDog/integrations-core/issues/1303
      legacy: true
      value:
        type: boolean
        example: True
    - name: metrics
      description: |
        (Legacy OpenMetricsBaseCheckV1) Metrics from the CoreDNS plugins for 'metrics', 'proxy', 'forward' and 'cache'
        are enabled by default, however in order to scrape metrics for optional
        plugins, enable the plugin in the CoreDNS corefile and then add the metric below.
        As an example, the 'template' plugin's metrics are below
      legacy: true
      value:
        type: array
        items:
          type: string
        example:
          - coredns_template_matches_total: template_matches_count
          - coredns_template_template_failures_total: template_templating_failures_count
          - coredns_template_rr_failures_total: template_resource_record_failures_count
    - name: openmetrics_endpoint
      description: |
        To enable CoreDNS metrics using OpenMetricsBaseCheckV2 you must specify the openmetrics endpoint url
        and enable the plugin within coredns.
        See: https://coredns.io/plugins/metrics/

        Either `prometheus_url` or `openmetrics_endpoint` must be specified.
        See documentation: https://docs.datadoghq.com/integrations/coredns
      value:
        type: string
        example: "http://%%host%%:9153/metrics"
    - name: extra_metrics
      description: |
        (OpenMetricsBaseCheckV2) Metrics from the CoreDNS plugins for 'metrics', 'proxy', 'forward' and 'cache'
        are enabled by default, however in order to scrape metrics for optional
        plugins, enable the plugin in the CoreDNS corefile and then add the metric below.
        As an example, the 'template' plugin's metrics are below
      value:
        type: array
        items:
          type: string
        example:
          - coredns_template_matches_total: template_matches_count
          - coredns_template_template_failures_total: template_templating_failures_count
          - coredns_template_rr_failures_total: template_resource_record_failures_count