Skip to content

docs: Added requirements and updated screenshot. #6

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.

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

Merged
merged 1 commit into from
Jan 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,15 @@ Application Firewall.

![Screenshot of the Datadog WAF Dashboard][screenshot-dashboard]

## Requirements

This dashboard assumes that your logs are tagged with `source:waf` and
`webacl:*`, where `webacl` is the name of the WebACL that the log is associated
with. There are multiple ways to accomplish this, but the easiest is to tag the
CloudWatch log group with the appropriate tags, and ensure that
`DdFetchLogGroupTags` is set to `true` in the [log forwarder
stack][aws-forwarder].

## Usage

Add this module to your `main.tf` (or appropriate) file and configure the inputs
Expand Down Expand Up @@ -48,8 +57,9 @@ tofu init -upgrade
| threshold_limited_warning | Warning threshold for rate limited requests. Reflected when the percentage of rate limited requests rises above this number. | `number` | `10` | no |
| title | Title of the dashboard. | `string` | `"Web Application Firewall (WAF)"` | no |

[aws-forwarder]: https://docs.datadoghq.com/logs/guide/forwarder/?tab=cloudformation#advanced-optional
[badge-checks]: https://github.com/codeforamerica/tofu-modules-datadog-waf-dashboard/actions/workflows/main.yaml/badge.svg
[badge-release]: https://img.shields.io/github/v/release/codeforamerica/tofu-modules-datadog-waf-dashboard?logo=github&label=Latest%20Release
[code-checks]: https://github.com/codeforamerica/tofu-modules-datadog-waf-dashboard/actions/workflows/main.yaml
[latest-release]: https://github.com/codeforamerica/tofu-modules-datadog-waf-dashboard/releases/latest
[screenshot-dashboard]: docs/assets/dashboard.jpeg
[screenshot-dashboard]: docs/assets/dashboard.png
Binary file removed docs/assets/dashboard.jpeg
Binary file not shown.
Binary file added docs/assets/dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading