GetAPITracking retrieves the APITracking struct pointer out of a context struct.

GetContextlessTraceLogger returns a logger that can be used outside of a context.

GetGlobalLogger gets the global logger.

GetLogger pulls a logger off the context and returns it.

TODO(thgamble) - 5/5/20 - possible move? only used in ./common/cmd/queuewatcher/queuewatcher.go GetQueueWatcherLogger returns a logger to use in the queue watcher.

InitializeTestLogger initializes a logger that can be used in a test.

InitializeTestLoggerWithLevel initializes a logger that can be used in a test, but with specified trace level.

New returns a new logger.

NewAddonTokenReconcilerLogger creates a logger supposed to be used by addon token reconciler.

NewAPITracking creates a new APITracking struct with data from the http request and returns a pointer to it.

NewAPITrackingFromOutgoingRequest creates a new APITracking struct with data from the out going request (extracting fields out of context) and returns a pointer to it.

NewAPITrackingFromParametersMap creates a new APITracking struct with data pass in a map The intended use of this function is mainly for creating API tracking for queuemessageprocessor and unit testing.

NewAPITrackingWithRegion creates a new APITracking struct with data from the http request and returns a pointer to it.

NewGRPCOutgoingRequestLogger creates an outgoing request logger for gRPC requests.

NewHealthAPITracking creates a new APITracking struct for a health check call.

NewIncomingGRPCRequestLogger creates a request logger for GRPC.

NewIncomingRequestLogger creates an incoming request logger.

NewLogger makes a new Logger that can log trace and qos events.

NewLoggerWithCustomWriter used for testing to overwrite the logger output used by codebase for verification of log fields.

NewLoggerWithFields returns a new logger with additional fields.

NewMSIConnectorLogger creates a logger supposed to be used by msi connector.

NewMSICredentialRefresherLogger creates a logger supposed to be used by msi credential refresher.

NewOutgoingRequestLogger creates an outgoing request logger.

NewOutgoingRequestLoggerForLogrus creates an outgoing request logger from a Logrus logger.

NewServiceLogger creates a logger for a specific service.

ProfileSpan creates a new span for provided function, sets errors on exit.

PropagatorMiddleware will deserialize span information from a given http request and set it in the http context.

SpanContextFromRequest extracts a span context from a given request [used for testing, use Propagator middleware].

SpanContextToRequest is a wrapper to serialize span information from a given context into an http request.

StartSpan wrapper when there are no tags.

StartSpanWithTags wrapper around trace.StartSpan to add tags as attributes and also add additional apitracking fields.

WithAPITracking appends the operation.APITracking onto a copy of the passed in context and returns the copy.

WithLogger takes a context and logger then returns a child context with the logger attached.

WithTags adds additional tags as attributes to the trace.Span.

AADTenantID is the ID of the customer's AAD tenant.

AADTenantIDHeader is the header used by ARM to pass the requesting entity's AAD tenant ID to RP.

AcceptLanguage is the language of request.

AcceptLanguageHeader is the standard http header name used so that we don't have to pass in the http request.

AgentPoolAZEnabled is part of the propertyname which we set in propertybag for the existence az for the agentpool.

AgentPoolName is the name of the agentpool in the managed cluster.

Exported field names to use in the structured logger.

See the code comment of type AKSTeam string to find the link to the WiKi page that contains mapping from the teams defined here to the actual email group/engineers to contact.

AKSTeamSameAsParent means the team owner of this child span is the same as its parent span.

APIVersion is api version on which the request was sent to ACS.

audit event category types as defined in the Ifx documentation.

audit event category types as defined in the Ifx documentation.

audit event category types as defined in the Ifx documentation.

AzureAsyncOperationHeader is the http header name required for async operation.

ClientApplicationID is the value that came in http header for the client app id.

ClientPrincipalName is the client principal name.

ClientRequestID is the client request id.

Exported field names to use in the structured logger.

Exported field names to use in the structured logger.

ContentTypeHeader is the standard http header Content-Type.

ControlPlaneAZEnabled is the propertyname which we set in propertybag for the existence az for the control plane.

CorrelationID is the id that correlation an RP operation with ARM operation/request.

Exported field names to use in the structured logger.

CredentialFormatParameterName is the query string parameter name, optional.

CredentialServerFQDNFormatParameterName is the query string parameter name, optional.

DefaultMessageTTL : set default message TTL for 3 days.

DefaultOperationTimeout : default timeout for completing an async operation (PUT/DELETE).

DefaultSubOperationName is default suboperation name.

DelayStartInSeconds indicate worker not to pick up a message for this amount of time initially.

DequeueCount is the dequeue count of a queue message.

DetectorName is the name of app lens detector.

audit event category types as defined in the Ifx documentation.

audit event category types as defined in the Ifx documentation.

audit event category types as defined in the Ifx documentation.

