Skip to content

Commit 8b63e5f

Browse files
authored
Add docs for activity_dashboard and root_user_activity_report dashboards (#9)
1 parent f77ceb0 commit 8b63e5f

File tree

4 files changed

+27
-6
lines changed

4 files changed

+27
-6
lines changed

dashboards/activity_dashboard.pp

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
dashboard "activity_dashboard" {
22

3-
title = "CloudTrail Log Activity Dashboard"
3+
title = "CloudTrail Log Activity Dashboard"
4+
documentation = file("./dashboards/docs/activity_dashboard.md")
45

56
tags = {
6-
type = "Dashboard"
7+
type = "Dashboard"
78
service = "AWS/CloudTrail"
89
}
910

dashboards/docs/activity_dashboard.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
This dashboard answers the following questions:
2+
3+
- How many CloudTrail logs are recorded?
4+
- How many logs are generated per AWS account?
5+
- How many logs are generated per region?
6+
- Who are the top actors (excluding AWS services)?
7+
- What are the top source IPs (excluding AWS services and internal sources)?
8+
- What are the top AWS services generating logs (excluding read-only events)?
9+
- What are the top AWS events recorded (excluding read-only events)?
10+
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
This dashboard answers the following questions:
2+
3+
- How many root user actions have been recorded?
4+
- What specific operations have been performed by the root user?
5+
- Which AWS accounts have root user activity?
6+
- What are the source IPs of root user actions?
7+
- In which AWS regions has root user activity occurred?
8+
- Should read-only events be included in the analysis?
9+
- How many total logs exist for root user activity?

dashboards/root_user_activity_report.pp

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
dashboard "root_user_activity_report" {
22

3-
title = "CloudTrail Log Root User Activity Report"
3+
title = "CloudTrail Log Root User Activity Report"
4+
documentation = file("./dashboards/docs/root_user_activity_report.md")
45

56
tags = {
6-
type = "Report"
7+
type = "Report"
78
service = "AWS/CloudTrail"
89
}
910

@@ -33,7 +34,7 @@
3334
card {
3435
query = query.root_user_activity_report_total_logs
3536
width = 2
36-
args = [
37+
args = [
3738
self.input.read_only.value,
3839
self.input.aws_accounts.value
3940
]
@@ -44,7 +45,7 @@
4445
table {
4546
title = "Note: This table shows a maximum of 10,000 rows"
4647
query = query.root_user_activity_report_table
47-
args = [
48+
args = [
4849
self.input.read_only.value,
4950
self.input.aws_accounts.value
5051
]

0 commit comments

Comments
 (0)