Interface LogOptions

Options for logging an event. Should always be populated, since outcome is always required.

interface LogOptions {
    associatedResources?: ArchonResourceId[];
    associatedUsers?: User[] | UserId[];
    context?: string;
    eventType: EventType;
    outcome: Outcome;
    sensitiveContext?: string;
    session?: Session;
    severity?: Severity;
}

Properties

associatedResources? associatedUsers? context? eventType outcome sensitiveContext? session? severity?

Properties

OptionalassociatedResources

associatedResources?: ArchonResourceId[]

The resources associated with/affected by the event that you're logging. Should be populated any time resources are in scope.

OptionalassociatedUsers

associatedUsers?: User[] | UserId[]

The users associated with/affected by the event that you're logging. Should be populated any time users are in scope.

Optionalcontext

context?: string

Additional context to include with the log message.

eventType

eventType: EventType

The type of event that you're logging.

outcome

outcome: Outcome

The outcome of the event that you're logging.

OptionalsensitiveContext

sensitiveContext?: string

Privileged information to include with the log message. Should include things like stack traces, PII (that isn't covered by other fields), etc.

Optionalsession

session?: Session

The session of the user associated with the event that you're logging. Should be populated any time a user session is in scope.

Optionalseverity

severity?: Severity

The severity of the event that you're logging.

Think: Will this cause system disruption? How severe? Will default to INFO if not provided.

Settings

Member Visibility

On This Page

Properties