func BackgroundAudit[TAuditable](ctxcontext.Context, p *BackgroundAuditParams[T])

func BackgroundTaskFields(subsystemBackgroundSubsystem) map[string]string

func BackgroundTaskFieldsBytes(ctxcontext.Context, loggerslog.Logger, subsystemBackgroundSubsystem) []byte

func BaggageToContext(ctxcontext.Context, dBaggage) (context.Context,error)

func Empty[TAuditable]() T

func ParseIP(ipStrstring)pqtype.Inet

func ResourceID[TAuditable](tgt T)uuid.UUID

func ResourceRequiresOrgID[TAuditable]()bool

func ResourceTarget[TAuditable](tgt T)string

func ResourceType[TAuditable](tgt T)database.ResourceType

type AdditionalFields struct {WorkspaceNamestring               `json:"workspace_name"`BuildNumberstring               `json:"build_number"`BuildReasondatabase.BuildReason `json:"build_reason"`WorkspaceOwnerstring               `json:"workspace_owner"`WorkspaceIDuuid.UUID            `json:"workspace_id"`}

type Auditable interface {database.APIKey |database.Template |database.TemplateVersion |database.User |database.WorkspaceTable |database.GitSSHKey |database.WorkspaceBuild |database.AuditableGroup |database.License |database.WorkspaceProxy |database.AuditOAuthConvertState |database.HealthSettings |database.NotificationsSettings |database.OAuth2ProviderApp |database.OAuth2ProviderAppSecret |database.CustomRole |database.AuditableOrganizationMember |database.Organization |database.NotificationTemplate |idpsync.OrganizationSyncSettings |idpsync.GroupSyncSettings |idpsync.RoleSyncSettings |database.WorkspaceAgent |database.WorkspaceApp}

type Auditor interface {Export(ctxcontext.Context, alogdatabase.AuditLog)error// contains filtered or unexported methods}

funcNewNop¶

func NewNop()Auditor

type BackgroundAuditParams[TAuditable] struct {AuditAuditorLogslog.LoggerUserIDuuid.UUIDRequestIDuuid.UUIDTimetime.TimeStatusintActiondatabase.AuditActionOrganizationIDuuid.UUIDIPstringUserAgentstring// todo: this should automatically marshal an interface{} instead of accepting a raw message.AdditionalFieldsjson.RawMessageNew TOld T}

type BackgroundSubsystemstring

type Baggage interface {Props() ([]baggage.Property,error)}

type Differ struct {DiffFn func(old, newValany)Map}

type Map map[string]OldNew

funcDiff¶

func Diff[TAuditable](aAuditor, left, right T)Map

Diff compares two auditable resources and produces a Map of the changedvalues.

type MockAuditor struct {// contains filtered or unexported fields}

funcNewMock¶

func NewMock() *MockAuditor

func (*MockAuditor)AuditLogs¶

func (a *MockAuditor) AuditLogs() []database.AuditLog

func (*MockAuditor)Contains¶added inv2.4.0

func (a *MockAuditor) Contains(ttesting.TB, expecteddatabase.AuditLog)bool

Contains returns true if, for each non-zero-valued field in expected,there exists a corresponding audit log in the mock auditor that matchesthe expected values. Returns false otherwise.

func (*MockAuditor)Export¶

func (a *MockAuditor) Export(_context.Context, alogdatabase.AuditLog)error

func (*MockAuditor)ResetLogs¶

func (a *MockAuditor) ResetLogs()

ResetLogs removes all audit logs from the mock auditor.This is helpful for testing to get a clean slate.

type OldNew struct {OldanyNewanySecretbool}

type Request[TAuditable] struct {Old TNew T// UserID is an optional field can be passed in when the userID cannot be// determined from the API Key such as in the case of login, when the audit// log is created prior the API Key's existence.UserIDuuid.UUID// Action is an optional field can be passed in if the AuditAction must be// overridden such as in the case of new user authentication when the Audit// Action is 'register', not 'login'.Actiondatabase.AuditAction// contains filtered or unexported fields}

funcInitRequest¶

func InitRequest[TAuditable](whttp.ResponseWriter, p *RequestParams) (*Request[T], func())

InitRequest initializes an audit log for a request. It returns a functionthat should be deferred, causing the audit log to be committed when thehandler returns.

funcInitRequestWithCancel¶added inv2.12.5

func InitRequestWithCancel[TAuditable](whttp.ResponseWriter, p *RequestParams) (*Request[T], func(commitbool))

InitRequestWithCancel returns a commit function with a boolean arg.If the arg is false, future calls to commit() will not create an audit logentry.

func (*Request[T])UpdateOrganizationID¶added inv2.14.0

func (r *Request[T]) UpdateOrganizationID(iduuid.UUID)

UpdateOrganizationID can be used if the organization ID is not knownat the initiation of an audit log request.

type RequestParams struct {AuditAuditorLogslog.Logger// OrganizationID is only provided when possible. If an audit resource extends// beyond the org scope, leave this as the nil uuid.OrganizationIDuuid.UUIDRequest          *http.RequestActiondatabase.AuditActionAdditionalFields interface{}}

type WorkspaceBuildBaggage struct {IPstring}

funcBaggageFromContext¶added inv2.3.2

func BaggageFromContext(ctxcontext.Context)WorkspaceBuildBaggage

funcWorkspaceBuildBaggageFromRequest¶added inv2.3.2

func WorkspaceBuildBaggageFromRequest(r *http.Request)WorkspaceBuildBaggage

func (WorkspaceBuildBaggage)Props¶added inv2.3.2

func (bWorkspaceBuildBaggage) Props() ([]baggage.Property,error)