Skip to content

Commit

Permalink
Update permission docs on postfix input (influxdata#7255)
Browse files Browse the repository at this point in the history
  • Loading branch information
danielnelson authored Apr 3, 2020
1 parent 6445e77 commit fb0fee0
Showing 1 changed file with 14 additions and 9 deletions.
23 changes: 14 additions & 9 deletions plugins/inputs/postfix/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@

The postfix plugin reports metrics on the postfix queues.

For each of the active, hold, incoming, maildrop, and deferred queues (http://www.postfix.org/QSHAPE_README.html#queues), it will report the queue length (number of items), size (bytes used by items), and age (age of oldest item in seconds).
For each of the active, hold, incoming, maildrop, and deferred queues
(http://www.postfix.org/QSHAPE_README.html#queues), it will report the queue
length (number of items), size (bytes used by items), and age (age of oldest
item in seconds).

### Configuration

Expand All @@ -13,12 +16,15 @@ For each of the active, hold, incoming, maildrop, and deferred queues (http://ww
# queue_directory = "/var/spool/postfix"
```

#### Permissions:
#### Permissions

Telegraf will need read access to the files in the queue directory. You may
need to alter the permissions of these directories to provide access to the
telegraf user.

This can be setup either using standard unix permissions or with Posix ACLs,
you will only need to use one method:

Unix permissions:
```sh
$ sudo chgrp -R telegraf /var/spool/postfix/{active,hold,incoming,deferred}
Expand All @@ -29,21 +35,20 @@ $ sudo chmod g+r /var/spool/postfix/maildrop

Posix ACL:
```sh
$ sudo setfacl -m g:telegraf:rX /var/spool/postfix/{,active,hold,incoming,deferred,maildrop}
$ sudo setfacl -Rdm g:telegraf:rX /var/spool/postfix/{,active,hold,incoming,deferred,maildrop}
$ sudo setfacl -Rm g:telegraf:rX /var/spool/postfix/
$ sudo setfacl -dm g:telegraf:rX /var/spool/postfix/
```

### Measurements & Fields:
### Metrics

- postfix_queue
- tags:
- queue
- fields:
- length (integer)
- size (integer, bytes)
- age (integer, seconds)

### Tags:

- postfix_queue
- queue

### Example Output

Expand Down

0 comments on commit fb0fee0

Please sign in to comment.