semantic-conventions/specification/README.md

2.0 KiB

OpenTelemetry Semantic Conventions

The Semantic Conventions define a common set of (semantic) attributes which provide meaning to data when collecting, producing and consuming it. The Semantic Conventions specify among other things span names and kind, metric instruments and units as well as attribute names, types, meaning and valid values. For a detailed definition of the Semantic Conventions' scope see Semantic Conventions Stability. The benefit to using Semantic Conventions is in following a common naming scheme that can be standardized across a codebase, libraries, and platforms. This allows easier correlation and consumption of data.

Semantic Conventions are defined for the following areas:

  • General: General Semantic Conventions.
  • Exceptions: Semantic Conventions for Exceptions.
  • FaaS: Semantic Conventions for Function as a Service (FaaS) operations.
  • CloudEvents: Semantic Conventions for the CloudEvents specification.
  • Feature Flags: Semantic Conventions for feature flag evaluations.
  • HTTP: Semantic Conventions for HTTP client and server operations.
  • Database: Semantic Conventions for database operations.
  • RPC: Semantic Conventions for RPC client and server operations.
  • System: System Semantic Conventions.
  • Other areas can be found in the signal specific Semantic Conventions below

Semantic Conventions by signals:

  • Resource: Semantic Conventions for resources.
  • Trace: Semantic Conventions for traces and spans.
  • Metrics: Semantic Conventions for metrics.
  • Logs: Semantic Conventions for logs data.
  • Events: Semantic Conventions for event data.