Skip to content

Commit c59d28b

Browse files
Add > Checking maintenance container in enterprise hosting. Closes #367 (#387)
1 parent 7fe1403 commit c59d28b

File tree

8 files changed

+67
-1
lines changed

8 files changed

+67
-1
lines changed
163 KB
Loading
324 KB
Loading
147 KB
Loading
171 KB
Loading
166 KB
Loading
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
title: Monitor Maintenance Container
3+
sidebar_label: Monitor Maintenance Container
4+
---
5+
6+
# Monitor Maintenance Container
7+
8+
In this guide, you will:
9+
- Use AWS CloudWatch to monitor the maintenance container logs.
10+
- Verify ECS task status and deployments.
11+
12+
Guardrails operates its core services within secure, private [ECS clusters](/guardrails/docs/guides/hosting-guardrails/FAQ#how-does-turbot-guardrails-use-aws-elastic-container-service-ecs) that are never exposed to the public internet. These clusters run several container types essential to the platform — API containers handle inbound traffic from the load balancer, events containers process real-time cloud events, and Terraform factory containers dynamically generate templates for short-lived tasks. Regularly monitoring the maintenance container is crucial, as it helps validate the health and functioning of these background services, ensuring that the system remains stable, responsive, and capable of processing workloads effectively.
13+
14+
## Prerequisites
15+
16+
- Access to the Guardrails AWS account with [Administrator Privileges](/guardrails/docs/enterprise/FAQ/admin-permissions).
17+
- Familiarity with AWS Console, CloudWatch.
18+
19+
## Step 1: Access AWS Console
20+
21+
Open the AWS Console and navigate to the CloudWatch service in the region where Guardrails is deployed.
22+
23+
![AWS Console CloudWatch](./aws-console-home.png)
24+
25+
## Step 2: Select Log Group
26+
27+
Choose **Log Groups** from the left navigation menu.
28+
29+
![Select Log Groups Navigation](./aws-select-log-groups.png)
30+
31+
## Step 3: Select Maintenance Log Group
32+
33+
From the list of log groups, choose the maintenance log group, typically named in the format `/turbot/<te_version_number>/maintenance`.
34+
35+
> [!NOTE]
36+
> If multiple TE versions are installed, make sure to select the log group corresponding to the latest installed version.
37+
38+
![Select Maintenance Log Group](./aws-search-select-log-group.png)
39+
40+
Choose `Search Log Group` from the top right.
41+
42+
![Select Search Log Group Option](./aws-select-search-log-group.png)
43+
44+
## Step 4: Review Logs for Errors
45+
46+
Check the CloudWatch logs for any errors that may have occurred during the monitoring period. The logs provide visibility into container activity and help identify potential issues.
47+
48+
> [!NOTE]
49+
> The maintenance container is expected to run without errors. However, if any errors are observed in the logs, please report them to [Guardrails Support](https://support.turbot.com) for further investigation.
50+
51+
![AWS Console CloudWatch](./aws-locate-error.png)
52+
53+
## Next Steps
54+
55+
Please see the following resources to learn more about Turbot Guardrails Enterprise:
56+
57+
- Learn how to [Diagnose Control Errors](https://turbot.com/guardrails/docs/guides/hosting-guardrails/monitoring/diagnose-control-error).
58+
- Learn how to [Investigate an Event Flood](https://turbot.com/guardrails/docs/guides/hosting-guardrails/monitoring/investigate-event-flood).
59+
60+
## Troubleshooting
61+
62+
| Issue | Description | Guide |
63+
|----------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------|
64+
| Further Assistance | If you continue to encounter issues, please open a ticket with us and attach the relevant information to assist you more efficiently. | [Open Support Ticket](https://support.turbot.com) |

docs/guides/hosting-guardrails/monitoring/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ The following guides provide detailed instructions for effectively monitoring Gu
99

1010
| Guide | Description |
1111
| - | - |
12+
| [Check Maintenance Container](/guardrails/docs/guides/hosting-guardrails/monitoring/check-maintenance-container) | Provides steps to monitor the maintenance container logs. |
1213
| [Diagnose Control Error](/guardrails/docs/guides/hosting-guardrails/monitoring/diagnose-control-error) | Provides steps to identify and resolve control errors in Guardrails. |
1314
| [Investigate Event Flood](/guardrails/docs/guides/hosting-guardrails/monitoring/investigate-event-flood) | Outlines the process for diagnosing and managing event floods. |
1415
| [Monitoring and Alarms](/guardrails/docs/guides/hosting-guardrails/monitoring/monitoring-alarms) | Guides for assessing various CloudWatch metrics provided in TE and TED stack. |

docs/sidebar.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -458,7 +458,8 @@
458458
"guides/hosting-guardrails/monitoring/check-mod-health",
459459
"guides/hosting-guardrails/monitoring/workspace-health-check",
460460
"guides/hosting-guardrails/monitoring/monitoring-alarms",
461-
"guides/hosting-guardrails/monitoring/investigate-lambda-invocation"
461+
"guides/hosting-guardrails/monitoring/investigate-lambda-invocation",
462+
"guides/hosting-guardrails/monitoring/check-maintenance-container"
462463
]
463464
},
464465
{

0 commit comments

Comments
 (0)