-
Notifications
You must be signed in to change notification settings - Fork 79
docs: clarify notifiers and alerts #3736
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
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
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 |
|---|---|---|
| @@ -1,41 +1,80 @@ | ||
| --- | ||
| title: Alerts About Application Metrics | ||
| nav: Alerts | ||
| modified_at: 2018-03-27 00:00:00 | ||
| modified_at: 2026-05-05 00:00:00 | ||
| tags: app alert metrics | ||
| index: 37 | ||
| --- | ||
|
|
||
| Scalingo lets you create alerts based on an application metric. When the metric's value goes above | ||
| or below a user-defined limit, Scalingo sends a notification on some specified notifiers. See [this | ||
| page]({% post_url platform/app/2000-01-01-notification %}) for more information about the notifiers. | ||
|
|
||
| An alert can be added to an application by going to the Settings tab and Alerts sub-menu. | ||
|
|
||
| ## Alert Parameters | ||
|
|
||
| In order to create a new alert, a few parameters must be provided: | ||
|
|
||
| - Container type: can be any container type of an application (e.g. web, | ||
| clock...). | ||
| - Metric: | ||
| 1. CPU: percentage of CPU consumption | ||
| 1. RAM: percentage of memory consumption | ||
| 1. Swap: percentage of swap consumption | ||
| 1. Response time: 95th percentile of the requests response time | ||
| 1. 5xx errors: amount of HTTP errors (status code ranges from 500 to 599) | ||
| 1. RPM: requests per minute (RPM) received by your application. | ||
| 1. RPM per container: If your application is scaled on multiple containers, | ||
| the RPM per container divides the RPM of the application by the amount of | ||
| containers. | ||
| - Limit: any float value. | ||
| - Send when below: send the alert when metric value is _below_ the limit. | ||
| - Notifiers: list of [notifiers]({% post_url | ||
| platform/app/2000-01-01-notification %}) the alert send a notification to. | ||
| - Duration before trigger: send the alert when metric value is above the limit | ||
| for the specified duration. For example, specifying 4 minutes means that the | ||
| alert will be triggered if the limit is reached for 4 consecutive minutes. | ||
|
|
||
| ## Monitoring alert events | ||
| Scalingo lets you create alerts based on an [application metric][metrics]. | ||
| When the metric's value matches a configured condition for a selected duration, | ||
| Scalingo sends a notification to selected [app notifiers][notifiers]. | ||
|
|
||
| ## Creating Alerts | ||
|
|
||
| ### From the Dashboard | ||
|
|
||
| - From your web browser, open your Scalingo dashboard. | ||
| - Select the app for which you want to create an alert. | ||
| - Click the **Settings** tab. | ||
| - In the settings menu, select **Alerts**. | ||
| - Click **Add**. | ||
| - Configure the trigger conditions, including the container type, metric, limit, | ||
| comparison, and duration before trigger. | ||
| - Select the notifier(s) to use when the alert is triggered. | ||
| - Click **Finish**. | ||
|
|
||
| ### Alert Requirements | ||
|
|
||
| An alert requires at least one notifier and a trigger condition: | ||
|
|
||
| Container type | ||
| : Can be any container type of an application (e.g. `web`, `clock`...). | ||
|
|
||
| Metric | ||
| : - CPU: percentage of CPU consumption | ||
| - RAM: percentage of memory consumption | ||
| - Swap: percentage of swap consumption | ||
| - Response time: 95th percentile of the requests response time | ||
| - 5xx errors: amount of HTTP errors (status code ranges from 500 to 599) | ||
| - RPM: requests per minute (RPM) received by your application. | ||
| - RPM per container: If your application is scaled on multiple containers, | ||
| the RPM per container divides the RPM of the application by the amount of | ||
| containers. | ||
|
|
||
| Limit | ||
| : Any float value. | ||
|
|
||
| Comparison | ||
| : Send the alert when the metric value is above or below the limit. | ||
|
|
||
| Notifiers | ||
| : List of [app notifiers][notifiers] the alert sends a notification to. | ||
|
|
||
| Duration before trigger | ||
| : Send the alert when the metric value matches the configured condition for the | ||
| specified duration. For example, specifying 4 minutes means that the alert | ||
| is triggered if the condition is matched for 4 consecutive minutes. | ||
|
|
||
| ## Sending alert notifications | ||
|
|
||
| Alerts use the same [notifiers] as application events. An alert must use at least | ||
| one notifier. Each app has a default notifier. | ||
|
|
||
| For more information, please visit the page dedicated to [app notifiers][notifiers]. | ||
|
|
||
| ## Alert Events | ||
|
|
||
| Every time an alert is triggered, an event is created. This event appears on the application's | ||
| Activity. The user responsible for the operation is labeled `scalingo-platform`. An event is also generated when an alert is created or deleted. | ||
| Activity. The user responsible for the operation is labeled `scalingo-platform`. | ||
|
|
||
| The alert-related event types are: | ||
|
|
||
| | Event Type | Display Name | Description | | ||
| | --------------------- | --------------- | ---------------------------- | | ||
| | `alert_added` | Alert Added | An alert has been configured | | ||
| | `alert_deleted` | Alert Deleted | An alert has been deleted | | ||
| | `app_alert_triggered` | Alert triggered | An alert was triggered | | ||
|
|
||
| [notifiers]: {% post_url platform/app/2000-01-01-notifiers %} | ||
| [metrics]: {% post_url platform/app/2000-01-01-metrics %} | ||
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 was deleted.
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
question: Shouldn't we also use "An alert has been triggered"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, I saw that too, and that's the current wording in the admin, so I have chosen to leave it that way since we should rework the notifier description as a whole.