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

plugin_name: python.d.plugin
modules:
  - meta:
      plugin_name: python.d.plugin
      module_name: dovecot
      monitored_instance:
        name: Dovecot
        link: 'https://www.dovecot.org/'
        categories:
          - data-collection.mail-servers
        icon_filename: 'dovecot.svg'
      related_resources:
        integrations:
          list: []
      info_provided_to_referring_integrations:
        description: ''
      keywords:
        - dovecot
        - imap
        - mail
      most_popular: false
    overview:
      data_collection:
        metrics_description: 'This collector monitors Dovecot metrics about sessions, logins, commands, page faults and more.'
        method_description: 'It uses the dovecot socket and executes the `EXPORT global` command to get the statistics.'
      supported_platforms:
        include: []
        exclude: []
      multi_instance: true
      additional_permissions:
        description: ''
      default_behavior:
        auto_detection:
          description: 'If no configuration is given, the collector will attempt to connect to dovecot using unix socket localized in `/var/run/dovecot/stats`'
        limits:
          description: ''
        performance_impact:
          description: ''
    setup:
      prerequisites:
        list:
          - title: 'Dovecot configuration'
            description: The Dovecot UNIX socket should have R/W permissions for user netdata, or Dovecot should be configured with a TCP/IP socket.
      configuration:
        file:
          name: python.d/dovecot.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: socket
              description: Use this socket to communicate with Devcot
              default_value: /var/run/dovecot/stats
              required: false
            - name: host
              description: Instead of using a socket, you can point the collector to an ip for devcot statistics.
              default_value: ''
              required: false
            - name: port
              description: Used in combination with host, configures the port devcot listens to.
              default_value: ''
              required: false
        examples:
          folding:
            enabled: true
            title: "Config"
          list:
            - name: Local TCP
              description: A basic TCP configuration.
              config: |
                localtcpip:
                 name: 'local'
                 host: '127.0.0.1'
                 port: 24242
            - name: Local socket
              description: A basic local socket configuration
              config: |
                localsocket:
                 name: 'local'
                 socket: '/var/run/dovecot/stats'
    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: dovecot.sessions
              description: Dovecot Active Sessions
              unit: "number"
              chart_type: line
              dimensions:
                - name: active sessions
            - name: dovecot.logins
              description: Dovecot Logins
              unit: "number"
              chart_type: line
              dimensions:
                - name: logins
            - name: dovecot.commands
              description: Dovecot Commands
              unit: "commands"
              chart_type: line
              dimensions:
                - name: commands
            - name: dovecot.faults
              description: Dovecot Page Faults
              unit: "faults"
              chart_type: line
              dimensions:
                - name: minor
                - name: major
            - name: dovecot.context_switches
              description: Dovecot Context Switches
              unit: "switches"
              chart_type: line
              dimensions:
                - name: voluntary
                - name: involuntary
            - name: dovecot.io
              description: Dovecot Disk I/O
              unit: "KiB/s"
              chart_type: area
              dimensions:
                - name: read
                - name: write
            - name: dovecot.net
              description: Dovecot Network Bandwidth
              unit: "kilobits/s"
              chart_type: area
              dimensions:
                - name: read
                - name: write
            - name: dovecot.syscalls
              description: Dovecot Number of SysCalls
              unit: "syscalls/s"
              chart_type: line
              dimensions:
                - name: read
                - name: write
            - name: dovecot.lookup
              description: Dovecot Lookups
              unit: "number/s"
              chart_type: stacked
              dimensions:
                - name: path
                - name: attr
            - name: dovecot.cache
              description: Dovecot Cache Hits
              unit: "hits/s"
              chart_type: line
              dimensions:
                - name: hits
            - name: dovecot.auth
              description: Dovecot Authentications
              unit: "attempts"
              chart_type: stacked
              dimensions:
                - name: ok
                - name: failed
            - name: dovecot.auth_cache
              description: Dovecot Authentication Cache
              unit: "number"
              chart_type: stacked
              dimensions:
                - name: hit
                - name: miss