Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add deployment environment semantic convention #1722

Merged
merged 2 commits into from
Sep 2, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
206 changes: 104 additions & 102 deletions translator/conventions/opentelemetry.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,113 +17,115 @@ package conventions
// 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 (
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"
AttributeTelemetryAutoVersion = "telemetry.auto.version"
AttributeContainerName = "container.name"
AttributeCloudAccount = "cloud.account.id"
AttributeCloudProvider = "cloud.provider"
AttributeCloudRegion = "cloud.region"
AttributeCloudZone = "cloud.zone"
AttributeContainerID = "container.id"
AttributeContainerImage = "container.image.name"
AttributeContainerName = "container.name"
AttributeContainerTag = "container.image.tag"
AttributeFaasName = "faas.name"
AttributeDeploymentEnvironment = "deployment.environment"
AttributeFaasID = "faas.id"
AttributeFaasVersion = "faas.version"
AttributeFaasInstance = "faas.instance"
AttributeFaasName = "faas.name"
AttributeFaasVersion = "faas.version"
AttributeHostHostname = "host.hostname"
AttributeHostID = "host.id"
AttributeHostImageID = "host.image.id"
AttributeHostImageName = "host.image.name"
AttributeHostImageVersion = "host.image.version"
AttributeHostName = "host.name"
AttributeHostType = "host.type"
AttributeK8sCluster = "k8s.cluster.name"
AttributeK8sNamespace = "k8s.namespace.name"
AttributeK8sContainer = "k8s.container.name"
AttributeK8sPod = "k8s.pod.name"
AttributeK8sPodUID = "k8s.pod.uid"
AttributeK8sCronJob = "k8s.cronjob.name"
AttributeK8sCronJobUID = "k8s.cronjob.uid"
AttributeK8sJob = "k8s.job.name"
AttributeK8sJobUID = "k8s.job.uid"
AttributeK8sDeployment = "k8s.deployment.name"
AttributeK8sDeploymentUID = "k8s.deployment.uid"
AttributeK8sDaemonSet = "k8s.daemonset.name"
AttributeK8sDaemonSetUID = "k8s.daemonset.uid"
AttributeK8sDeployment = "k8s.deployment.name"
AttributeK8sDeploymentUID = "k8s.deployment.uid"
AttributeK8sJob = "k8s.job.name"
AttributeK8sJobUID = "k8s.job.uid"
AttributeK8sNamespace = "k8s.namespace.name"
AttributeK8sPod = "k8s.pod.name"
AttributeK8sPodUID = "k8s.pod.uid"
AttributeK8sReplicaSet = "k8s.replicaset.name"
AttributeK8sReplicaSetUID = "k8s.replicaset.uid"
AttributeK8sStatefulSet = "k8s.statefulset.name"
AttributeK8sStatefulSetUID = "k8s.statefulset.uid"
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.pid"
AttributeProcessExecutableName = "process.executable.name"
AttributeProcessExecutablePath = "process.executable.path"
AttributeProcessCommand = "process.command"
AttributeProcessCommandLine = "process.command_line"
AttributeProcessExecutableName = "process.executable.name"
AttributeProcessExecutablePath = "process.executable.path"
AttributeProcessID = "process.pid"
AttributeProcessOwner = "process.owner"
AttributeCloudProvider = "cloud.provider"
AttributeCloudAccount = "cloud.account.id"
AttributeCloudRegion = "cloud.region"
AttributeCloudZone = "cloud.zone"
AttributeServiceInstance = "service.instance.id"
AttributeServiceName = "service.name"
AttributeServiceNamespace = "service.namespace"
AttributeServiceVersion = "service.version"
AttributeTelemetryAutoVersion = "telemetry.auto.version"
AttributeTelemetrySDKLanguage = "telemetry.sdk.language"
AttributeTelemetrySDKName = "telemetry.sdk.name"
AttributeTelemetrySDKVersion = "telemetry.sdk.version"
)

