Skip to content

Commit

Permalink
Update logging documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mec committed Nov 26, 2024
1 parent 66d943d commit 23c5224
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ documentation](/doc/hosting.md) on how to obtain this.
- [Glossary of business terms](/doc/glossary.md)
- [Hosting](/doc/hosting.md)
- [Deployment](/doc/deployment-process.md)
- [Logging](/doc/logging.md)
- [Environment variables](/doc/environment-variables.md)
- [Sending email notifications](/doc/email-notifications.md)
- [Use authentication](/doc/authentication.md)
Expand All @@ -68,7 +69,6 @@ documentation](/doc/hosting.md) on how to obtain this.
- [Identifying invalid activities](/doc/utilities.md)
- [Background jobs](/doc/background-jobs.md)
- [Console access](/doc/console-access.md)
- [Logging](/doc/logging.md)
- [DNS](/doc/dns.md)
- [Migrations](/doc/migrations.md)

Expand Down
37 changes: 36 additions & 1 deletion doc/logging.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,38 @@
# Logging

Logs can be accessed in the AWS ECS ODA clusters, under the ODA services corresponding to the target environment.
Logging is handled by CloudWatch in the DSIT AWS, you will need
a `digital-paas-production-account`, see [hosting
documentation](/doc/hosting.md#getting-an-account) for instructions for obtaining this.

Once you have access you can find the logs but following these steps:

- sign in to AWS with your `digital-paas-production-account` account
- assume the role for the appropriate environment, see [hosting
documentation](/doc/hosting.md#assuming-roles)
- Locate _Elastic Container Service_ (ECS) in the services menu
- Click on the cluster
- Click on the service
- Switch to the _Logs_ tab
- Refine the view of the logs

You can then switch to CloudWatch if desired:

- Click the _View in CloudWatch_ drop down
- Select the container
- Refine the view of the logs

## Via CloudWatch

You can access the container logs directly via CloudWatch, with some additional
steps:

- sign in to AWS with your `digital-paas-production-account` account
- assume the role for the appropriate environment, see [hosting
documentaiton](/doc/hosting.md#assuming-roles)
- Locate _CloudWatch_ in the services menu
- From the side bar open _Logs_ and click on _Log groups_
- Locate either the application or worker container for that matches the
environment, e.g. `/ecs/ODA-prod` and `/ecs/ODA-prod-SideCar` for production
- Click on the container
- The logs are split into 'streams' choose a steam or click _Search all log
steams_ and refine

0 comments on commit 23c5224

Please sign in to comment.