plugin_name: python.d.plugin
modules:
  - meta:
      plugin_name: python.d.plugin
      module_name: postfix
      monitored_instance:
        name: Postfix
        link: https://www.postfix.org/
        categories:
          - data-collection.mail-servers
        icon_filename: "postfix.svg"
      related_resources:
        integrations:
          list: []
      info_provided_to_referring_integrations:
        description: ""
      keywords:
        - postfix
        - mail
        - mail server
      most_popular: false
    overview:
      data_collection:
        metrics_description: >
          Keep an eye on Postfix metrics for efficient mail server operations. 
          
          Improve your mail server performance with Netdata's real-time metrics and built-in alerts.
        method_description: >
          Monitors MTA email queue statistics using [postqueue](http://www.postfix.org/postqueue.1.html) tool.
      supported_platforms:
        include: []
        exclude: []
      multi_instance: true
      additional_permissions:
        description: >
          Postfix has internal access controls that limit activities on the mail queue. By default, all users are allowed to view
          the queue. If your system is configured with stricter access controls, you need to grant the `netdata` user access to
          view the mail queue. In order to do it, add `netdata` to `authorized_mailq_users` in the `/etc/postfix/main.cf` file.
          
          See the `authorized_mailq_users` setting in
          the [Postfix documentation](https://www.postfix.org/postconf.5.html) for more details.
      default_behavior:
        auto_detection:
          description: "The collector executes  `postqueue -p` to get Postfix queue statistics."
        limits:
          description: ""
        performance_impact:
          description: ""
    setup:
      prerequisites:
        list: []
      configuration:
        file:
          name: ""
          description: ""
        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: 1
              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
        examples:
          folding:
            enabled: true
            title: ""
          list: []
    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: postfix.qemails
              description: Postfix Queue Emails
              unit: "emails"
              chart_type: line
              dimensions:
                - name: emails
            - name: postfix.qsize
              description: Postfix Queue Emails Size
              unit: "KiB"
              chart_type: area
              dimensions:
                - name: size