> ## Documentation Index
> Fetch the complete documentation index at: https://docs.germainux.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Create an Alert
> Alerts are one of several notification and automation capabilities available in GermainUX.
Components
[`Agent`](https://docs.germainux.com/main/germainux-agent)
[`Engine`](https://docs.germainux.com/main/germain-ux-engine)
Service
`Automation`
Availability
2014.1 or later
> [card] [Trigger an Alert from an SLA](#trigger-an-alert-from-an-sla)
>
> Attach alerts to SLAs
> [card] [Alert Templates](#alert-templates)
>
> Customize alert messages
> [card] [Alert Configuration Reference](#alert-configuration-reference)
>
> Settings for every field
> [card] [Reduce Alert Volume](#reduce-alert-volume)
>
> Limit repetitive alerts
## Alerts Overview
Alerts are one of several notification and automation capabilities available in GermainUX. They notify selected recipients when an SLA is breached or another configured condition requires attention.
See [Notification Types](https://docs.germainux.com/main/notifications.md) for other available notification mechanisms.
## Create or Edit an Alert
Go to:
**Germain Workspace -> Left Menu → Settings → Automation -> Alerts**
From the Alerts screen, you can create, update, enable, disable, or review alert actions.
Most configuration fields include tooltips explaining their purpose and expected values.
### Local or Remote Execution
An alert can be executed:
| Mode | Description |
| - | - |
| **Local** | The alert is executed by Germain Enterprise. |
| **Remote** | The alert is executed through a selected GermainUX Engine, allowing the action to run from a specific server or environment. |
Use remote execution when the alert must access resources, networks, scripts, or services available only from a particular monitored environment.
## Trigger an Alert from an SLA
An alert can be assigned to an SLA from either the KPI or SLA configuration.
Go to:
* **Germain Workspace -> Left Menu → Settings → Analytics -> KPIs**
* **Germain Workspace -> Left Menu → Settings → Analytics -> SLAs**
Then:
1. Select or create the KPI.
2. Select or create the SLA.
3. Configure the SLA condition, evaluation period, and measure.
4. Select an alert template.
5. Select the Alert Action.
6. Save the configuration.
When the SLA is breached and its activation requirements are satisfied, GermainUX executes the Alert Action.
### SLA Evaluation Example
Assume an SLA is configured with:
* **Period Count:** `5`
* **Granularity:** `Minutes`
* **KPI Measure:** Average CPU Usage
GermainUX evaluates the average CPU usage recorded during the previous five minutes.
Other examples include:
* A period count of `2` with a granularity of `Days` evaluates the previous two days.
* A period count of `30` with a granularity of `Minutes` evaluates the previous 30 minutes.
## Alert Templates
Alert templates define the message delivered to recipients. Templates can contain KPI, SLA, application, system, user, error, and other contextual information.
The preview capability lets you review the rendered message while editing the template.
See [Configure Alert and Report Templates](https://docs.germainux.com/main/templates.md).
### Execute an Action from an Alert
An alert template can include a link that lets an authorized recipient execute a GermainUX action.
#### Action Link Without Additional References
```html theme={null}
Execute action: Test Action
```
#### Action Link with Additional References
```html theme={null}
Execute action: Test Action
```
The referenced values become available to the executed action as:
| Reference | Value |
| - | - |
| `Server` | |
| `Credentials` | |
| `Var1` | |
| `Var2` | |
References already defined on the `ActionConfig` object remain available automatically. Template links can add dynamic references required for a specific execution.
## Alert Configuration Reference
| Workspace field | Configuration key | Description | Values | Default |
| - | - | - | - | - |
| **Name** | `name` | Unique name identifying the Alert Action. | String | — |
| **Distribution List** | `alertGroupName` | Distribution List that receives the alert. | Existing Distribution List name | — |
| **Execute via Engine** | `remote` | When enabled, allows an Engine or target server to execute the alert. | Boolean or calculated field | — |
| **Triggered by SLAs** | — | SLAs currently configured to trigger this action. | Calculated collection | — |
| **Quiet Time Used** | `quietTimeUsed` | Prevents the same alert from firing again during the quiet-time period after its first occurrence. | `true` or `false` | `true` |
| **Quiet Time Period** | `quietTimePeriod` | Quiet-time duration in seconds. A value of `0` uses the system default. | Integer | — |
| **Logging Enabled** | `loggingEnabled` | Enables execution logging for the alert. | `true` or `false` | — |
| **Notify on Success** | `notifyOnSuccess` | Sends a notification when the action completes successfully. | `true` or `false` | — |
| **Notify on Failure** | `notifyOnFailure` | Sends a notification when the action fails. | `true` or `false` | — |
| **Execution Count** | `limitCount` | Maximum number of executions allowed during the configured interval. | Integer | — |
| **Execution Interval** | `limitInterval` | Time interval over which the execution limit applies. | `YEAR`, `MONTH`, `WEEK`, `DAY`, `HOUR`, or `MINUTE` | — |
| **Number of Retries** | `numberOfRetires` | Number of retry attempts after a delivery failure. | Integer | `0` |
See Quiet Time for additional configuration details.
## Reduce Alert Volume
GermainUX provides two primary mechanisms for limiting repetitive alerts.
### Quiet Time
Quiet Time is configured on the Alert Action.
After the alert fires, GermainUX suppresses additional executions of that alert during the configured quiet-time period.
Use Quiet Time when repeated SLA violations would otherwise generate multiple notifications for the same ongoing issue.
### Activation Count
Activation Count is configured on the SLA.
The SLA Action is triggered only after the configured number of violations has occurred.
For example, an Activation Count of `3` requires three qualifying violations before the alert is sent.
Go to:
**Germain Workspace → Left Menu → Settings --> Analytics --> SLAs**
Quiet Time limits repeated notifications after an alert fires, while Activation Count prevents an alert from firing until the required number of violations has been reached.
## Get Help
> [card] [Contact GermainUX Support](https://docs.germainux.com/main/support.md)
>
> The GermainUX team helps you get up and running faster, empower your team, turn data into actionable insights, and optimize performance to deliver measurable business outcomes.
> [card] Can't find what you need?
>
> Search all GermainUX docs with **Ctrl + K**, or use the feedback buttons at the bottom of this page to tell us what is missing.
The content of this document is proprietary to GERMAIN SOFTWARE.
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.