From ca71f05344fa01e57c5ce9048331712f4075c7dd Mon Sep 17 00:00:00 2001 From: Ankit Kumar Date: Tue, 4 Jun 2024 05:43:27 +0530 Subject: [PATCH] AWS CloudWatch Exporter docs update (#194) --- .../exporters/exporter-aws-cloudwatch.md | 110 ++++++++++++++++++ 1 file changed, 110 insertions(+) create mode 100644 src/reference/config/telemetry/exporters/exporter-aws-cloudwatch.md diff --git a/src/reference/config/telemetry/exporters/exporter-aws-cloudwatch.md b/src/reference/config/telemetry/exporters/exporter-aws-cloudwatch.md new file mode 100644 index 00000000..62bac44b --- /dev/null +++ b/src/reference/config/telemetry/exporters/exporter-aws-cloudwatch.md @@ -0,0 +1,110 @@ +--- +shortTitle: aws cloudwatch +description: Zilla runtime aws cloudwatch exporter +icon: aky-zilla-plus + - Telemetry +tag: + - Exporters +--- + +# aws cloudwatch Exporter + +[Available in ](https://www.aklivity.io/products/zilla-plus) +{.zilla-plus-badge .hint-container .info} + +Zilla runtime aws cloudwatch exporter. + +```yaml {3} +exporters: + aws_cloudwatch: + type: aws-cloudwatch + options: + metrics: + namespace: zilla-metrics + interval: 20 + logs: + group: zilla-log-group + stream: zilla-log-stream +``` + +## Summary + +Specifies an exporter for transmitting Custom Metrics and Log Events to AWS CloudWatch. + +## Configuration + +:::: note Properties + +- [options](#options) +- [options.metrics](#options-metrics) + - [metrics.namespace\*](#metrics-namespace) + - [metrics.interval](#metrics-interval) +- [options.logs](#options-logs) + - [logs.group\*](#logs-group) + - [logs.stream\*](#logs-stream) + +::: right +\* required +::: + +:::: + +### options + +> `object` + +`aws`-specific options. + +```yaml +options: + metrics: + namespace: zilla-metrics + interval: 20 + logs: + group: zilla-log-group + stream: zilla-log-stream +``` + +### options.metrics + +> `object` + +Configuration for transmitting custom metric data points to Amazon CloudWatch. + +#### metrics.namespace\* + +> `string` + +The namespace for the metric data. + +To avoid conflicts with Amazon Web Services service namespaces, you should not specify a namespace that begins with `AWS/`. + +#### metrics.interval + +> `integer` + +Interval in seconds to push data to the Amazon CloudWatch. Default: 30 seconds. + +### options.logs + +> `object` + +Configuration for transmitting log events to Amazon CloudWatch. + +#### logs.group\* + +> `string` + +The name of the log group. + +#### logs.stream\* + +> `string` + +The name of the log stream. + +--- + +::: right +\* required +:::