Skip to content

Commit

Permalink
docs: Added requirements and updated screenshot. (#6)
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesiarmes authored Jan 13, 2025
1 parent 607da69 commit 0006552
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 1 deletion.
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.

0 comments on commit 0006552

Please sign in to comment.