Skip to content
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
title: Monitor Maintenance Container
sidebar_label: Monitor Maintenance Container
---

# Monitor Maintenance Container

In this guide, you will:
- Use AWS CloudWatch to monitor the maintenance container logs.
- Verify ECS task status and deployments.

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.

## Prerequisites

- Access to the Guardrails AWS account with [Administrator Privileges](/guardrails/docs/enterprise/FAQ/admin-permissions).
- Familiarity with AWS Console, CloudWatch.

## Step 1: Access AWS Console

Open the AWS Console and navigate to the CloudWatch service in the region where Guardrails is deployed.

![AWS Console CloudWatch](./aws-console-home.png)

## Step 2: Select Log Group

Choose **Log Groups** from the left navigation menu.

![Select Log Groups Navigation](./aws-select-log-groups.png)

## Step 3: Select Maintenance Log Group

From the list of log groups, choose the maintenance log group, typically named in the format `/turbot/<te_version_number>/maintenance`.

> [!NOTE]
> If multiple TE versions are installed, make sure to select the log group corresponding to the latest installed version.

![Select Maintenance Log Group](./aws-search-select-log-group.png)

Choose `Search Log Group` from the top right.

![Select Search Log Group Option](./aws-select-search-log-group.png)

## Step 4: Review Logs for Errors

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.

> [!NOTE]
> 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.

![AWS Console CloudWatch](./aws-locate-error.png)

## Next Steps

Please see the following resources to learn more about Turbot Guardrails Enterprise:

- Learn how to [Diagnose Control Errors](https://turbot.com/guardrails/docs/guides/hosting-guardrails/monitoring/diagnose-control-error).
- Learn how to [Investigate an Event Flood](https://turbot.com/guardrails/docs/guides/hosting-guardrails/monitoring/investigate-event-flood).

## Troubleshooting

| Issue | Description | Guide |
|----------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------|
| 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) |
1 change: 1 addition & 0 deletions docs/guides/hosting-guardrails/monitoring/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ The following guides provide detailed instructions for effectively monitoring Gu

| Guide | Description |
| - | - |
| [Check Maintenance Container](/guardrails/docs/guides/hosting-guardrails/monitoring/check-maintenance-container) | Provides steps to monitor the maintenance container logs. |
| [Diagnose Control Error](/guardrails/docs/guides/hosting-guardrails/monitoring/diagnose-control-error) | Provides steps to identify and resolve control errors in Guardrails. |
| [Investigate Event Flood](/guardrails/docs/guides/hosting-guardrails/monitoring/investigate-event-flood) | Outlines the process for diagnosing and managing event floods. |
| [Monitoring and Alarms](/guardrails/docs/guides/hosting-guardrails/monitoring/monitoring-alarms) | Guides for assessing various CloudWatch metrics provided in TE and TED stack. |
Expand Down
3 changes: 2 additions & 1 deletion docs/sidebar.json
Original file line number Diff line number Diff line change
Expand Up @@ -458,7 +458,8 @@
"guides/hosting-guardrails/monitoring/check-mod-health",
"guides/hosting-guardrails/monitoring/workspace-health-check",
"guides/hosting-guardrails/monitoring/monitoring-alarms",
"guides/hosting-guardrails/monitoring/investigate-lambda-invocation"
"guides/hosting-guardrails/monitoring/investigate-lambda-invocation",
"guides/hosting-guardrails/monitoring/check-maintenance-container"
]
},
{
Expand Down