ExpirationTime is the expiration time of a queue message.

ExtensionAddonName is the name of the extension addon in the managed cluster.

ForwardedForHeader is the http header name for identifying the original client IP address.

audit event category types as defined in the Ifx documentation.

HCPControlPlaneID is the ID of the control-plane as set by HCP.

HCPOperationID is the operation id of operation being processed by HCP service.

HCPUnderlayName is the name of the selected underlay for the hosted control-plane pods.

HostHeader is the standard http header Host used to indicate the target host name.

Exported field names to use in the structured logger.

audit event category types as defined in the Ifx documentation.

InsertionTime is the insertion time of a queue message.

Exported field names to use in the structured logger.

InternalSubscription is the parameters map key used to indicate if the corresponding subscription ID in the map is an internal subscription ID.

Exported field names to use in the structured logger.

audit event category types as defined in the Ifx documentation.

Exported field names to use in the structured logger.

LocationHeader is the http header name required for Accepted status.

LoginMethodParameterName is the query string parameter name, optional.

LowerTrueString is the bool value = true as string used at multiple places.

MaintenanceConfigurationName is the name of the maintenanceConfiguration in the managed cluster.

MessageID is the messageID of a queue message.

audit event category types as defined in the Ifx documentation.

OperationID is the operation id to track a request received by ACS.

Exported field names to use in the structured logger.

OperationName is the name of operation invoked by a request received by ACS.

Exported field names to use in the structured logger.

OperationTimeout is the operation execution timeout.

audit event category types as defined in the Ifx documentation.

audit event category types as defined in the Ifx documentation.

audit event category types as defined in the Ifx documentation.

PopReceipt is the pop receipt of a queue message.

PropertiesBag is the field to put the properties.

Event sources the logger uses that connect to the mdsd.d config to control the tables in geneva this gets uploaded to.

RealIPHeader is the http header name for identifying the client IP address.

Exported field names to use in the structured logger.

RegionName is the region of the service serving traffic.

RequestAcsOperationIDHeader is the http header name ACS RP adds for it's operation ID.

RequestAPIVersionParameterName is the query string parameter name ARM adds for the api version.

RequestARMClientRequestIDHeader is the http header name ARM adds for the client request id.

RequestClientApplicationIDHeader is the http header name ARM adds for the client app id.

RequestClientCertThumbprintHeader contains the sha-1 thumbprint hash for the client cert, added by the nginx proxy in production clusters.

RequestClientPrincipalNameHeader is the http header name ARM adds for the client principal name.

RequestClientSessionIDHeader is the http header name ARM adds for the client session id.

RequestCorrelationIDHeader is the http header name ARM adds for the correlationID.

RequestGraphClientRequestIDHeader is the http header name graph adds for the client request id.

RequestResourceTypeParameterName is the query string parameter name to distinguish between cluster types.

ResourceGroupName contains a group of ARM (RP) resources.

Exported field names to use in the structured logger.

audit event category types as defined in the Ifx documentation.

ResourceName is the name of ACS resource.

Exported field names to use in the structured logger.

ResponseARMRequestIDHeader is the http header name our rp adds to uniquely identify this request, used by ARM.

ResponseGraphRequestIDHeader is the http header name our rp adds to uniquely identify this request, used by graph.

RetryAfterHeader is the http header name for client's back off duration.

Exported field names to use in the structured logger.

RetryAttemptHeader is the grpc header name for retry attempt count.

audit event category types as defined in the Ifx documentation.

Exported field names to use in the structured logger.

StackAnnotationKey allows the kusto exporter to identify the stack annotation and extract it into columns.

SubOperationName is the name of suboperation invoked by a request received by ACS.

Exported field names to use in the structured logger.

SubscriptionID identifies a customer/an organization.

Exported field names to use in the structured logger.

TimeNextVisible is the time a queue message will become visible.

Event sources the logger uses that connect to the mdsd.d config to control the tables in geneva this gets uploaded to.

Exported field names to use in the structured logger.

UserAgent is user agent of the request.

user-agent field is already used by grpc request so a different namespace is needed.

UserAgentHeader is the http header name for the user agent.

audit event category types as defined in the Ifx documentation.

APITracking is a type for storing all the context info needed to track an api call.

Logger is a type that can log trace logs or.

AKSTeam is an AKS sub-team that owns certain AKS code or component.

AuditEventCategory represents the category of an operation as per IfxAudit Event format https://genevamondocs.azurewebsites.net/collect/instrument/audit/onboarding.html https://microsoft.sharepoint.com/:w:/r/teams/WAG/EngSys/Monitor/_layouts/15/Doc.aspx?sourcedoc=%7B5B6CCA37-C4BF-477C-BD25-2BB98D2B83E3%7D&file=Cloud%20Services-%20Part-B%20-%20Audit%20Event%20Schema.docx&action=default&mobileredirect=true.