alert_policies

Creates, updates, deletes, gets or lists an alert_policies resource.

Overview

Name	alert_policies
Type	Resource
Id	digitalocean.monitoring.alert_policies

Fields

The following fields are returned by SELECT queries:

monitoring_get_alert_policy

An alert policy.

Name	Datatype	Description
alerts	object
compare	string	(GreaterThan, LessThan) (example: GreaterThan)
description	string	(example: CPU Alert)
enabled	boolean
entities	array
tags	array
type	string	(v1/insights/droplet/load_1, v1/insights/droplet/load_5, v1/insights/droplet/load_15, v1/insights/droplet/memory_utilization_percent, v1/insights/droplet/disk_utilization_percent, v1/insights/droplet/cpu, v1/insights/droplet/disk_read, v1/insights/droplet/disk_write, v1/insights/droplet/public_outbound_bandwidth, v1/insights/droplet/public_inbound_bandwidth, v1/insights/droplet/private_outbound_bandwidth, v1/insights/droplet/private_inbound_bandwidth, v1/insights/lbaas/avg_cpu_utilization_percent, v1/insights/lbaas/connection_utilization_percent, v1/insights/lbaas/droplet_health, v1/insights/lbaas/tls_connections_per_second_utilization_percent, v1/insights/lbaas/increase_in_http_error_rate_percentage_5xx, v1/insights/lbaas/increase_in_http_error_rate_percentage_4xx, v1/insights/lbaas/increase_in_http_error_rate_count_5xx, v1/insights/lbaas/increase_in_http_error_rate_count_4xx, v1/insights/lbaas/high_http_request_response_time, v1/insights/lbaas/high_http_request_response_time_50p, v1/insights/lbaas/high_http_request_response_time_95p, v1/insights/lbaas/high_http_request_response_time_99p, v1/dbaas/alerts/load_15_alerts, v1/dbaas/alerts/memory_utilization_alerts, v1/dbaas/alerts/disk_utilization_alerts, v1/dbaas/alerts/cpu_alerts, v1/droplet/autoscale_alerts/current_instances, v1/droplet/autoscale_alerts/target_instances, v1/droplet/autoscale_alerts/current_cpu_utilization, v1/droplet/autoscale_alerts/target_cpu_utilization, v1/droplet/autoscale_alerts/current_memory_utilization, v1/droplet/autoscale_alerts/target_memory_utilization, v1/droplet/autoscale_alerts/scale_up, v1/droplet/autoscale_alerts/scale_down) (example: v1/insights/droplet/cpu)
uuid	string	(example: 78b3da62-27e5-49ba-ac70-5db0b5935c64)
value	number (float)
window	string	(5m, 10m, 30m, 1h) (example: 5m)

monitoring_list_alert_policy

A list of alert policies.

Name	Datatype	Description
links	object
meta	object	Information about the response itself.
policies	array

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
monitoring_get_alert_policy	select	alert_uuid		To retrieve a given alert policy, send a GET request to /v2/monitoring/alerts/{alert_uuid}
monitoring_list_alert_policy	select		per_page, page	Returns all alert policies that are configured for the given account. To List all alert policies, send a GET request to /v2/monitoring/alerts.
monitoring_create_alert_policy	insert	type, description, compare, value, window, entities, tags, alerts, enabled		To create a new alert, send a POST request to /v2/monitoring/alerts.
monitoring_update_alert_policy	replace	alert_uuid, type, description, compare, value, window, entities, tags, alerts, enabled		To update en existing policy, send a PUT request to v2/monitoring/alerts/{alert_uuid}.
monitoring_delete_alert_policy	delete	alert_uuid		To delete an alert policy, send a DELETE request to /v2/monitoring/alerts/{alert_uuid}

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
alert_uuid	string	A unique identifier for an alert policy. (example: 4de7ac8b-495b-4884-9a69-1050c6793cd6)
page	integer	Which 'page' of paginated results to return. (example: 1)
per_page	integer	Number of items returned per page (example: 2)

SELECT examples

monitoring_get_alert_policy

To retrieve a given alert policy, send a GET request to /v2/monitoring/alerts/{alert_uuid}

SELECT
alerts,
compare,
description,
enabled,
entities,
tags,
type,
uuid,
value,
window
FROM digitalocean.monitoring.alert_policies
WHERE alert_uuid = '{{ alert_uuid }}' -- required
;

monitoring_list_alert_policy

Returns all alert policies that are configured for the given account. To List all alert policies, send a GET request to /v2/monitoring/alerts.

SELECT
links,
meta,
policies
FROM digitalocean.monitoring.alert_policies
WHERE per_page = '{{ per_page }}'
AND page = '{{ page }}'
;

INSERT examples

monitoring_create_alert_policy

