Skip to content

Latest commit

 

History

History
 
 

datadog-monitor

README.md

Component: datadog-monitor

This component is responsible for provisioning Datadog monitors and assigning Datadog roles to the monitors.

It's required that the DataDog API and APP secret keys are available in the consuming account at the var.datadog_api_secret_key and var.datadog_app_secret_key paths in the AWS SSM Parameter Store.

Usage

Stack Level: Regional

Here's an example snippet for how to use this component:

components:
  terraform:
    datadog-monitor:
      settings:
        spacelift:
          workspace_enabled: true
      vars:
        enabled: true
        secrets_store_type: SSM
        local_datadog_monitors_config_paths:
          - "catalog/monitors/dev/*.yaml"
        # Assign roles to monitors to allow/restrict access
        monitors_roles_map:
          aurora-replica-lag-dev:
            - "corporate-it-dev"
            - "development-dev"
            - "site-reliability-dev"
          ec2-failed-status-check-dev:
            - "corporate-it-dev"
            - "development-dev"
            - "site-reliability-dev"

Requirements

Name Version
terraform >= 1.0.0
aws ~> 4.0
datadog >= 3.3.0

Providers

Name Version
aws ~> 4.0

Modules

Name Source Version
datadog_monitors cloudposse/platform/datadog//modules/monitors 0.32.2
datadog_monitors_merge cloudposse/config/yaml//modules/deepmerge 1.0.1
iam_roles ../account-map/modules/iam-roles n/a
local_datadog_monitors_yaml_config cloudposse/config/yaml 1.0.1
remote_datadog_monitors_yaml_config cloudposse/config/yaml 1.0.1
this cloudposse/label/null 0.25.0

Resources

Name Type
aws_secretsmanager_secret.datadog_api_key data source
aws_secretsmanager_secret.datadog_app_key data source
aws_secretsmanager_secret_version.datadog_api_key data source
aws_secretsmanager_secret_version.datadog_app_key data source
aws_ssm_parameter.datadog_api_key data source
aws_ssm_parameter.datadog_app_key data source

Inputs

Name Description Type Default Required
additional_tag_map Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.		 map(string) {} no
alert_tags List of alert tags to add to all alert messages, e.g. ["@opsgenie"] or ["@devops", "@opsgenie"] list(string) null no
alert_tags_separator Separator for the alert tags. All strings from the alert_tags variable will be joined into one string using the separator and then added to the alert message string "\n" no
attributes ID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.		 list(string) [] no
context Single object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.		 any 
{
  "additional_tag_map": {},
  "attributes": [],
  "delimiter": null,
  "descriptor_formats": {},
  "enabled": true,
  "environment": null,
  "id_length_limit": null,
  "label_key_case": null,
  "label_order": [],
  "label_value_case": null,
  "labels_as_tags": [
    "unset"
  ],
  "name": null,
  "namespace": null,
  "regex_replace_chars": null,
  "stage": null,
  "tags": {},
  "tenant": null
}
 no
datadog_api_secret_key The key of the Datadog API secret string "datadog/datadog_api_key" no
datadog_app_secret_key The key of the Datadog Application secret string "datadog/datadog_app_key" no
datadog_monitor_context_tags List of context tags to add to each monitor set(string) 
[
  "namespace",
  "tenant",
  "environment",
  "stage"
]
 no
datadog_monitor_context_tags_enabled Whether to add context tags to each monitor bool true no
datadog_monitor_globals Global parameters to add to each monitor any {} no
datadog_monitors_config_parameters Map of parameters to Datadog monitor configurations map(any) {} no
datadog_secrets_source_store_account Account (stage) holding Secret Store for Datadog API and app keys. string "corp" no
delimiter Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.		 string null no
descriptor_formats Describe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
{<br> format = string<br> labels = list(string)<br>}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).		 any {} no
enabled Set to false to prevent the module from creating any resources bool null no
environment ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' string null no
id_length_limit Limit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.		 number null no
import_profile_name AWS Profile name to use when importing a resource string null no
import_role_arn IAM Role ARN to use when importing a resource string null no
label_key_case Controls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.		 string null no
label_order The order in which the labels (ID elements) appear in the id.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.		 list(string) null no
label_value_case Controls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.		 string null no
labels_as_tags Set of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
Notes:
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.		 set(string) 
[
  "default"
]
 no
local_datadog_monitors_config_paths List of paths to local Datadog monitor configurations list(string) [] no
message_postfix Additional information to put after each monitor message string "" no
message_prefix Additional information to put before each monitor message string "" no
monitors_roles_map Map of Datadog monitor names to a set of Datadog role names to restrict access to the monitors map(set(string)) {} no
name ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.		 string null no
namespace ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique string null no
regex_replace_chars Terraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.		 string null no
region AWS Region string n/a yes
remote_datadog_monitors_base_path Base path to remote Datadog monitor configurations string "" no
remote_datadog_monitors_config_paths List of paths to remote Datadog monitor configurations list(string) [] no
role_paths List of paths to Datadog role configurations list(string) [] no
secrets_store_type Secret store type for Datadog API and app keys. Valid values: SSM, ASM string "SSM" no
stage ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' string null no
tags Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.		 map(string) {} no
tenant ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for string null no

Outputs

Name Description
datadog_monitor_names Names of the created Datadog monitors

References