Skip to content

Add build number to workspace_build audit logs #5267

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 15 commits into from
Dec 6, 2022
Merged

Add build number to workspace_build audit logs #5267

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
a630982
got links working
Kira-Pilot Nov 23, 2022
c988b1a
added translations
Kira-Pilot Nov 23, 2022
34a527f
fixed translation
Kira-Pilot Nov 23, 2022
b101417
added translation for unavailable ip
Kira-Pilot Nov 28, 2022
ddc0dc0
added support for group, template, user links
Kira-Pilot Nov 28, 2022
709e42e
cleaned up string
Kira-Pilot Nov 30, 2022
d5eb06a
added deleted label
Kira-Pilot Nov 30, 2022
221f089
querying for workspace id
Kira-Pilot Nov 30, 2022
8177557
remove prints
Kira-Pilot Nov 30, 2022
d1ba2b9
fix/write tests
Kira-Pilot Nov 30, 2022
3406ca7
added build number
Kira-Pilot Dec 2, 2022
3235f0f
Merge remote-tracking branch 'origin/main' into add-build-number-to-a…
Kira-Pilot Dec 2, 2022
500572b
checking for existence of additional fields
Kira-Pilot Dec 2, 2022
b62e554
adjust documentation
Kira-Pilot Dec 2, 2022
7ebb11d
PR feedback
Kira-Pilot Dec 6, 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
Prev Previous commit
PR feedback
  • Loading branch information
@Kira-Pilot
Kira-Pilot committed Dec 6, 2022
commit 7ebb11d02c4b43300cb87035812dd4bd89f364f0
6 changes: 6 additions & 0 deletions coderd/audit.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,12 @@ func (api *API) convertAuditLog(ctx context.Context, dblog database.GetAuditLogs
)
if err != nil {
api.Logger.Error(ctx, "unmarshal additional fields", slog.Error(err))
resourceInfo := map[string]string{
"workspaceName": "unknown",
"buildNumber": "unknown",
}
dblog.AdditionalFields, err = json.Marshal(resourceInfo)
api.Logger.Error(ctx, "marshal additional fields", slog.Error(err))
}

var (
Expand Down
16 changes: 8 additions & 8 deletions coderd/provisionerdserver/provisionerdserver.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -531,23 +531,23 @@ func (server *Server) FailJob(ctx context.Context, failJob *proto.FailedJob) (*p
auditor := server.Auditor.Load()
build, getBuildErr := server.Database.GetWorkspaceBuildByJobID(ctx, job.ID)
if getBuildErr != nil {
server.Logger.Error(ctx, "failed to create audit log - get build err", slog.Error(err))
server.Logger.Error(ctx, "audit log - get build", slog.Error(err))
} else {
auditAction := auditActionFromTransition(build.Transition)
workspace, getWorkspaceErr := server.Database.GetWorkspaceByID(ctx, build.WorkspaceID)
if getWorkspaceErr != nil {
server.Logger.Error(ctx, "failed to create audit log - get workspace err", slog.Error(err))
server.Logger.Error(ctx, "audit log - get workspace", slog.Error(err))
} else {
// We pass the below information to the Auditor so that it
// can form a friendly string for the user to view in the UI.
workspaceResourceInfo := map[string]string{
buildResourceInfo := map[string]string{
"workspaceName": workspace.Name,
"buildNumber": strconv.FormatInt(int64(build.BuildNumber), 10),
}

wriBytes, err := json.Marshal(workspaceResourceInfo)
wriBytes, err := json.Marshal(buildResourceInfo)
if err != nil {
server.Logger.Error(ctx, "could not marshal workspace name", slog.Error(err))
server.Logger.Error(ctx, "marshal workspace resource info for failed job", slog.Error(err))
}

audit.BuildAudit(ctx, &audit.BuildAuditParams[database.WorkspaceBuild]{
Expand Down Expand Up @@ -756,14 +756,14 @@ func (server *Server) CompleteJob(ctx context.Context, completed *proto.Complete

// We pass the below information to the Auditor so that it
// can form a friendly string for the user to view in the UI.
workspaceResourceInfo := map[string]string{
buildResourceInfo := map[string]string{
"workspaceName": workspace.Name,
"buildNumber": strconv.FormatInt(int64(workspaceBuild.BuildNumber), 10),
}

wriBytes, err := json.Marshal(workspaceResourceInfo)
wriBytes, err := json.Marshal(buildResourceInfo)
if err != nil {
server.Logger.Error(ctx, "marshal resource info", slog.Error(err))
server.Logger.Error(ctx, "marshal resource info for successful job", slog.Error(err))
}

audit.BuildAudit(ctx, &audit.BuildAuditParams[database.WorkspaceBuild]{
Expand Down
5 changes: 1 addition & 4 deletions site/src/components/AuditLogRow/AuditLogDescription.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,7 @@ export const AuditLogDescription: FC<{ auditLog: AuditLog }> = ({
let target = auditLog.resource_target.trim()

// audit logs with a resource_type of workspace build use workspace name as a target
if (
auditLog.resource_type === "workspace_build" &&
auditLog.additional_fields.workspaceName
) {
if (auditLog.resource_type === "workspace_build") {
target = auditLog.additional_fields.workspaceName.trim()
}

Expand Down