To create a new alert, send a POST request to /v2/monitoring/alerts.

INSERT INTO digitalocean.monitoring.alert_policies (
alerts,
compare,
description,
enabled,
entities,
tags,
type,
value,
window
)
SELECT 
'{{ alerts }}' /* required */,
'{{ compare }}' /* required */,
'{{ description }}' /* required */,
{{ enabled }} /* required */,
'{{ entities }}' /* required */,
'{{ tags }}' /* required */,
'{{ type }}' /* required */,
{{ value }} /* required */,
'{{ window }}' /* required */
RETURNING
policy
;

Manifest

# Description fields are for documentation purposes
- name: alert_policies
props:
  - name: alerts
    value:
      email:
        - "{{ email }}"
      slack:
        - channel: "{{ channel }}"
          url: "{{ url }}"
  - name: compare
    value: "{{ compare }}"
    valid_values: ['GreaterThan', 'LessThan']
  - name: description
    value: "{{ description }}"
  - name: enabled
    value: {{ enabled }}
  - name: entities
    value:
      - "{{ entities }}"
  - name: tags
    value:
      - "{{ tags }}"
  - name: type
    value: "{{ type }}"
    valid_values: ['v1/insights/droplet/load_1', 'v1/insights/droplet/load_5', 'v1/insights/droplet/load_15', 'v1/insights/droplet/memory_utilization_percent', 'v1/insights/droplet/disk_utilization_percent', 'v1/insights/droplet/cpu', 'v1/insights/droplet/disk_read', 'v1/insights/droplet/disk_write', 'v1/insights/droplet/public_outbound_bandwidth', 'v1/insights/droplet/public_inbound_bandwidth', 'v1/insights/droplet/private_outbound_bandwidth', 'v1/insights/droplet/private_inbound_bandwidth', 'v1/insights/lbaas/avg_cpu_utilization_percent', 'v1/insights/lbaas/connection_utilization_percent', 'v1/insights/lbaas/droplet_health', 'v1/insights/lbaas/tls_connections_per_second_utilization_percent', 'v1/insights/lbaas/increase_in_http_error_rate_percentage_5xx', 'v1/insights/lbaas/increase_in_http_error_rate_percentage_4xx', 'v1/insights/lbaas/increase_in_http_error_rate_count_5xx', 'v1/insights/lbaas/increase_in_http_error_rate_count_4xx', 'v1/insights/lbaas/high_http_request_response_time', 'v1/insights/lbaas/high_http_request_response_time_50p', 'v1/insights/lbaas/high_http_request_response_time_95p', 'v1/insights/lbaas/high_http_request_response_time_99p', 'v1/dbaas/alerts/load_15_alerts', 'v1/dbaas/alerts/memory_utilization_alerts', 'v1/dbaas/alerts/disk_utilization_alerts', 'v1/dbaas/alerts/cpu_alerts', 'v1/droplet/autoscale_alerts/current_instances', 'v1/droplet/autoscale_alerts/target_instances', 'v1/droplet/autoscale_alerts/current_cpu_utilization', 'v1/droplet/autoscale_alerts/target_cpu_utilization', 'v1/droplet/autoscale_alerts/current_memory_utilization', 'v1/droplet/autoscale_alerts/target_memory_utilization', 'v1/droplet/autoscale_alerts/scale_up', 'v1/droplet/autoscale_alerts/scale_down']
  - name: value
    value: {{ value }}
  - name: window
    value: "{{ window }}"
    valid_values: ['5m', '10m', '30m', '1h']

REPLACE examples

monitoring_update_alert_policy

To update en existing policy, send a PUT request to v2/monitoring/alerts/{alert_uuid}.

REPLACE digitalocean.monitoring.alert_policies
SET 
alerts = '{{ alerts }}',
compare = '{{ compare }}',
description = '{{ description }}',
enabled = {{ enabled }},
entities = '{{ entities }}',
tags = '{{ tags }}',
type = '{{ type }}',
value = {{ value }},
window = '{{ window }}'
WHERE 
alert_uuid = '{{ alert_uuid }}' --required
AND type = '{{ type }}' --required
AND description = '{{ description }}' --required
AND compare = '{{ compare }}' --required
AND value = '{{ value }}' --required
AND window = '{{ window }}' --required
AND entities = '{{ entities }}' --required
AND tags = '{{ tags }}' --required
AND alerts = '{{ alerts }}' --required
AND enabled = {{ enabled }} --required
RETURNING
policy;

DELETE examples

monitoring_delete_alert_policy

To delete an alert policy, send a DELETE request to /v2/monitoring/alerts/{alert_uuid}

DELETE FROM digitalocean.monitoring.alert_policies
WHERE alert_uuid = '{{ alert_uuid }}' --required
;