Alerting
Alerting
Alerting defines the high-level intent for configuring alerting rules and notification channels across the platform.
From a technical perspective, this resource maps directly into creating and managing notification endpoints (e.g. Google Cloud Monitoring Notification Channels) and binds system-generated alerting policies to them. The engine orchestrates these definitions by parsing the spec and generating corresponding concrete infrastructure resources to ensure observability targets are automatically met.
| Property | Type | Description |
|---|---|---|
| apiVersion | string | The API version of the manifest, enforcing backward compatibility contracts. |
| kind | string | The resource type discriminator, explicitly defining this block as an Alerting object. |
| metadata | map | Custom metadata for labeling and classifying the resource within the control plane. |
| spec | Spec | The concrete definition configuring alerting targets and states. |
Spec
Spec contains the user-defined configuration for alerting and notifications. This nested structure encapsulates the actual connectivity parameters for notification sinks and the explicit toggle for whether the alerting suite is active. It acts as the raw inputs during execution planning for the observability suite.
| Property | Type | Description |
|---|---|---|
| enabled | bool | Whether alerting is comprehensively enabled or disabled for this scope. |
| description | string | A string providing descriptive context about this alerting scope, primarily for UI/AI comprehension. |
| notifications | Notifications | The explicit configuration of notification channels to route platform alerts. |
Notifications
Notifications details the list of supported channels where alerts can be routed. Technically, it groups implementations (like Slack, PagerDuty, etc.) so the engine can conditionally provision channels based on what the user defines. These mappings become direct properties sent to the respective Cloud API clients.
| Property | Type | Description |
|---|---|---|
| slack | Slack | The configuration of the Slack notification channel. |
Slack
Slack defines the endpoint and target configuration for Slack-based notifications. It requires an authenticated webhook URL and a target channel name. In execution, the API url is validated and injected securely, while the channel dictates the routing parameter for the generated payload sink.
| Property | Type | Description |
|---|---|---|
| apiUrl | string | The authenticated webhook URL endpoint targeting a specific Slack instance. |
| channel | string | The explicit Slack channel name to route the alerting JSON payload towards. |