extensionevents

Documentation

Overview

Copyright (c) Microsoft Corporation. Licensed under the MIT License.

Copyright (c) Microsoft Corporation. Licensed under the MIT License.

Index

• type ExtensionEventManager
  • func New(el logging.ILogger, he *handlerenv.HandlerEnvironment) *ExtensionEventManager
  • func (eem *ExtensionEventManager) LogCriticalEvent(taskName string, message string)
  • func (eem *ExtensionEventManager) LogErrorEvent(taskName string, message string)
  • func (eem *ExtensionEventManager) LogInformationalEvent(taskName string, message string)
  • func (eem *ExtensionEventManager) LogVerboseEvent(taskName string, message string)
  • func (eem *ExtensionEventManager) LogWarningEvent(taskName string, message string)
  • func (eem *ExtensionEventManager) SetOperationID(operationID string)
  • func (eem *ExtensionEventManager) SetPrefix(prefix string)

Types

type ExtensionEventManager

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

ExtensionEventManager allows extensions to log events that will be collected by the Guest Agent

func New

func New(el logging.ILogger, he *handlerenv.HandlerEnvironment) *ExtensionEventManager

New creates a new instance of the ExtensionEventManager

func (*ExtensionEventManager) LogCriticalEvent

func (eem *ExtensionEventManager) LogCriticalEvent(taskName string, message string)

LogCriticalEvent writes a message with critical status for the extension

func (*ExtensionEventManager) LogErrorEvent

func (eem *ExtensionEventManager) LogErrorEvent(taskName string, message string)

LogErrorEvent writes a message with error status for the extension

func (*ExtensionEventManager) LogInformationalEvent

func (eem *ExtensionEventManager) LogInformationalEvent(taskName string, message string)

LogInformationalEvent writes a message with informational status for the extension

func (*ExtensionEventManager) LogVerboseEvent

func (eem *ExtensionEventManager) LogVerboseEvent(taskName string, message string)

LogVerboseEvent writes a message with verbose status for the extension

func (*ExtensionEventManager) LogWarningEvent

func (eem *ExtensionEventManager) LogWarningEvent(taskName string, message string)

LogWarningEvent writes a message with warning status for the extension

func (*ExtensionEventManager) SetOperationID

func (eem *ExtensionEventManager) SetOperationID(operationID string)

"SetOperationId()" sets operation Id passed by user while logging extension events This is made as separate function (not included in "logEvent()") to enable users to set Operation ID globally for their extension. "operationID" corresponds to "Context3" column in 'GuestAgentGenericLogs' table (Rdos cluster)

func (*ExtensionEventManager) SetPrefix

func (eem *ExtensionEventManager) SetPrefix(prefix string)

"SetPrefix()" sets a prefix to use for all messages The prefix will continue to be used until "SetPrefix()" is called with an empty string