community / community.aws / 4.3.0 / module / cloudwatchlogs_log_group_metric_filter Manage CloudWatch log group metric filter | "added in version" 1.0.0 of community.aws" Authors: Markus Bergholz (@markuman)community.aws.cloudwatchlogs_log_group_metric_filter (4.3.0) — module
Install with ansible-galaxy collection install community.aws:==4.3.0
collections: - name: community.aws version: 4.3.0
Create, modify and delete CloudWatch log group metric filter.
CloudWatch log group metric filter can be use with M(community.aws.ec2_metric_alarm).
- name: set metric filter on log group /fluentd/testcase community.aws.cloudwatchlogs_log_group_metric_filter: log_group_name: /fluentd/testcase filter_name: BoxFreeStorage filter_pattern: '{($.value = *) && ($.hostname = "box")}' state: present metric_transformation: metric_name: box_free_space metric_namespace: fluentd_metrics metric_value: "$.value"
- name: delete metric filter on log group /fluentd/testcase community.aws.cloudwatchlogs_log_group_metric_filter: log_group_name: /fluentd/testcase filter_name: BoxFreeStorage state: absent
state: choices: - present - absent description: - Whether the rule is present or absent. required: true type: str region: aliases: - aws_region - ec2_region description: - The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) type: str ec2_url: aliases: - aws_endpoint_url - endpoint_url description: - Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. type: str profile: aliases: - aws_profile description: - Uses a boto profile. Only works with boto >= 2.24.0. - Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token) and support for passing them at the same time as I(profile) has been deprecated. - I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually exclusive with I(profile) after 2022-06-01. type: str aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config). - Only the 'user_agent' key is used for boto modules. See U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto) for more boto configuration. type: dict filter_name: description: - A name for the metric filter you create. required: true type: str aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - Only used for boto3 based modules. - 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied from the controller if not run locally.' type: path aws_access_key: aliases: - ec2_access_key - access_key description: - AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str aws_secret_key: aliases: - ec2_secret_key - secret_key description: - AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str filter_pattern: description: - A filter pattern for extracting metric data out of ingested log events. Required when I(state=present). type: str log_group_name: description: - The name of the log group where the metric filter is applied on. required: true type: str security_token: aliases: - aws_security_token - access_token description: - AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(security_token) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str validate_certs: default: true description: - When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. type: bool metric_transformation: description: - A collection of information that defines how metric data gets emitted. Required when I(state=present). suboptions: default_value: description: - The value to emit when a filter pattern does not match a log event. type: float metric_name: description: - The name of the cloudWatch metric. type: str metric_namespace: description: - The namespace of the cloudWatch metric. type: str metric_value: description: - The value to publish to the cloudWatch metric when a filter pattern matches a log event. type: str type: dict debug_botocore_endpoint_logs: default: 'no' description: - Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used. type: bool
metric_filters: description: Return the origin response value returned: success sample: - default_value: 3.1415 metric_name: box_free_space metric_namespace: made_with_ansible metric_value: $.value type: list