-
Notifications
You must be signed in to change notification settings - Fork 75
Use dict_maps directly in configs #1047
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| --- | ||
| layout: doc | ||
| title: Recommended Metrics | ||
| order: 101 | ||
| dovecotlinks: | ||
| recommended_metrics: Recommended Metrics | ||
| recommended_metrics_dovecot_proxy: | ||
| hash: dovecot-proxy | ||
| text: Dovecot Proxy | ||
| recommended_metrics_dovecot_backend: | ||
| hash: dovecot-backend | ||
| text: Dovecot Backend | ||
| --- | ||
|
|
||
| # Recommended Metrics | ||
|
|
||
| <!-- @include: ../../../core/docs/core/recommended_metrics_include/header.inc --> | ||
|
|
||
| ## Dovecot Proxy | ||
|
|
||
| <!-- @include: ../../../core/docs/core/recommended_metrics_include/proxy.inc --> | ||
|
|
||
| ## Dovecot Backend | ||
|
|
||
| <!-- @include: ../../../core/docs/core/recommended_metrics_include/backend.inc --> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| ### Generic authentication metrics | ||
|
|
||
| `@metric_defaults = backend` contains: | ||
|
|
||
| `auth_successes` | ||
| : Number of successful authentications. See [[event,auth_request_finished]]. | ||
|
|
||
| `auth_failures` | ||
| : Number of unsuccessful authentications. See [[event,auth_request_finished]]. | ||
| These are not usually expected to happen in backends. It may be useful to | ||
| export these events into log: | ||
| ```[dovecot.conf] | ||
| metric auth_failures { | ||
| exporter = log-export | ||
| } | ||
| ``` | ||
|
|
||
| ### Basic mail access and delivery metrics | ||
|
|
||
| `@metric_defaults = backend` contains: | ||
|
|
||
| `imap_commands` | ||
| : Number of IMAP commands, grouped by OK/NO/BAD tagged reply. | ||
| See [[event,imap_command_finished]]. | ||
|
|
||
| `mail_deliveries` | ||
| : Number of mails delivered. See [[event,mail_delivery_finished]]. | ||
|
|
||
| `mail_submissions` | ||
| : Number of mails submitted for outside delivery (e.g. rejects, vacations). | ||
| See [[event,smtp_submit_finished]]. | ||
|
|
||
| `mail_user_session_finished` | ||
| : Number of mail sessions, including their RSS memory usage and user space | ||
| CPU usage at the time when the session was finished. See | ||
| [[event,mail_user_session_finished]]. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| This page lists recommended metrics that allow inspecting dovecot's behavior in | ||
| the most general situations. More specialized situations might require further | ||
| refinements or additional statistics. For an overview of how to gather | ||
| statistics see [[link,stats]]. A list of all available events and their fields | ||
| can be found [[link,summary_events,here]]. | ||
| The following examples use the custom `log-export` exporter. | ||
| ```[dovecot.conf] | ||
| event_exporter log-export { | ||
| format = json | ||
| format_args = time-rfc3339 | ||
| transport = log | ||
| } | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| `@metric_defaults = proxy` contains: | ||
|
|
||
| `auth_successes` | ||
| : Number of successful authentications. See [[event,auth_request_finished]]. | ||
|
|
||
| `auth_failures` | ||
| : Number of unsuccessful authentications. See [[event,auth_request_finished]]. | ||
| It may be useful to export these events into log: | ||
| ```[dovecot.conf] | ||
| metric auth_failures { | ||
| exporter = log-export | ||
| } | ||
| ``` | ||
|
|
||
| `login_aborted` | ||
| : Number of aborted logins, grouped by reason. See [[event,login_aborted]]. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.