Skip to content

feat: support session audit log #16703

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 3 commits into from
Feb 26, 2025
Merged

feat: support session audit log #16703

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8a43e89
feat: support session audit log
BrunoQuaresma Feb 25, 2025
c30b299
Update site/src/pages/AuditPage/AuditLogRow/AuditLogDescription/Audit…
BrunoQuaresma Feb 26, 2025
773dd2b
Show reason
BrunoQuaresma Feb 26, 2025
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
25 changes: 22 additions & 3 deletions site/src/pages/AuditPage/AuditLogRow/AuditLogDescription/AuditLogDescription.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,15 @@ interface AuditLogDescriptionProps {
export const AuditLogDescription: FC<AuditLogDescriptionProps> = ({
auditLog,
}) => {
let target = auditLog.resource_target.trim();
let user = auditLog.user?.username.trim();

if (auditLog.resource_type === "workspace_build") {
return <BuildAuditDescription auditLog={auditLog} />;
}
if (auditLog.additional_fields?.connection_type) {
return <AppSessionAuditLogDescription auditLog={auditLog} />;
}

let target = auditLog.resource_target.trim();
let user = auditLog.user?.username.trim();

// SSH key entries have no links
if (auditLog.resource_type === "git_ssh_key") {
Expand Down Expand Up @@ -57,3 +60,19 @@ export const AuditLogDescription: FC<AuditLogDescriptionProps> = ({
</span>
);
};

function AppSessionAuditLogDescription({ auditLog }: AuditLogDescriptionProps) {
const { connection_type, workspace_owner, workspace_name } =
auditLog.additional_fields;

return (
<>
{connection_type} session to {workspace_owner}'s{" "}
<Link component={RouterLink} to={`${auditLog.resource_link}`}>
<strong>{workspace_name}</strong>
</Link>{" "}
workspace{" "}
<strong>{auditLog.action === "disconnect" ? "closed" : "opened"}</strong>
</>
);
}
40 changes: 40 additions & 0 deletions site/src/pages/AuditPage/AuditLogRow/AuditLogRow.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,3 +159,43 @@ export const NoUserAgent: Story = {
},
},
};

export const WithConnectionType: Story = {
args: {
showOrgDetails: true,
auditLog: {
id: "725ea2f2-faae-4bdd-a821-c2384a67d89c",
request_id: "a486c1cb-6acb-41c9-9bce-1f4f24a2e8ff",
time: "2025-02-24T10:20:08.054072Z",
ip: "fd7a:115c:a1e0:4fa5:9ccd:27e4:5d72:c66a",
user_agent: "",
resource_type: "workspace_agent",
resource_id: "813311fb-bad3-4a92-98cd-09ee57e73d6e",
resource_target: "main",
resource_icon: "",
action: "disconnect",
diff: {},
status_code: 255,
additional_fields: {
reason: "process exited with error status: -1",
build_number: "1",
build_reason: "initiator",
workspace_id: "6a7cfb32-d208-47bb-91d0-ec54b69912b6",
workspace_name: "test2",
connection_type: "SSH",
workspace_owner: "admin",
},
description: "{user} disconnected workspace agent {target}",
resource_link: "",
is_deleted: false,
organization_id: "0e6fa63f-b625-4a6f-ab5b-a8217f8c80b3",
organization: {
id: "0e6fa63f-b625-4a6f-ab5b-a8217f8c80b3",
name: "coder",
display_name: "Coder",
icon: "",
},
user: null,
},
},
};
32 changes: 23 additions & 9 deletions site/src/pages/AuditPage/AuditLogRow/AuditLogRow.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,8 @@ export const AuditLogRow: FC<AuditLogRowProps> = ({
</Stack>

<Stack direction="row" alignItems="center">
<StatusPill code={auditLog.status_code} />

{/* With multi-org, there is not enough space so show
everything in a tooltip. */}
{showOrgDetails ? (
Expand Down Expand Up @@ -169,6 +171,12 @@ export const AuditLogRow: FC<AuditLogRowProps> = ({
</Link>
</div>
)}
{auditLog.additional_fields?.reason && (
<div>
<h4 css={styles.auditLogInfoHeader}>Reason:</h4>
<div>{auditLog.additional_fields?.reason}</div>
</div>
)}
</div>
}
>
Expand Down Expand Up @@ -203,13 +211,6 @@ export const AuditLogRow: FC<AuditLogRowProps> = ({
)}
</Stack>
)}

<Pill
css={styles.httpStatusPill}
type={httpStatusColor(auditLog.status_code)}
>
{auditLog.status_code.toString()}
</Pill>
</Stack>
</Stack>
</Stack>
Expand All @@ -218,7 +219,7 @@ export const AuditLogRow: FC<AuditLogRowProps> = ({
{shouldDisplayDiff ? (
<div> {<DropdownArrow close={isDiffOpen} />}</div>
) : (
<div css={styles.columnWithoutDiff}></div>
<div css={styles.columnWithoutDiff} />
)}
</Stack>

Expand All @@ -232,6 +233,19 @@ export const AuditLogRow: FC<AuditLogRowProps> = ({
);
};

function StatusPill({ code }: { code: number }) {
const isHttp = code >= 100;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, a better measure of http status code may be whether or not this was a connect/disconnect action. Shell errors can be 0-255, but perhaps we should just mark them as 0/1 on the API side, wdyt?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm... I think it works 👍


return (
<Pill
css={styles.statusCodePill}
type={isHttp ? httpStatusColor(code) : code === 0 ? "success" : "error"}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice fix for this!

>
{code.toString()}
</Pill>
);
}

const styles = {
auditLogCell: {
padding: "0 !important",
Expand Down Expand Up @@ -287,7 +301,7 @@ const styles = {
width: "100%",
},

httpStatusPill: {
statusCodePill: {
fontSize: 10,
height: 20,
paddingLeft: 10,
Expand Down
Loading