LogEventContext

public struct LogEventContext

The context for a log event.

The same context should be used for multiple log events if the context remains the same, e.g. the topic is the same.

  • This identifies the log entry’s activity session, e.g. main or background for a simple app or for a multi-window or multi-document app, there might be document1, document2, tool-palette

    Declaration

    Swift

    public let session: String
    Show on GitHub

  • An identifier for a thread of activity that is related, e.g. an ID and description of an action sequence that can be used to tie together the logging of multiple related actions, such as 345 ‘Upload a file’ where the text comment indicates the user’s initial intent when the sequence started.

    See

    ActionStack for a representation of this.

    Declaration

    Swift

    public let activity: String
    Show on GitHub

  • The topic path identifies a log topic hierarchically. Filtering of logging can take place by topic, such that anything matching the patch will be logged and everything else ignored. In Flint this will be the feature identifier and action name, e.g. ["DocumentManagement", "Editing"].

    Declaration

    Swift

    public let topicPath: TopicPath
    Show on GitHub

  • Optional dictionary of arguments used when performing the action being logged. Typically the context of a Action invocation.

    Declaration

    Swift

    public let arguments: CustomStringConvertible?
    Show on GitHub

  • Optional name of a presenter, indicating what UI component is being used to present the activity related to this log entry.

    Declaration

    Swift

    public let presenter: String?
    Show on GitHub