Interface EOS004 IAppLogger

Interface 0 EOS004 IAppLogger

Allows implementation of a logger that can be used to log diagnostic messages.

Methods

InitializeLogger

procedure InitializeLogger(App: ModuleInfo; Category: Text; DiagnosticsKey: Text[64]; ServiceConfigCode: Code[20])

Initializes the logger.

Parameters / Return Value

  • App ModuleInfo

    The app for which the logger is being initialized.

  • Category Text[]

    The category to use for this logger.

  • DiagnosticsKey Text[64]

    The diagnostics key.

  • ServiceConfigCode Code[20]

LogMessage

procedure LogMessage(EventId: Text; Message: Text;Verbosity: Verbosity; DataClassification: DataClassification; Scope: TelemetryScope;Payload: Dictionary of [Text, Text])

Logs a message to this logger.

Parameters / Return Value

  • EventId Text[]

    The event ID of the message to be logged.

  • Message Text[]

    The message of the message to be logged.

  • Verbosity Verbosity

    The verbosity of the message to be logged.

  • DataClassification DataClassification

    The data classification of the message to be logged.

  • Scope TelemetryScope

    The scope of the message to be logged.

  • Payload Dictionary[Text,Text]

    An optional additional payload to be logged.

GetAllowedServConfigTypes

procedure GetAllowedServConfigTypes(): List of [Enum "EOS004 Service Config. Type"]

Returns a list of service configuration types this logger supports.

Parameters / Return Value

  • Returns List[Enum]

    A list of compatible service configuration types.

Flush

procedure Flush(): Integer

Flushes any cache or buffer that the logger may have and writes the data to its store.

Parameters / Return Value

  • Returns Integer

    The number of messages that were flushed.


EOS Labs -