discoveryextensionevents

Documentation

Index

• type AgentErrorCode
• type CustomLogger
  • func AzureLogger(ctx context.Context, annotationsMap map[string]string) CustomLogger
  • func (c *CustomLogger) LogErrorEvent(ee ErrorEvent)
  • func (c *CustomLogger) LogMetricEvent(me MetricEvent, metricValue int)
  • func (c *CustomLogger) LogTelemetryEvent(te TelemetryEvent)
  • func (c *CustomLogger) Logr() logr.Logger
• type ErrorEvent
  • func NullReferenceErrorEvent(reason string) ErrorEvent
  • func UnhandledErrorEvent(errorCode string, errorMessage string, errortype string) ErrorEvent
  • func (ae ErrorEvent) Error() string
• type MetricEvent
  • func IISApplicationStartMetricEvent() MetricEvent
  • func IISApplicationStopMetricEvent(hostingEnvShutdownReason string) MetricEvent
  • func RoleStartMetricEvent() MetricEvent
  • func RoleStopMetricEvent() MetricEvent
  • func SASURINotValidMetricEvent(subscriptionId string, clientRequestId string, errorCode string, ...) MetricEvent
• type MetricEventId
• type SASURINotValidType
  • func SASURINotValidAnnotation(annClientRequestId string) SASURINotValidType
• type TelemetryEvent
  • func EntityDiscoveredTelemetryEvent(entityId string, entityType string, entityProperties string, ...) TelemetryEvent
• type TelemetryEventId

Types

type AgentErrorCode

type AgentErrorCode int

const (
	Unhandled     AgentErrorCode = 950
	NullReference AgentErrorCode = 951
)

type CustomLogger

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

func AzureLogger

func AzureLogger(ctx context.Context, annotationsMap map[string]string) CustomLogger

func (*CustomLogger) LogErrorEvent

func (c *CustomLogger) LogErrorEvent(ee ErrorEvent)

Logging Exception Event

func (*CustomLogger) LogMetricEvent

func (c *CustomLogger) LogMetricEvent(me MetricEvent, metricValue int)

Logging Metric Event

func (*CustomLogger) LogTelemetryEvent

func (c *CustomLogger) LogTelemetryEvent(te TelemetryEvent)

Logging Telemetry Event

func (*CustomLogger) Logr

func (c *CustomLogger) Logr() logr.Logger

type ErrorEvent

type ErrorEvent struct {
	/// <summary>
	/// Gets the error code associated with the exception.
	/// </summary>
	ErrorCode AgentErrorCode

	/// <summary>
	/// The message associated with the error.
	/// </summary>
	Message string

	/// <summary>
	/// The possible causes for the error.
	/// </summary>
	PossibleCauses string

	/// <summary>
	/// The recommended action for resolving the error.
	/// </summary>
	RecommendedAction string

	/// <summary>
	/// Gets the message parameters needed to form the error message.
	/// </summary>
	MessageParameters map[string]string
}

/ <summary> / This class represents exceptions thrown by the discovery agent. / </summary>

func NullReferenceErrorEvent

func NullReferenceErrorEvent(reason string) ErrorEvent

func UnhandledErrorEvent

func UnhandledErrorEvent(errorCode string, errorMessage string, errortype string) ErrorEvent

func (ErrorEvent) Error

func (ae ErrorEvent) Error() string

define Error() method on the struct

type MetricEvent

type MetricEvent struct {
	/// <summary>
	/// Gets the MetricName that represent the metric.
	/// </summary>
	MetricName MetricEventId

	/// <summary>
	/// Gets the dimension dictionary with the parameter needed for the metric.
	/// </summary>
	Dimensions map[string]string

	/// <summary>
	/// Gets the annotation dictionary with the parameter needed for the metric.
	/// </summary>
	Annotations map[string]string
}

/ <summary> / This class represents metric event by discovery agent. / </summary>

func IISApplicationStartMetricEvent

func IISApplicationStartMetricEvent() MetricEvent

func IISApplicationStopMetricEvent

func IISApplicationStopMetricEvent(hostingEnvShutdownReason string) MetricEvent

func RoleStartMetricEvent

func RoleStartMetricEvent() MetricEvent

func RoleStopMetricEvent

func RoleStopMetricEvent() MetricEvent

func SASURINotValidMetricEvent

func SASURINotValidMetricEvent(subscriptionId string, clientRequestId string, errorCode string, annotation SASURINotValidType) MetricEvent

Event methods

type MetricEventId

type MetricEventId string

const (
	SASURINotValid      MetricEventId = "SASURINotValid"
	RoleStart           MetricEventId = "RoleStart"
	RoleStop            MetricEventId = "RoleStop"
	IISApplicationStart MetricEventId = "IISApplicationStart"
	IISApplicationStop  MetricEventId = "IISApplicationStop"
)

type SASURINotValidType

type SASURINotValidType struct {
	AnnClientRequestId string
}

Annotation class

func SASURINotValidAnnotation

func SASURINotValidAnnotation(annClientRequestId string) SASURINotValidType

Method to get AnnotationType

type TelemetryEvent

type TelemetryEvent struct {
	/// <summary>
	/// Gets the error code associated with the exception.
	/// </summary>
	TelemetryEventId TelemetryEventId

	/// <summary>
	/// Gets the message parameters needed to form the error message.
	/// </summary>
	Dimensions map[string]string
}

/ <summary> / This class represents exceptions thrown by the discovery agent. / </summary>

func EntityDiscoveredTelemetryEvent

func EntityDiscoveredTelemetryEvent(entityId string, entityType string, entityProperties string, executionTimeSec string, entityErrors string) TelemetryEvent

type TelemetryEventId

type TelemetryEventId int

const (
	EntityDiscovered TelemetryEventId = 2002
)