// GetResourceSemanticConventionAttributeNames a slice with all the Resource Semantic Conventions attribute names.
func GetResourceSemanticConventionAttributeNames() []string {
return []string{
AttributeServiceName,
AttributeServiceNamespace,
AttributeServiceInstance,
AttributeServiceVersion,
AttributeTelemetrySDKName,
AttributeTelemetrySDKLanguage,
AttributeTelemetrySDKVersion,
AttributeContainerName,
AttributeCloudAccount,
AttributeCloudProvider,
AttributeCloudRegion,
AttributeCloudZone,
AttributeContainerImage,
AttributeContainerName,
AttributeContainerTag,
AttributeFaasName,
AttributeDeploymentEnvironment,
AttributeFaasID,
AttributeFaasVersion,
AttributeFaasInstance,
AttributeK8sCluster,
AttributeK8sNamespace,
AttributeK8sPod,
AttributeK8sDeployment,
AttributeFaasName,
AttributeFaasVersion,
AttributeHostHostname,
AttributeHostID,
AttributeHostName,
AttributeHostType,
AttributeHostImageName,
AttributeHostImageID,
AttributeHostImageName,
AttributeHostImageVersion,
AttributeProcessID,
AttributeProcessExecutableName,
AttributeProcessExecutablePath,
AttributeHostName,
AttributeHostType,
AttributeK8sCluster,
AttributeK8sDeployment,
AttributeK8sNamespace,
AttributeK8sPod,
AttributeProcessCommand,
AttributeProcessCommandLine,
AttributeProcessExecutableName,
AttributeProcessExecutablePath,
AttributeProcessID,
AttributeProcessOwner,
AttributeCloudProvider,
AttributeCloudAccount,
AttributeCloudRegion,
AttributeCloudZone,
AttributeServiceInstance,
AttributeServiceName,
AttributeServiceNamespace,
AttributeServiceVersion,
AttributeTelemetrySDKLanguage,
AttributeTelemetrySDKName,
AttributeTelemetrySDKVersion,
}
}

// 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 (
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"
AttributeNetHostIP = "net.host.ip"
AttributeNetHostName = "net.host.name"
AttributeNetHostPort = "net.host.port"
AttributeNetPeerIP = "net.peer.ip"
AttributeNetPeerName = "net.peer.name"
AttributeNetPeerPort = "net.peer.port"
AttributeNetTransport = "net.transport"
AttributePeerService = "peer.service"
)

Expand All @@ -137,100 +139,100 @@ const (
// 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 (
AttributeHTTPMethod = "http.method"
AttributeHTTPURL = "http.url"
AttributeHTTPTarget = "http.target"
AttributeHTTPHost = "http.host"
AttributeHTTPScheme = "http.scheme"
AttributeHTTPStatusCode = "http.status_code"
AttributeHTTPStatusText = "http.status_text"
AttributeHTTPClientIP = "http.client_ip"
AttributeHTTPFlavor = "http.flavor"
AttributeHTTPServerName = "http.server_name"
AttributeHTTPHost = "http.host"
AttributeHTTPHostName = "host.name"
AttributeHTTPHostPort = "host.port"
AttributeHTTPRoute = "http.route"
AttributeHTTPClientIP = "http.client_ip"
AttributeHTTPUserAgent = "http.user_agent"
AttributeHTTPMethod = "http.method"
AttributeHTTPRequestContentLength = "http.request_content_length"
AttributeHTTPRequestContentLengthUncompressed = "http.request_content_length_uncompressed"
AttributeHTTPResponseContentLength = "http.response_content_length"
AttributeHTTPResponseContentLengthUncompressed = "http.response_content_length_uncompressed"
AttributeHTTPRoute = "http.route"
AttributeHTTPScheme = "http.scheme"
AttributeHTTPServerName = "http.server_name"
AttributeHTTPStatusCode = "http.status_code"
AttributeHTTPStatusText = "http.status_text"
AttributeHTTPTarget = "http.target"
AttributeHTTPURL = "http.url"
AttributeHTTPUserAgent = "http.user_agent"
)

