Skip to content

Commit da958c6

Browse files
authored
Add documentation for EMF auto-detection (#133)
1 parent 91f61da commit da958c6

File tree

2 files changed

+24
-3
lines changed

2 files changed

+24
-3
lines changed

README.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,9 @@ Generate CloudWatch metrics embedded within structured log events. The embedded
1616

1717
- **Generate custom metrics across compute environments**
1818

19-
- Easily generate custom metrics from Lambda functions without requiring custom batching code, making blocking network requests or relying on third-party software.
20-
- 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).
19+
- Easily generate custom metrics from Lambda functions without requiring custom batching code, making blocking network requests or relying on third-party software.
20+
- 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).
21+
- Examples can be found in [examples/README.md](examples/README.md)
2122

2223
- **Link metrics to high cardinality context**
2324

examples/README.md

+21-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,27 @@ Run the example:
2828
```
2929
./examples/agent/bin/run.sh
3030
```
31-
31+
32+
## Docker
33+
34+
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.
35+
36+
[Official Docker documentation for `awslogs` driver](https://docs.docker.com/config/containers/logging/awslogs/)
37+
38+
## ECS and Fargate
39+
40+
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.
41+
42+
[ECS documentation on `awslogs` log driver](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html)
43+
44+
## Fluent Bit and Fluentd
45+
46+
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.
47+
48+
[Getting Started with Fluent Bit](https://docs.fluentbit.io/manual/installation/getting-started-with-fluent-bit)
49+
50+
[Amazon CloudWatch output plugin for Fluent Bit](https://docs.fluentbit.io/manual/pipeline/outputs/cloudwatch)
51+
3252
## FireLens on ECS EC2
3353

3454
You can deploy the example by running the following:

0 commit comments

Comments
 (0)