Skip to content

Commit

Permalink
update audit log docs (#5401)
Browse files Browse the repository at this point in the history 
## What are you changing in this pull request and why?
<!---
Describe your changes and why you're making them. If related to an open 
issue or a pull request on dbt Core, then link to them here! 

To learn more about the writing conventions used in the dbt Labs docs,
see the [Content style
guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md).
-->
This removes some information that isn't relevant to end users, adds
some info that was missing, and makes slightly clearer some other
things.
## Checklist
<!--
Uncomment when publishing docs for a prerelease version of dbt:
- [ ] Add versioning components, as described in [Versioning
Docs](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-entire-pages)
- [ ] Add a note to the prerelease version [Migration
Guide](https://github.com/dbt-labs/docs.getdbt.com/tree/current/website/docs/docs/dbt-versions/core-upgrade)
-->
- [ ] Review the [Content style
guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md)
so my content adheres to these guidelines.
- [ ] For [docs
versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#about-versioning),
review how to [version a whole
page](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version)
and [version a block of
content](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-blocks-of-content).
- [ ] Add a checklist item for anything that needs to happen before this
PR is merged, such as "needs technical review" or "change base branch."

Adding or removing pages (delete if not applicable):
- [ ] Add/remove page in `website/sidebars.js`
- [ ] Provide a unique filename for new pages
- [ ] Add an entry for deleted pages in `website/vercel.json`
- [ ] Run link testing locally with `npm run build` to update the links
that point to deleted pages
  • Loading branch information
@mirnawong1
mirnawong1 authored Apr 30, 2024
2 parents c92ae1c + 3c108de commit d6fdd95
Showing 1 changed file with 45 additions and 44 deletions.
89 changes: 45 additions & 44 deletions website/docs/docs/cloud/manage-access/audit-log.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ On the audit log page, you will see a list of various events and their associate

### Event details

Click the event card to see the details about the activity that triggered the event. This view provides important details, including when it happened and what type of event was triggered. For example, if someone changes the settings for a job, you can use the event details to see which job was changed (type of event: `v1.events.job_definition.Changed`), by whom (person who triggered the event: `actor`), and when (time it was triggered: `created_at_utc`). For types of events and their descriptions, see [Events in audit log](#events-in-audit-log).
Click the event card to see the details about the activity that triggered the event. This view provides important details, including when it happened and what type of event was triggered. For example, if someone changes the settings for a job, you can use the event details to see which job was changed (type of event: `job_definition.Changed`), by whom (person who triggered the event: `actor`), and when (time it was triggered: `created_at_utc`). For types of events and their descriptions, see [Events in audit log](#events-in-audit-log).

The event details provide the key factors of an event:

Expand All @@ -43,12 +43,13 @@ The event details provide the key factors of an event:
| actor_id | Unique ID of the actor |
| actor_ip | IP address of the actor |
| actor_name | Identifying name of the actor |
| created_at_utc | UTC timestamp on when the event occurred |
| actor_type | Whether the action was done by a user or an API request |
| created_at | UTC timestamp of when the event occurred |
| event_type | Unique key identifying the event |
| event_context | This key will be different for each event and will match the event_type. This data will include all the details about the object(s) that was changed. |
| id | Unique ID of the event |
| service | Service that carried out the action |
| source | Source of the event - dbt Cloud UI or API |
| v1.events.event_type | This key will be different for each event and will match the event_type. This data will include all the details about the object(s) that was changed. |

## Audit log events

Expand All @@ -58,102 +59,102 @@ The audit log supports various events for different objects in dbt Cloud. You wi

| Event Name | Event Type | Description |
| -------------------------- | ---------------------------------------- | ------------------------------------------------------ |
| Auth Provider Changed | v1.events.auth_provider.Changed | Authentication provider settings changed |
| Credential Login Failed | v1.events.auth.CredentialsLoginFailed | User login via username and password failed |
| Credential Login Succeeded | v1.events.auth.CredentialsLoginSucceeded | User successfully logged in with username and password |
| SSO Login Failed | v1.events.auth.SsoLoginFailed | User login via SSO failed |
| SSO Login Succeeded | v1.events.auth.SsoLoginSucceeded | User successfully logged in via SSO
| Auth Provider Changed | auth_provider.Changed | Authentication provider settings changed |
| Credential Login Failed | auth.CredentialsLoginFailed | User login via username and password failed |
| Credential Login Succeeded | auth.CredentialsLoginSucceeded | User successfully logged in with username and password |
| SSO Login Failed | auth.SsoLoginFailed | User login via SSO failed |
| SSO Login Succeeded | auth.SsoLoginSucceeded | User successfully logged in via SSO

### Environment

| Event Name | Event Type | Description |
| ------------------- | ----------------------------- | ------------------------------------ |
| Environment Added | v1.events.environment.Added | New environment successfully created |
| Environment Changed | v1.events.environment.Changed | Environment settings changed |
| Environment Removed | v1.events.environment.Removed | Environment successfully removed |
| Environment Added | environment.Added | New environment successfully created |
| Environment Changed | environment.Changed | Environment settings changed |
| Environment Removed | environment.Removed | Environment successfully removed |

### Jobs

| Event Name | Event Type | Description |
| ----------- | --------------------------------- | ---------------------------- |
| Job Added | v1.events.job_definition.Added | New Job successfully created |
| Job Changed | v1.events.job_definition.Changed | Job settings changed |
| Job Removed | v1.events.job_definition.Removed | Job definition removed |
| Job Added | job_definition.Added | New Job successfully created |
| Job Changed | job_definition.Changed | Job settings changed |
| Job Removed | job_definition.Removed | Job definition removed |

### Service Token

| Event Name | Event Type | Description |
| --------------------- | -------------------------------- | ------------------------------------------ |
| Service Token Created | v1.events.service_token.Created | New Service Token was successfully created |
| Service Token Revoked | v1.events.service_token.Revoked | Service Token was revoked |
| Service Token Created | service_token.Created | New Service Token was successfully created |
| Service Token Revoked | service_token.Revoked | Service Token was revoked |

### Group

| Event Name | Event Type | Description |
| ------------- | ----------------------------- | ------------------------------ |
| Group Added | v1.events.user_group.Added | New Group successfully created |
| Group Changed | v1.events.user_group.Changed | Group settings changed |
| Group Removed | v1.events.user_group.Changed | Group successfully removed |
| Group Added | user_group.Added | New Group successfully created |
| Group Changed | user_group.Changed | Group settings changed |
| Group Removed | user_group.Changed | Group successfully removed |

### User

| Event Name | Event Type | Description |
| ---------------------------- | ----------------------------------- | ----------------------------------------------- |
| Invite Added | v1.events.invite.Added | User invitation added and sent to the user |
| Invite Redeemed | v1.events.invite.Redeemed | User redeemed invitation |
| User Added to Account | v1.events.account.UserAdded | New user added to the account |
| User Added to Group | v1.events.user_group_user.Added | An existing user is added to a group |
| User Removed from Account | v1.events.account.UserRemoved | User removed from the account
| User Removed from Group | v1.events.user_group_user.Removed | An existing user is removed from a group |
| Verification Email Confirmed | v1.events.user.jit.email.Confirmed | Email verification confirmed by user |
| Verification Email Sent | v1.events.user.jit.email.Sent | Email verification sent to user created via JIT |
| Invite Added | invite.Added | User invitation added and sent to the user |
| Invite Redeemed | invite.Redeemed | User redeemed invitation |
| User Added to Account | account.UserAdded | New user added to the account |
| User Added to Group | user_group_user.Added | An existing user is added to a group |
| User Removed from Account | account.UserRemoved | User removed from the account
| User Removed from Group | user_group_user.Removed | An existing user is removed from a group |
| Verification Email Confirmed | user.jit.email.Confirmed | Email verification confirmed by user |
| Verification Email Sent | user.jit.email.Sent | Email verification sent to user created via JIT |

### Project

| Event Name | Event Type | Description |
| --------------- | ------------------------- | ------------------------ |
| Project Added | v1.events.project.Added | New project added |
| Project Changed | v1.events.project.Changed | Project settings changed |
| Project Removed | v1.events.project.Removed | Project is removed |
| Project Added | project.Added | New project added |
| Project Changed | project.Changed | Project settings changed |
| Project Removed | project.Removed | Project is removed |

### Permissions

| Event Name | Event Type | Description |
| ----------------------- | ---------------------------- | ------------------------------ |
| User Permission Added | v1.events.permission.Added | New user permissions are added |
| User Permission Removed | v1.events.permission.Removed | User permissions are removed |
| User Permission Added | permission.Added | New user permissions are added |
| User Permission Removed | permission.Removed | User permissions are removed |

### License

| Event Name | Event Type | Description |
| ----------------------- | ------------------------------ | ----------------------------------------- |
| License Mapping Added | v1.events.license\_map.Added | New user license mapping is added |
| License Mapping Changed | v1.events.license\_map.Changed | User license mapping settings are changed |
| License Mapping Removed | v1.events.license\_map.Removed | User license mapping is removed |
| License Mapping Added | license\_map.Added | New user license mapping is added |
| License Mapping Changed | license\_map.Changed | User license mapping settings are changed |
| License Mapping Removed | license\_map.Removed | User license mapping is removed |

### Connection

| Event Name | Event Type | Description |
| ------------------ | ---------------------------- | ------------------------------------------ |
| Connection Added | v1.events.connection.Added | New Data Warehouse connection added |
| Connection Changed | v1.events.connection.Changed | Data Warehouse Connection settings changed |
| Connection Removed | v1.events.connection.Removed | Data Warehouse connection removed |
| Connection Added | connection.Added | New Data Warehouse connection added |
| Connection Changed | connection.Changed | Data Warehouse Connection settings changed |
| Connection Removed | connection.Removed | Data Warehouse connection removed |

### Repository

| Event Name | Event Type | Description |
| ------------------ | ---------------------------- | --------------------------- |
| Repository Added | v1.events.repository.Added | New repository added |
| Repository Changed | v1.events.repository.Changed | Repository settings changed |
| Repository Removed | v1.events.repository.Removed | Repository removed |
| Repository Added | repository.Added | New repository added |
| Repository Changed | repository.Changed | Repository settings changed |
| Repository Removed | repository.Removed | Repository removed |

### Credentials

| Event Name | Event Type | Description |
| -------------------------------- | ----------------------------- | -------------------------------- |
| Credentials Added to Project | v1.events.credentials.Added | Project credentials added |
| Credentials Changed in Project | v1.events.credentials.Changed | Credentials changed in project |
| Credentials Removed from Project | v1.events.credentials.Removed | Credentials removed from project |
| Credentials Added to Project | credentials.Added | Project credentials added |
| Credentials Changed in Project | credentials.Changed | Credentials changed in project |
| Credentials Removed from Project | credentials.Removed | Credentials removed from project |

## Searching the audit log

Expand Down

0 comments on commit d6fdd95

Please sign in to comment.