github.com/netdata/go.d.plugin@v0.58.1/modules/zookeeper/metadata.yaml (about)

     1  plugin_name: go.d.plugin
     2  modules:
     3    - meta:
     4        id: collector-go.d.plugin-zookeeper
     5        plugin_name: go.d.plugin
     6        module_name: zookeeper
     7        monitored_instance:
     8          name: ZooKeeper
     9          link: https://zookeeper.apache.org/
    10          categories:
    11            - data-collection.service-discovery-registry
    12          icon_filename: zookeeper.svg
    13        keywords:
    14          - zookeeper
    15        most_popular: false
    16        info_provided_to_referring_integrations:
    17          description: ""
    18        related_resources:
    19          integrations:
    20            list:
    21              - plugin_name: apps.plugin
    22                module_name: apps
    23      overview:
    24        data_collection:
    25          metrics_description: ""
    26          method_description: |
    27            It connects to the Zookeeper instance via a TCP and executes the following commands:
    28            
    29            - [mntr](https://zookeeper.apache.org/doc/r3.4.8/zookeeperAdmin.html#sc_zkCommands).
    30        default_behavior:
    31          auto_detection:
    32            description: |
    33              By default, it detects instances running on localhost by attempting to connect using known ZooKeeper TCP sockets:
    34              
    35              - 127.0.0.1:2181
    36              - 127.0.0.1:2182
    37          limits:
    38            description: ""
    39          performance_impact:
    40            description: ""
    41        additional_permissions:
    42          description: ""
    43        multi_instance: true
    44        supported_platforms:
    45          include: []
    46          exclude: []
    47      setup:
    48        prerequisites:
    49          list:
    50            - title: Whitelist `mntr` command
    51              description: |
    52                Add `mntr` to Zookeeper's [4lw.commands.whitelist](https://zookeeper.apache.org/doc/current/zookeeperAdmin.html#sc_4lw).
    53        configuration:
    54          file:
    55            name: "go.d/zookeeper.conf"
    56          options:
    57            description: |
    58              The following options can be defined globally: update_every, autodetection_retry.
    59            folding:
    60              title: Config options
    61              enabled: true
    62            list:
    63              - name: update_every
    64                description: Data collection frequency.
    65                default_value: 1
    66                required: false
    67              - name: autodetection_retry
    68                description: Recheck interval in seconds. Zero means no recheck will be scheduled.
    69                default_value: 0
    70                required: false
    71              - name: address
    72                description: Server address. The format is IP:PORT.
    73                default_value: 127.0.0.1:2181
    74                required: true
    75              - name: timeout
    76                description: Connection/read/write/ssl handshake timeout.
    77                default_value: 1
    78                required: false
    79              - name: use_tls
    80                description: Whether to use TLS or not.
    81                default_value: false
    82                required: false
    83              - name: tls_skip_verify
    84                description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
    85                default_value: false
    86                required: false
    87              - name: tls_ca
    88                description: Certification authority that the client uses when verifying the server's certificates.
    89                default_value: ""
    90                required: false
    91              - name: tls_cert
    92                description: Client TLS certificate.
    93                default_value: ""
    94                required: false
    95              - name: tls_key
    96                description: Client TLS key.
    97                default_value: ""
    98                required: false
    99          examples:
   100            folding:
   101              title: Config
   102              enabled: true
   103            list:
   104              - name: Basic
   105                description: Local server.
   106                config: |
   107                  jobs:
   108                    - name: local
   109                      address: 127.0.0.1:2181
   110              - name: TLS with self-signed certificate
   111                description: Zookeeper with TLS and self-signed certificate.
   112                config: |
   113                  jobs:
   114                    - name: local
   115                      address: 127.0.0.1:2181
   116                      use_tls: yes
   117                      tls_skip_verify: yes
   118              - name: Multi-instance
   119                description: |
   120                  > **Note**: When you define multiple jobs, their names must be unique.
   121                  
   122                  Collecting metrics from local and remote instances.
   123                config: |
   124                  jobs:
   125                    - name: local
   126                      address: 127.0.0.1:2181
   127                  
   128                    - name: remote
   129                      address: 192.0.2.1:2181
   130      troubleshooting:
   131        problems:
   132          list: []
   133      alerts: []
   134      metrics:
   135        folding:
   136          title: Metrics
   137          enabled: false
   138        description: ""
   139        availability: []
   140        scopes:
   141          - name: global
   142            description: These metrics refer to the entire monitored application.
   143            labels: []
   144            metrics:
   145              - name: zookeeper.requests
   146                description: Outstanding Requests
   147                unit: requests
   148                chart_type: line
   149                dimensions:
   150                  - name: outstanding
   151              - name: zookeeper.requests_latency
   152                description: Requests Latency
   153                unit: ms
   154                chart_type: line
   155                dimensions:
   156                  - name: min
   157                  - name: avg
   158                  - name: max
   159              - name: zookeeper.connections
   160                description: Alive Connections
   161                unit: connections
   162                chart_type: line
   163                dimensions:
   164                  - name: alive
   165              - name: zookeeper.packets
   166                description: Packets
   167                unit: pps
   168                chart_type: line
   169                dimensions:
   170                  - name: received
   171                  - name: sent
   172              - name: zookeeper.file_descriptor
   173                description: Open File Descriptors
   174                unit: file descriptors
   175                chart_type: line
   176                dimensions:
   177                  - name: open
   178              - name: zookeeper.nodes
   179                description: Number of Nodes
   180                unit: nodes
   181                chart_type: line
   182                dimensions:
   183                  - name: znode
   184                  - name: ephemerals
   185              - name: zookeeper.watches
   186                description: Number of Watches
   187                unit: watches
   188                chart_type: line
   189                dimensions:
   190                  - name: watches
   191              - name: zookeeper.approximate_data_size
   192                description: Approximate Data Tree Size
   193                unit: KiB
   194                chart_type: line
   195                dimensions:
   196                  - name: size
   197              - name: zookeeper.server_state
   198                description: Server State
   199                unit: state
   200                chart_type: line
   201                dimensions:
   202                  - name: state