Skip to content

justtrackio/terraform-aws-ecs-gosoline-monitoring

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Requirements

Name Version
terraform >= 1.3.0
aws >= 4.67, != 5.71.0
elasticstack >= 0.11.4
gosoline >= 1.0.0
grafana >= 1.40.1

Providers

Name Version
aws >= 4.67, != 5.71.0
elasticstack >= 0.11.4
gosoline >= 1.0.0
grafana >= 1.40.1

Modules

Name Source Version
alarm_consumer justtrackio/ecs-alarm-consumer/aws 1.2.1
alarm_gateway justtrackio/ecs-alarm-gateway/aws 1.4.0
alarm_kinsumer justtrackio/ecs-alarm-kinsumer/aws 1.1.2
alarm_scheduled justtrackio/ecs-alarm-scheduled/aws 1.2.0
ecs_label justtrackio/label/null 0.26.0
elasticsearch_label justtrackio/label/null 0.26.0
kibana_label justtrackio/label/null 0.26.0
this justtrackio/label/null 0.26.0

Resources

Name Type
elasticstack_elasticsearch_index_lifecycle.default resource
elasticstack_elasticsearch_index_template.default resource
elasticstack_kibana_data_view.default resource
grafana_dashboard.main resource
grafana_data_source.elasticsearch resource
aws_sns_topic.default data source
gosoline_application_dashboard_definition.main data source
gosoline_application_metadata_definition.main data source
grafana_folder.default 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
alarm_consumer This can be used to override alarms for consumers. Keys are names of the consumers.
map(object({
alarm_description = optional(string)
datapoints_to_alarm = optional(number, 3)
evaluation_periods = optional(number, 3)
period = optional(number, 60)
success_rate_threshold = optional(number, 99)
alarm_levels = optional(list(string), ["warning", "high"])
}))
{} no
alarm_enabled Defines if alarms should be created bool true no
alarm_gateway This can be used to override alarms for gateway routes. Keys are names of the gateway route.
map(object({
alarm_description = optional(string)
datapoints_to_alarm = optional(number, 3)
evaluation_periods = optional(number, 3)
period = optional(number, 60)
success_rate_threshold = optional(number, 99)
alarm_levels = optional(list(string), ["warning", "high"])
}))
{} no
alarm_kinsumer This can be used to override alarms for kinsumers. Keys are names of the kinsumers.
map(object({
alarm_description = optional(string)
datapoints_to_alarm = optional(number, 1)
evaluation_periods = optional(number, 1)
period = optional(number, 60)
threshold_seconds_behind = optional(number, 60)
alarm_levels = optional(list(string), ["warning", "high"])
}))
{} no
alarm_scheduled This can be used to override scheduled alarm
object({
alarm_description = optional(string)
datapoints_to_alarm = optional(number, 1)
evaluation_periods = optional(number, 1)
period = optional(number, 60)
threshold = optional(number, 0)
alarm_priority = optional(string, "high")
})
{} 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
aws_account_id AWS account id string null no
aws_region AWS region string null no
containers The list of container names from your container_definition list(string) null 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
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
elasticsearch_data_stream_enabled Defines whether there will be a elasticsearch data_stream, index template, index lifecycle policy created bool true no
elasticsearch_host Defines the elasticsearch host to query for logs string null no
elasticsearch_index_template This defines the properties used within the index template (Only used if create_elasticsearch_data_stream is true)
object({
additional_fields = map(any)
name = string
priority = number
node_name = string
number_of_shards = number
number_of_replicas = number
})
{
"additional_fields": {},
"name": "",
"node_name": "*",
"number_of_replicas": 1,
"number_of_shards": 1,
"priority": 250
}
no
elasticsearch_lifecycle_policy This defines the properties used within the index lifecycle management policy (Only used if create_elasticsearch_data_stream is true)
object({
delete_phase_min_age = string
hot_phase_max_primary_shard_size = string
hot_phase_max_age = optional(string)
warm_phase_min_age = string
warm_phase_number_of_replicas = number
})
{
"delete_phase_min_age": "28d",
"hot_phase_max_primary_shard_size": "10gb",
"warm_phase_min_age": "0d",
"warm_phase_number_of_replicas": 0
}
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
grafana_dashboard_enabled Defines whether there will be a grafana dashboard (incl. datasource) bool true 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
kibana_data_view_enabled Defines whether there will be a kibana data view bool true no
kibana_space_id Space identifier to place the kibana data view into 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_orders Overrides the labels_order for the different labels to modify ID elements appear in the id
object({
cloudwatch = optional(list(string), ["environment", "stage", "name"]),
ecs = optional(list(string), ["stage", "name"]),
elasticsearch = optional(list(string), ["environment", "stage", "name"])
kibana = optional(list(string), ["environment", "stage", "name"])
})
{} 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
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
organizational_unit Usually used to indicate the AWS organizational unit, e.g. 'prod', 'sdlc' string null no
project Name of the project string "" 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
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

No outputs.