metadata.yaml 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124
  1. plugin_name: python.d.plugin
  2. modules:
  3. - meta:
  4. plugin_name: python.d.plugin
  5. module_name: postfix
  6. monitored_instance:
  7. name: Postfix
  8. link: https://www.postfix.org/
  9. categories:
  10. - data-collection.mail-servers
  11. icon_filename: "postfix.svg"
  12. related_resources:
  13. integrations:
  14. list: []
  15. info_provided_to_referring_integrations:
  16. description: ""
  17. keywords:
  18. - postfix
  19. - mail
  20. - mail server
  21. most_popular: false
  22. overview:
  23. data_collection:
  24. metrics_description: >
  25. Keep an eye on Postfix metrics for efficient mail server operations.
  26. Improve your mail server performance with Netdata's real-time metrics and built-in alerts.
  27. method_description: >
  28. Monitors MTA email queue statistics using [postqueue](http://www.postfix.org/postqueue.1.html) tool.
  29. supported_platforms:
  30. include: []
  31. exclude: []
  32. multi_instance: true
  33. additional_permissions:
  34. description: >
  35. Postfix has internal access controls that limit activities on the mail queue. By default, all users are allowed to view
  36. the queue. If your system is configured with stricter access controls, you need to grant the `netdata` user access to
  37. view the mail queue. In order to do it, add `netdata` to `authorized_mailq_users` in the `/etc/postfix/main.cf` file.
  38. See the `authorized_mailq_users` setting in
  39. the [Postfix documentation](https://www.postfix.org/postconf.5.html) for more details.
  40. default_behavior:
  41. auto_detection:
  42. description: "The collector executes `postqueue -p` to get Postfix queue statistics."
  43. limits:
  44. description: ""
  45. performance_impact:
  46. description: ""
  47. setup:
  48. prerequisites:
  49. list: []
  50. configuration:
  51. file:
  52. name: ""
  53. description: ""
  54. options:
  55. description: |
  56. There are 2 sections:
  57. * Global variables
  58. * One or more JOBS that can define multiple different instances to monitor.
  59. 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.
  60. Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
  61. Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
  62. folding:
  63. title: Config options
  64. enabled: true
  65. list:
  66. - name: update_every
  67. description: Sets the default data collection frequency.
  68. default_value: 1
  69. required: false
  70. - name: priority
  71. description: Controls the order of charts at the netdata dashboard.
  72. default_value: 60000
  73. required: false
  74. - name: autodetection_retry
  75. description: Sets the job re-check interval in seconds.
  76. default_value: 0
  77. required: false
  78. - name: penalty
  79. description: Indicates whether to apply penalty to update_every in case of failures.
  80. default_value: yes
  81. required: false
  82. - name: name
  83. 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.
  84. default_value: ""
  85. required: false
  86. examples:
  87. folding:
  88. enabled: true
  89. title: ""
  90. list: []
  91. troubleshooting:
  92. problems:
  93. list: []
  94. alerts: []
  95. metrics:
  96. folding:
  97. title: Metrics
  98. enabled: false
  99. description: ""
  100. availability: []
  101. scopes:
  102. - name: global
  103. description: |
  104. These metrics refer to the entire monitored application.
  105. labels: []
  106. metrics:
  107. - name: postfix.qemails
  108. description: Postfix Queue Emails
  109. unit: "emails"
  110. chart_type: line
  111. dimensions:
  112. - name: emails
  113. - name: postfix.qsize
  114. description: Postfix Queue Emails Size
  115. unit: "KiB"
  116. chart_type: area
  117. dimensions:
  118. - name: size