Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update README with log filtering info #380

Merged
merged 4 commits into from
Feb 28, 2022
Merged

update README with log filtering info #380

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
143af9f
add filtering under build and running from source section
aateeqi Feb 25, 2022
c4c6791
add new features section
aateeqi Feb 25, 2022
933cde6
add log line example
aateeqi Feb 25, 2022
b95037e
add filtering docs to log filtering section
aateeqi Feb 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,38 @@ The following targets are available. Each may be run with `make <target>`.
| `clean` | `clean` removes build artifacts |
| `dockerized-build` | build using docker container without local go environment |

## Features
### Log Filtering
CloudWatch agent supports log filtering, where the agent processes each log message with the filters that you specify, and only published events that pass all filters to CloudWatch Logs. See [docs](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Agent-Configuration-File-Details.html#CloudWatch-Agent-Configuration-File-Logssection) for details.

For example, the following excerpt of the CloudWatch agent configuration file publishes logs that are PUT and POST requests to CloudWatch Logs, but excluding logs that come from Firefox:
```json
{
"collect_list": [
{
"file_path": "/opt/aws/amazon-cloudwatch-agent/logs/test.log",
"log_group_name": "test.log",
"log_stream_name": "test.log",
"filters": [
{
"type": "exclude",
"expression": "Firefox"
},
{
"type": "include",
"expression": "P(UT|OST)"
}
]
},
]
}
```
Example with above config:
```
2021-09-27T19:36:35Z I! [logagent] Firefox Detected // Agent excludes this
2021-09-27T19:36:35Z POST (StatusCode: 200). // Agent would push this to CloudWatch
2021-09-27T19:36:35Z GET (StatusCode: 400). // doesn't match regex, will be excluded
```
## Versioning
It is using [Semantic versioning](https://semver.org/)

Expand Down