Skip to content

docs: Add audit logs docs #3975

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Sep 12, 2022
Merged

docs: Add audit logs docs #3975

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
712d518
docs: Add audit logs docs
BrunoQuaresma Sep 9, 2022
3f50821
Apply suggestions from code review
BrunoQuaresma Sep 9, 2022
4460f75
Add contact link
BrunoQuaresma Sep 9, 2022
10d037b
resolve merge conflicts
ghuntley Sep 12, 2022
436665d
Merge branch 'main' into bq/3418
ghuntley Sep 12, 2022
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
18 changes: 18 additions & 0 deletions docs/admin/audit-logs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Audit Logs

This is an enterprise feature that allows **Admins** and **Auditors** to monitor what is happening in their deployment.

## Tracked Events

This feature tracks **create, update and delete** events for the following resources:

- GitSSHKey
- Template
- TemplateVersion
- Workspace
- APIKey
- User

## Enabling this feature

This feature is autoenabled for all enterprise deployments. An Admin can contact us to purchase a license [here](https://coder.com/contact?note=I%20want%20to%20upgrade%20my%20license).
5 changes: 5 additions & 0 deletions docs/manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,11 @@
"description": "Learn how to upgrade Coder.",
"path": "./admin/upgrade.md"
},
{
"title": "Audit Logs",
"description": "Learn how to use Audit Logs in your Coder deployment.",
"path": "./admin/audit-logs.md"
},
{
"title": "Enterprise",
"description": "Learn how to enable Enterprise features.",
Expand Down
14 changes: 13 additions & 1 deletion site/src/components/Tooltips/AuditHelpTooltip.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,28 @@
import { FC } from "react"
import { HelpTooltip, HelpTooltipText, HelpTooltipTitle } from "./HelpTooltip"
import {
HelpTooltip,
HelpTooltipLink,
HelpTooltipLinksGroup,
HelpTooltipText,
HelpTooltipTitle,
} from "./HelpTooltip"

export const Language = {
title: "What is an audit log?",
body: "An audit log is a record of events and changes made throughout a system.",
docs: "Events we track",
}

export const AuditHelpTooltip: FC = () => {
return (
<HelpTooltip>
<HelpTooltipTitle>{Language.title}</HelpTooltipTitle>
<HelpTooltipText>{Language.body}</HelpTooltipText>
<HelpTooltipLinksGroup>
<HelpTooltipLink href="https://coder.com/docs/coder-oss/latest/admin/audit-logs">
{Language.docs}
</HelpTooltipLink>
</HelpTooltipLinksGroup>
</HelpTooltip>
)
}