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

plugin_name: python.d.plugin
modules:
  - meta:
      plugin_name: python.d.plugin
      module_name: exim
      monitored_instance:
        name: Exim
        link: "https://www.exim.org/"
        categories:
          - data-collection.mail-servers
        icon_filename: "exim.jpg"
      related_resources:
        integrations:
          list: []
      info_provided_to_referring_integrations:
        description: ""
      keywords:
        - exim
        - mail
        - server
      most_popular: false
    overview:
      data_collection:
        metrics_description: "This collector monitors Exim mail queue."
        method_description: "It uses the `exim` command line binary to get the statistics."
      supported_platforms:
        include: []
        exclude: []
      multi_instance: false
      additional_permissions:
        description: ""
      default_behavior:
        auto_detection:
          description: "Assuming setup prerequisites are met, the collector will try to gather statistics using the method described above, even without any configuration."
        limits:
          description: ""
        performance_impact:
          description: ""
    setup:
      prerequisites:
        list:
          - title: "Exim configuration - local installation"
            description: |
              The module uses the `exim` binary, which can only be executed as root by default. We need to allow other users to `exim` binary. We solve that adding `queue_list_requires_admin` statement in exim configuration and set to `false`, because it is `true` by default. On many Linux distributions, the default location of `exim` configuration is in `/etc/exim.conf`.
              
              1. Edit the `exim` configuration with your preferred editor and add:
              `queue_list_requires_admin = false`
              2. Restart `exim` and Netdata
          - title: "Exim configuration - WHM (CPanel) server"
            description: |
              On a WHM server, you can reconfigure `exim` over the WHM interface with the following steps.
              
              1. Login to WHM
              2. Navigate to Service Configuration --> Exim Configuration Manager --> tab Advanced Editor
              3. Scroll down to the button **Add additional configuration setting** and click on it.
              4. In the new dropdown which will appear above we need to find and choose:
              `queue_list_requires_admin` and set to `false`
              5. Scroll to the end and click the **Save** button.
      configuration:
        file:
          name: python.d/exim.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: command
              description: Path and command to the `exim` binary
              default_value: "exim -bpc"
              required: false
        examples:
          folding:
            enabled: false
            title: "Config"
          list:
            - name: Local exim install
              description: A basic local exim install
              config: |
                local:
                 command: 'exim -bpc'
    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: exim.qemails
              description: Exim Queue Emails
              unit: "emails"
              chart_type: line
              dimensions:
                - name: emails