// 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 (
AttributeDBSystem = "db.system"
AttributeDBConnectionString = "db.connection_string"
AttributeDBUser = "db.user"

AttributeDBName = "db.name"
AttributeDBStatement = "db.statement"
AttributeDBOperation = "db.operation"

AttributeDBMsSQLInstanceName = "db.mssql.instance_name"
AttributeDBJDBCDriverClassname = "db.jdbc.driver_classname"
AttributeDBCassandraKeyspace = "db.cassandra.keyspace"
AttributeDBHBaseNamespace = "db.hbase.namespace"
AttributeDBRedisDatabaseIndex = "db.redis.database_index"
AttributeDBJDBCDriverClassname = "db.jdbc.driver_classname"
AttributeDBMongoDBCollection = "db.mongodb.collection"
AttributeDBMsSQLInstanceName = "db.mssql.instance_name"

AttributeDBName = "db.name"
AttributeDBOperation = "db.operation"
AttributeDBRedisDatabaseIndex = "db.redis.database_index"
AttributeDBStatement = "db.statement"
AttributeDBSystem = "db.system"
AttributeDBUser = "db.user"
)

// 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 (
AttributeRPCSystem = "rpc.system"
AttributeRPCService = "rpc.service"
AttributeMessageCompressedSize = "message.compressed_size"
AttributeMessageID = "message.id"
AttributeMessageType = "message.type"
AttributeMessageUncompressedSize = "message.uncompressed_size"
AttributeRPCMethod = "rpc.method"
AttributeRPCService = "rpc.service"
AttributeRPCSystem = "rpc.system"
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 FaaS related attributes
// See: https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/semantic_conventions/faas.md
const (
AttributeFaaSTrigger = "faas.trigger"
AttributeFaaSExecution = "faas.execution"
AttributeFaaSCron = "faas.cron"
AttributeFaaSDocumentCollection = "faas.document.collection"
AttributeFaaSDocumentName = "faas.document.name"
AttributeFaaSDocumentOperation = "faas.document.operation"
AttributeFaaSDocumentTime = "faas.document.time"
AttributeFaaSDocumentName = "faas.document.name"
AttributeFaaSExecution = "faas.execution"
AttributeFaaSTime = "faas.time"
AttributeFaaSCron = "faas.cron"
AttributeFaaSTrigger = "faas.trigger"
FaaSTriggerDataSource = "datasource"
FaaSTriggerHTTP = "http"
FaaSTriggerOther = "other"
FaaSTriggerPubSub = "pubsub"
FaaSTriggerTimer = "timer"
FaaSTriggerOther = "other"
)

// 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
const (
AttributeMessagingSystem = "messaging.system"
AttributeMessagingConversationID = "messaging.conversation_id"
AttributeMessagingDestination = "messaging.destination"
AttributeMessagingDestinationKind = "messaging.destination_kind"
AttributeMessagingTempDestination = "messaging.temp_destination"
AttributeMessagingMessageID = "messaging.message_id"
AttributeMessagingOperation = "messaging.operation"
AttributeMessagingPayloadCompressedSize = "messaging.message_payload_compressed_size_bytes"
AttributeMessagingPayloadSize = "messaging.message_payload_size_bytes"
AttributeMessagingProtocol = "messaging.protocol"
AttributeMessagingProtocolVersion = "messaging.protocol_version"
AttributeMessagingSystem = "messaging.system"
AttributeMessagingTempDestination = "messaging.temp_destination"
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 exceptions
// See: https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/semantic_conventions/exceptions.md
const (
AttributeExceptionEventName = "exception"
AttributeExceptionType = "exception.type"
AttributeExceptionMessage = "exception.message"
AttributeExceptionStacktrace = "exception.stacktrace"
AttributeExceptionType = "exception.type"
)