summaryrefslogtreecommitdiffstats
path: root/src/go/collectors/go.d.plugin/modules/zookeeper/metadata.yaml
blob: 527a55fb4872a225d5d11ea0e0d856c1568b37be (plain)
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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
plugin_name: go.d.plugin
modules:
  - meta:
      id: collector-go.d.plugin-zookeeper
      plugin_name: go.d.plugin
      module_name: zookeeper
      monitored_instance:
        name: ZooKeeper
        link: https://zookeeper.apache.org/
        categories:
          - data-collection.service-discovery-registry
        icon_filename: zookeeper.svg
      keywords:
        - zookeeper
      most_popular: false
      info_provided_to_referring_integrations:
        description: ""
      related_resources:
        integrations:
          list:
            - plugin_name: apps.plugin
              module_name: apps
    overview:
      data_collection:
        metrics_description: ""
        method_description: |
          It connects to the Zookeeper instance via a TCP and executes the following commands:
          
          - [mntr](https://zookeeper.apache.org/doc/r3.4.8/zookeeperAdmin.html#sc_zkCommands).
      default_behavior:
        auto_detection:
          description: |
            By default, it detects instances running on localhost by attempting to connect using known ZooKeeper TCP sockets:
            
            - 127.0.0.1:2181
            - 127.0.0.1:2182
        limits:
          description: ""
        performance_impact:
          description: ""
      additional_permissions:
        description: ""
      multi_instance: true
      supported_platforms:
        include: []
        exclude: []
    setup:
      prerequisites:
        list:
          - title: Whitelist `mntr` command
            description: |
              Add `mntr` to Zookeeper's [4lw.commands.whitelist](https://zookeeper.apache.org/doc/current/zookeeperAdmin.html#sc_4lw).
      configuration:
        file:
          name: "go.d/zookeeper.conf"
        options:
          description: |
            The following options can be defined globally: update_every, autodetection_retry.
          folding:
            title: Config options
            enabled: true
          list:
            - name: update_every
              description: Data collection frequency.
              default_value: 1
              required: false
            - name: autodetection_retry
              description: Recheck interval in seconds. Zero means no recheck will be scheduled.
              default_value: 0
              required: false
            - name: address
              description: Server address. The format is IP:PORT.
              default_value: 127.0.0.1:2181
              required: true
            - name: timeout
              description: Connection/read/write/ssl handshake timeout.
              default_value: 1
              required: false
            - name: use_tls
              description: Whether to use TLS or not.
              default_value: false
              required: false
            - name: tls_skip_verify
              description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
              default_value: false
              required: false
            - name: tls_ca
              description: Certification authority that the client uses when verifying the server's certificates.
              default_value: ""
              required: false
            - name: tls_cert
              description: Client TLS certificate.
              default_value: ""
              required: false
            - name: tls_key
              description: Client TLS key.
              default_value: ""
              required: false
        examples:
          folding:
            title: Config
            enabled: true
          list:
            - name: Basic
              description: Local server.
              config: |
                jobs:
                  - name: local
                    address: 127.0.0.1:2181
            - name: TLS with self-signed certificate
              description: Zookeeper with TLS and self-signed certificate.
              config: |
                jobs:
                  - name: local
                    address: 127.0.0.1:2181
                    use_tls: yes
                    tls_skip_verify: yes
            - name: Multi-instance
              description: |
                > **Note**: When you define multiple jobs, their names must be unique.
                
                Collecting metrics from local and remote instances.
              config: |
                jobs:
                  - name: local
                    address: 127.0.0.1:2181
                
                  - name: remote
                    address: 192.0.2.1:2181
    troubleshooting:
      problems:
        list: []
    alerts: []
    metrics:
      folding:
        title: Metrics
        enabled: false
      description: ""
      availability: []
      scopes:
        - name: global
          description: These metrics refer to the entire monitored application.
          labels: []
          metrics:
            - name: zookeeper.requests
              description: Outstanding Requests
              unit: requests
              chart_type: line
              dimensions:
                - name: outstanding
            - name: zookeeper.requests_latency
              description: Requests Latency
              unit: ms
              chart_type: line
              dimensions:
                - name: min
                - name: avg
                - name: max
            - name: zookeeper.connections
              description: Alive Connections
              unit: connections
              chart_type: line
              dimensions:
                - name: alive
            - name: zookeeper.packets
              description: Packets
              unit: pps
              chart_type: line
              dimensions:
                - name: received
                - name: sent
            - name: zookeeper.file_descriptor
              description: Open File Descriptors
              unit: file descriptors
              chart_type: line
              dimensions:
                - name: open
            - name: zookeeper.nodes
              description: Number of Nodes
              unit: nodes
              chart_type: line
              dimensions:
                - name: znode
                - name: ephemerals
            - name: zookeeper.watches
              description: Number of Watches
              unit: watches
              chart_type: line
              dimensions:
                - name: watches
            - name: zookeeper.approximate_data_size
              description: Approximate Data Tree Size
              unit: KiB
              chart_type: line
              dimensions:
                - name: size
            - name: zookeeper.server_state
              description: Server State
              unit: state
              chart_type: line
              dimensions:
                - name: state