diff --git a/docs/admin/security/audit-logs.md b/docs/admin/security/audit-logs.md index 4d66260fb2f7c..9aca854e46b85 100644 --- a/docs/admin/security/audit-logs.md +++ b/docs/admin/security/audit-logs.md @@ -1,6 +1,11 @@ # Audit Logs -Audit Logs allows **Auditors** to monitor user operations in their deployment. +**Audit Logs** allows Auditors to monitor user operations in their deployment. + +> [!NOTE] +> Audit logs require a +> [Premium license](https://coder.com/pricing#compare-plans). +> For more details, [contact your account team](https://coder.com/contact). ## Tracked Events @@ -36,47 +41,43 @@ We track the following resources: -## Filtering logs - -In the Coder UI you can filter your audit logs using the pre-defined filter or -by using the Coder's filter query like the examples below: +## How to Filter Audit Logs -- `resource_type:workspace action:delete` to find deleted workspaces -- `resource_type:template action:create` to find created templates +You can filter audit logs by the following parameters: -The supported filters are: - -- `resource_type` - The type of the resource. It can be a workspace, template, - user, etc. You can - [find here](https://pkg.go.dev/github.com/coder/coder/v2/codersdk#ResourceType) - all the resource types that are supported. +- `resource_type` - The type of the resource, such as a workspace, template, + or user. For more resource types, refer to the + [CoderSDK package documentation](https://pkg.go.dev/github.com/coder/coder/v2/codersdk#ResourceType). - `resource_id` - The ID of the resource. - `resource_target` - The name of the resource. Can be used instead of `resource_id`. -- `action`- The action applied to a resource. You can - [find here](https://pkg.go.dev/github.com/coder/coder/v2/codersdk#AuditAction) - all the actions that are supported. +- `action`- The action applied to a resource, such as `create` or `delete`. + For more actions, refer to the + [CoderSDK package documentation](https://pkg.go.dev/github.com/coder/coder/v2/codersdk#AuditAction). - `username` - The username of the user who triggered the action. You can also use `me` as a convenient alias for the logged-in user. - `email` - The email of the user who triggered the action. - `date_from` - The inclusive start date with format `YYYY-MM-DD`. - `date_to` - The inclusive end date with format `YYYY-MM-DD`. -- `build_reason` - To be used with `resource_type:workspace_build`, the - [initiator](https://pkg.go.dev/github.com/coder/coder/v2/codersdk#BuildReason) - behind the build start or stop. +- `build_reason` - The reason for the workspace build, if `resource_type` is + `workspace_build`. Refer to the + [CoderSDK package documentation](https://pkg.go.dev/github.com/coder/coder/v2/codersdk#BuildReason) + for a list of valid build reasons. ## Capturing/Exporting Audit Logs -In addition to the user interface, there are multiple ways to consume or query +In addition to the Coder dashboard, there are multiple ways to consume or query audit trails. -## REST API +### REST API + +You can retrieve audit logs via the Coder API. -Audit logs can be accessed through our REST API. You can find detailed -information about this in our -[endpoint documentation](../../reference/api/audit.md#get-audit-logs). +Visit the +[`get-audit-logs` endpoint documentation](../../reference/api/audit.md#get-audit-logs) +for details. -## Service Logs +### Service Logs Audit trails are also dispatched as service logs and can be captured and categorized using any log management tool such as [Splunk](https://splunk.com). @@ -124,7 +125,6 @@ log entry: 2023-06-13 03:43:29.233 [info] coderd: audit_log ID=95f7c392-da3e-480c-a579-8909f145fbe2 Time="2023-06-13T03:43:29.230422Z" UserID=6c405053-27e3-484a-9ad7-bcb64e7bfde6 OrganizationID=00000000-0000-0000-0000-000000000000 Ip= UserAgent= ResourceType=workspace_build ResourceID=988ae133-5b73-41e3-a55e-e1e9d3ef0b66 ResourceTarget="" Action=start Diff="{}" StatusCode=200 AdditionalFields="{\"workspace_name\":\"linux-container\",\"build_number\":\"7\",\"build_reason\":\"initiator\",\"workspace_owner\":\"\"}" RequestID=9682b1b5-7b9f-4bf2-9a39-9463f8e41cd6 ResourceIcon="" ``` -## Enabling this feature +## How to Enable Audit Logs -This feature is only available with a premium license. -[Learn more](../licensing/index.md) +This feature is only available with a [Premium license](../licensing/index.md). pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy