datadog-integrations-core/consul/assets/configuration/spec.yaml at 3d513a5a9a390d558a4480467558318b899ff813 · voltusdev/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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
name: Consul
files:
- name: consul.yaml
  options:
  - template: init_config
    options:
      - template: init_config/http
      - template: init_config/default
  - template: instances
    options:
    - name: url
      required: true
      description: |
        Where your Consul HTTP server lives,
        point the URL at the leader to get metrics about your Consul cluster.
        Use HTTPS instead of HTTP if your Consul setup is configured to do so.
      value:
        type: string
        example: http://localhost:8500
    - name: use_prometheus_endpoint
      description: |
        Whether to use the Prometheus endpoint to get more metrics.
        The Prometheus endpoint is available for Consul versions v1.1.0 or higher.
      value:
        type: boolean
        example: false
    - name: catalog_checks
      description: Set to true to perform checks against the Consul service catalog.
      value:
        type: boolean
        example: false
    - name: network_latency_checks
      description: |
        Whether to enable network latency metrics collection. When enabled
        Consul network coordinates is retrieved and latency calculated for
        each node and between data centers.
        See https://www.consul.io/docs/internals/coordinates.html
      value:
        type: boolean
        example: false
    - name: use_node_name_as_hostname
      description: |
        Whether to use the Consul node name as the hostname. If set to true,
        the Agent uses the Consul node name as the hostname. If set to false,
        the Agent uses the system hostname and avoids duplicate hostnames.
        Disabling this causes all the `consul.net.node.*` metrics to be reported
        under one host (the host that collects them), and they can be filtered using `consul_node_name`.
      value:
        type: boolean
        example: true

    - name: self_leader_check
      description: |
        Whether to enable self leader checks. Each instance with this enabled
        watches for itself to become the leader and emits an event when that
        happens. It is safe/expected to enable this on all nodes in a Consul
        cluster since only the new leader emits the (single) event. This
        flag takes precedence over new_leader_checks.
      value:
        type: boolean
        example: false

    - name: acl_token
      description: ACL token to use for authentication.
      value:
        type: string

    - name: single_node_install
      description: |
        Whether or not to perform the full check even when not the leader. Useful
        if you don't want to install the Agent on every node in a data center.
      value:
        type: boolean
        example: false

    - name: new_leader_checks
      description: |
        Whether to enable new leader checks from this instance
        Note: If this is set on multiple instances or Agents in the same cluster
        you receive one event per leader change per instance. See
        self_leader_check for a more robust option.
      value:
        type: boolean
        example: false

    - name: services_include
      description: |
        Services to restrict catalog querying to
        the default settings query up to 50 services. If you have more than
        services in your Consul service catalog, use this include list.
      value:
        type: array
        items:
          type: string
        example:
          - <SERVICE_1>
          - <SERVICE_2>

    - name: services_exclude
      description: |
        List services to exclude from the Consul service catalog.
        Note: The excluded services will take precedence over services_include.
        The default settings will still query up to 50 services.
      value:
        type: array
        items:
          type: string
        example:
          - <SERVICE_1>
          - <SERVICE_2>

    - name: allowed_service_tags
      description: |
        If set, only tags with keys matching this list will be sent to Datadog.
        This is helpful if you have a lot of tags on services that are not
        relevant to Datadog (ingress routing tags, etc). Tags should be specified
        here in lowercase. Otherwise, the check will downcase tags from Consul before comparing.
      value:
        type: array
        items:
          type: string
        example:
          - <TAG_1>
          - <TAG_2>

    - name: max_services
      description: |
        Increase the maximum number of queried services.
      value:
        type: number
        example: 50

    - name: threads_count
      description: |
        Increase the number of threads to collect consul services checks.
      value:
        type: number
        example: 1

    - name: disable_legacy_service_tag
      description: |
        Whether or not to stop submitting the tag `service` that has been renamed
        to `consul_service` and disable the associated deprecation warning.
      value:
        type: boolean
        display_default: false
        example: true
      enabled: true

    - template: instances/http
    - template: instances/default
  - template: logs
    example:
    - type: file
      path: /var/log/consul_server.log
      source: consul
      service: <SERVICE_NAME>