netdata/collectors/python.d.plugin/rethinkdbs/metadata.yaml

plugin_name: python.d.plugin
modules:
  - meta:
      plugin_name: python.d.plugin
      module_name: rethinkdbs
      monitored_instance:
        name: RethinkDB
        link: 'https://rethinkdb.com/'
        categories:
          - data-collection.database-servers
        icon_filename: 'rethinkdb.png'
      related_resources:
        integrations:
          list: []
      info_provided_to_referring_integrations:
        description: ''
      keywords:
        - rethinkdb
        - database
        - db
      most_popular: false
    overview:
      data_collection:
        metrics_description: 'This collector monitors metrics about RethinkDB clusters and database servers.'
        method_description: 'It uses the `rethinkdb` python module to connect to a RethinkDB server instance and gather statistics.'
      supported_platforms:
        include: []
        exclude: []
      multi_instance: true
      additional_permissions:
        description: ''
      default_behavior:
        auto_detection:
          description: 'When no configuration file is found, the collector tries to connect to 127.0.0.1:28015.'
        limits:
          description: ''
        performance_impact:
          description: ''
    setup:
      prerequisites:
        list:
          - title: 'Required python module'
            description: 'The collector requires the `rethinkdb` python module to be installed.'
      configuration:
        file:
          name: python.d/rethinkdbs.conf
        options:
          description: |
            There are 2 sections:
            
            * Global variables
            * One or more JOBS that can define multiple different instances to monitor.
            
            The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
            
            Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
            
            Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
          folding:
            title: "Config options"
            enabled: true
          list:
            - name: update_every
              description: Sets the default data collection frequency.
              default_value: 5
              required: false
            - name: priority
              description: Controls the order of charts at the netdata dashboard.
              default_value: 60000
              required: false
            - name: autodetection_retry
              description: Sets the job re-check interval in seconds.
              default_value: 0
              required: false
            - name: penalty
              description: Indicates whether to apply penalty to update_every in case of failures.
              default_value: yes
              required: false
            - name: name
              description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
              default_value: ''
              required: false
            - name: host
              description: Hostname or ip of the RethinkDB server.
              default_value: 'localhost'
              required: false
            - name: port
              description: Port to connect to the RethinkDB server.
              default_value: '28015'
              required: false
            - name: user
              description: The username to use to connect to the RethinkDB server.
              default_value: 'admin'
              required: false
            - name: password
              description: The password to use to connect to the RethinkDB server.
              default_value: ''
              required: false
            - name: timeout
              description: Set a connect timeout to the RethinkDB server.
              default_value: '2'
              required: false
        examples:
          folding:
            enabled: false
            title: "Config"
          list:
            - name: Local RethinkDB server
              description: An example of a configuration for a local RethinkDB server
              folding:
                enabled: false
              config: |
                localhost:
                 name: 'local'
                 host: '127.0.0.1'
                 port: 28015
                 user: "user"
                 password: "pass"
    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: rethinkdb.cluster_connected_servers
              description: Connected Servers
              unit: "servers"
              chart_type: stacked
              dimensions:
                - name: connected
                - name: missing
            - name: rethinkdb.cluster_clients_active
              description: Active Clients
              unit: "clients"
              chart_type: line
              dimensions:
                - name: active
            - name: rethinkdb.cluster_queries
              description: Queries
              unit: "queries/s"
              chart_type: line
              dimensions:
                - name: queries
            - name: rethinkdb.cluster_documents
              description: Documents
              unit: "documents/s"
              chart_type: line
              dimensions:
                - name: reads
                - name: writes
        - name: database server
          description: ""
          labels: []
          metrics:
            - name: rethinkdb.client_connections
              description: Client Connections
              unit: "connections"
              chart_type: line
              dimensions:
                - name: connections
            - name: rethinkdb.clients_active
              description: Active Clients
              unit: "clients"
              chart_type: line
              dimensions:
                - name: active
            - name: rethinkdb.queries
              description: Queries
              unit: "queries/s"
              chart_type: line
              dimensions:
                - name: queries
            - name: rethinkdb.documents
              description: Documents
              unit: "documents/s"
              chart_type: line
              dimensions:
                - name: reads
                - name: writes