diff --git a/README.md b/README.md index adaa78b8..9083606f 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,9 @@ Generate CloudWatch metrics embedded within structured log events. The embedded - **Generate custom metrics across compute environments** - - Easily generate custom metrics from Lambda functions without requiring custom batching code, making blocking network requests or relying on third-party software. - - Other compute environments (EC2, On-prem, ECS, EKS, and other container environments) are supported by installing the [CloudWatch Agent](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Embedded_Metric_Format_Generation_CloudWatch_Agent.html). +- Easily generate custom metrics from Lambda functions without requiring custom batching code, making blocking network requests or relying on third-party software. +- Other compute environments (EC2, On-prem, ECS, EKS, and other container environments) are supported by installing the [CloudWatch Agent](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Embedded_Metric_Format_Generation_CloudWatch_Agent.html). + - Examples can be found in [examples/README.md](examples/README.md) - **Link metrics to high cardinality context** diff --git a/examples/README.md b/examples/README.md index 0f9f2ec5..359d61e3 100644 --- a/examples/README.md +++ b/examples/README.md @@ -28,7 +28,27 @@ Run the example: ``` ./examples/agent/bin/run.sh ``` - + +## Docker + +With Docker images, using the `awslogs` log driver will send your container logs to CloudWatch Logs. All you have to do is write to STDOUT and your EMF logs will be processed. + +[Official Docker documentation for `awslogs` driver](https://docs.docker.com/config/containers/logging/awslogs/) + +## ECS and Fargate + +With ECS and Fargate, you can use the `awslogs` log driver to have your logs sent to CloudWatch Logs on your behalf. After configuring your task to use the `awslogs` log driver, you may write your EMF logs to STDOUT and they will be processed. + +[ECS documentation on `awslogs` log driver](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html) + +## Fluent Bit and Fluentd + +Fluent Bit can be used to collect logs and push them to CloudWatch Logs. After configuring the Amazon CloudWatch Logs output plugin, you may write your EMF logs to STDOUT and they will be processed. + +[Getting Started with Fluent Bit](https://docs.fluentbit.io/manual/installation/getting-started-with-fluent-bit) + +[Amazon CloudWatch output plugin for Fluent Bit](https://docs.fluentbit.io/manual/pipeline/outputs/cloudwatch) + ## FireLens on ECS EC2 You can deploy the example by running the following: