conventions

Documentation

Index

• Constants

Constants

const (
	OCAttributeProcessStartTime  = "opencensus.starttime"
	OCAttributeProcessID         = "opencensus.pid"
	OCAttributeExporterVersion   = "opencensus.exporterversion"
	OCAttributeResourceType      = "opencensus.resourcetype"
	OCTimeEventMessageEventType  = "opencensus.timeevent.messageevent.type"
	OCTimeEventMessageEventID    = "opencensus.timeevent.messageevent.id"
	OCTimeEventMessageEventUSize = "opencensus.timeevent.messageevent.usize"
	OCTimeEventMessageEventCSize = "opencensus.timeevent.messageevent.csize"
)

OTLP attributes to map certain OpenCensus proto fields. These fields don't have corresponding fields in OTLP, nor are defined in OTLP semantic conventions. TODO: decide if any of these must be in OTLP semantic conventions.

const (
	AttributeServiceName           = "service.name"
	AttributeServiceNamespace      = "service.namespace"
	AttributeServiceInstance       = "service.instance.id"
	AttributeServiceVersion        = "service.version"
	AttributeTelemetrySDKName      = "telemetry.sdk.name"
	AttributeTelemetrySDKLanguage  = "telemetry.sdk.language"
	AttributeTelemetrySDKVersion   = "telemetry.sdk.version"
	AttributeContainerName         = "container.name"
	AttributeContainerImage        = "container.image.name"
	AttributeContainerTag          = "container.image.tag"
	AttributeFaasName              = "faas.name"
	AttributeFaasID                = "faas.id"
	AttributeFaasVersion           = "faas.version"
	AttributeFaasInstance          = "faas.instance"
	AttributeK8sCluster            = "k8s.cluster.name"
	AttributeK8sNamespace          = "k8s.namespace.name"
	AttributeK8sPod                = "k8s.pod.name"
	AttributeK8sDeployment         = "k8s.deployment.name"
	AttributeHostHostname          = "host.hostname"
	AttributeHostID                = "host.id"
	AttributeHostName              = "host.name"
	AttributeHostType              = "host.type"
	AttributeHostImageName         = "host.image.name"
	AttributeHostImageID           = "host.image.id"
	AttributeHostImageVersion      = "host.image.version"
	AttributeProcessID             = "process.id"
	AttributeProcessExecutableName = "process.executable.name"
	AttributeProcessExecutablePath = "process.executable.path"
	AttributeProcessCommand        = "process.command"
	AttributeProcessCommandLine    = "process.command_line"
	AttributeProcessUsername       = "process.username"
	AttributeCloudProvider         = "cloud.provider"
	AttributeCloudAccount          = "cloud.account.id"
	AttributeCloudRegion           = "cloud.region"
	AttributeCloudZone             = "cloud.zone"
)

OpenTelemetry Semantic Convention values for Resource attribute names. See: https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/resource/semantic_conventions/README.md

const (
	AttributeComponent    = "component"
	AttributeNetTransport = "net.transport"
	AttributeNetPeerIP    = "net.peer.ip"
	AttributeNetPeerPort  = "net.peer.port"
	AttributeNetPeerName  = "net.peer.name"
	AttributeNetHostIP    = "net.host.ip"
	AttributeNetHostPort  = "net.host.port"
	AttributeNetHostName  = "net.host.name"
	AttributeEnduserID    = "enduser.id"
	AttributeEnduserRole  = "enduser.role"
	AttributeEnduserScope = "enduser.scope"
	AttributePeerService  = "peer.service"
)

OpenTelemetry Semantic Convention values for general Span attribute names. See: https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/semantic_conventions/span-general.md

const (
	ComponentTypeHTTP = "http"
	ComponentTypeGRPC = "grpc"
)

OpenTelemetry Semantic Convention values for component attribute values. Possibly being removed due to issue #336

const (
	AttributeHTTPMethod                            = "http.method"
	AttributeHTTPURL                               = "http.url"
	AttributeHTTPTarget                            = "http.target"
	AttributeHTTPHost                              = "http.host"
	AttributeHTTPScheme                            = "http.scheme"
	AttributeHTTPStatusCode                        = "http.status_code"
	AttributeHTTPStatusText                        = "http.status_text"
	AttributeHTTPFlavor                            = "http.flavor"
	AttributeHTTPServerName                        = "http.server_name"
	AttributeHTTPHostName                          = "host.name"
	AttributeHTTPHostPort                          = "host.port"
	AttributeHTTPRoute                             = "http.route"
	AttributeHTTPClientIP                          = "http.client_ip"
	AttributeHTTPUserAgent                         = "http.user_agent"
	AttributeHTTPRequestContentLength              = "http.request_content_length"
	AttributeHTTPRequestContentLengthUncompressed  = "http.request_content_length_uncompressed"
	AttributeHTTPResponseContentLength             = "http.response_content_length"
	AttributeHTTPResponseContentLengthUncompressed = "http.response_content_length_uncompressed"
)

OpenTelemetry Semantic Convention attribute names for HTTP related attributes See: https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/semantic_conventions/http.md

const (
	AttributeDBType      = "db.type"
	AttributeDBInstance  = "db.instance"
	AttributeDBStatement = "db.statement"
	AttributeDBUser      = "db.user"
	AttributeDBURL       = "db.url"
)

OpenTelemetry Semantic Convention attribute names for database related attributes See: https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/semantic_conventions/database.md

const (
	AttributeRPCSystem               = "rpc.system"
	AttributeRPCService              = "rpc.service"
	AttributeRPCMethod               = "rpc.method"
	EventTypeMessage                 = "message"
	AttributeMessageType             = "message.type"
	MessageTypeReceived              = "RECEIVED"
	MessageTypeSent                  = "SENT"
	AttributeMessageID               = "message.id"
	AttributeMessageCompressedSize   = "message.compressed_size"
	AttributeMessageUncompressedSize = "message.uncompressed_size"
)

OpenTelemetry Semantic Convention attribute names for gRPC related attributes See: https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/semantic_conventions/rpc.md

const (
	AttributeFaaSTrigger            = "faas.trigger"
	AttributeFaaSExecution          = "faas.execution"
	AttributeFaaSDocumentCollection = "faas.document.collection"
	AttributeFaaSDocumentOperation  = "faas.document.operation"
	AttributeFaaSDocumentTime       = "faas.document.time"
	AttributeFaaSDocumentName       = "faas.document.name"
	AttributeFaaSTime               = "faas.time"
	AttributeFaaSCron               = "faas.cron"
	FaaSTriggerDataSource           = "datasource"
	FaaSTriggerHTTP                 = "http"
	FaaSTriggerPubSub               = "pubsub"
	FaaSTriggerTimer                = "timer"
	FaaSTriggerOther                = "other"
)

OpenTelemetry Semantic Convention attribute names for FaaS related attributes See: https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/semantic_conventions/faas.md

const (
	AttributeMessagingSystem                = "messaging.system"
	AttributeMessagingDestination           = "messaging.destination"
	AttributeMessagingDestinationKind       = "messaging.destination_kind"
	AttributeMessagingTempDestination       = "messaging.temp_destination"
	AttributeMessagingProtocol              = "messaging.protocol"
	AttributeMessagingProtocolVersion       = "messaging.protocol_version"
	AttributeMessagingURL                   = "messaging.url"
	AttributeMessagingMessageID             = "messaging.message_id"
	AttributeMessagingConversationID        = "messaging.conversation_id"
	AttributeMessagingPayloadSize           = "messaging.message_payload_size_bytes"
	AttributeMessagingPayloadCompressedSize = "messaging.message_payload_compressed_size_bytes"
	AttributeMessagingOperation             = "messaging.operation"
)

OpenTelemetry Semantic Convention attribute names for messaging system related attributes See: https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/semantic_conventions/messaging.md