Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Audit Logs in AWS #2744

Merged
merged 2 commits into from
Jul 26, 2024
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
3 changes: 2 additions & 1 deletion _includes/searching-by-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@

3. Select the desired log group.

4. In the *Log streams* pane, select the log stream according the last event. The last event time should match the time when the issue occurred.
4. In the *Log streams* pane, select the log stream according the last event. The last event time should match the time when the issue occurred.

![select log stream](https://spryker.s3.eu-central-1.amazonaws.com/cloud-docs/Spryker+Cloud/Working+with+logs/select-log-stream.png)

5. In the *Log events* pane, filter events by entering a query in the search bar.
When browsing audit logs, you might want to filter by tile, like `audit`, or by a user, like `sonia@spryker.com`.
35 changes: 29 additions & 6 deletions docs/ca/dev/working-with-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ This document describes how to work with logs(events). Logs provide information

## Log groups

To make log browsing easier, logs from the same source form a log stream. Log streams with the same retention, monitoring, and access control settings form a log group. You can check logs from the following log groups.
To make log browsing easier, logs from the same source form a log stream. Log streams with the same retention, monitoring, and access control settings form a log group. The following is an approximate list of log groups that can be available in your project. The actual list of log groups depends on your setup.

| HEADER | HEADER |
| LOG GROUP | PATH |
| --- | --- |
| AWS code build pipelines | DESTRUCTIVE pipeline jobs: /aws/codebuild/danger/{environment_name} <br> NORMAL pipeline jobs: /aws/codebuild/{environment_name} |
| AWS Elasticsearch | /aws/elasticsearch/{environment_name} |
Expand All @@ -28,15 +28,38 @@ To make log browsing easier, logs from the same source form a log stream. Log st
| EC2 Jenkins | /ec2/{environment_name}/jenkins/docker |
| ECS blackfire | /ecs/fargate/{environment_name}/blackfire/docker |
| Frontend service | /ecs/{environment_name}/frontend/docker |
| GLUE service | /ecs/{environment_name}/glue/docker |
| Glue API | /ecs/{environment_name}/glue/docker |
| Glue Backend API | /ecs/{environment_name}/glue_backend/docker |
| ECS Jenkins | /ecs/{environment_name}/jenkins/docker |
| RabbitMQ ECS | /ecs/{environment_name}/rabbitmq/docker |
| ECS YVES | /ecs/{environment_name}/yves/docker |
| Storefront (Yves) | /ecs/{environment_name}/yves/docker |
| ECS ZED | /ecs/{environment_name}/zed/docker |
| Back Office | /ecs/{environment_name}/boffice/docker |
| Merchant Portal | /ecs/{environment_name}/mportal/docker |

## Search in logs
### Audit logs

Audit logs are a type of logs used to track user-related activities. If audit logs are installed<!--()](link to audit logs md) --> in your project, you can browse them for the following log groups.

* Storefront (Yves)
* Back Office
* Merchant Portal
* Glue API
* Glue Backend API

The actual list of applications for which audit logs are enabled depends on your setup.

To search in logs:
The following audit events are logged by default:

* Successful login
* Failed login
* Password reset requested
* Password updated after reset
* [Agent Assist feature](/docs/pbc/all/user-management/{{site.version}}/base-shop/agent-assist-feature-overview.html) logs:
* Impersonation started
* Impersonation ended

## Search in logs

{% include searching-by-logs.md %} <!-- To edit, see /_includes/searching-by-logs.md -->

Expand Down
Loading