semantic-conventions/specification/trace/semantic_conventions
Armin Ruech 709940084a Fix HTTP span example (#576)
`host.port` was renamed to `net.host.port` in #349
2020-04-28 15:29:29 +02:00
..
README.md Fix markdown-link-check and dead links (#555) 2020-04-09 16:36:01 +02:00
database.md Move specifications into sub-directories per signal (#546) 2020-04-06 17:25:53 -04:00
faas.md Add missing link (#561) 2020-04-10 07:35:33 -07:00
http.md Fix HTTP span example (#576) 2020-04-28 15:29:29 +02:00
messaging.md Clarify messaging.system. (#558) 2020-04-22 07:35:51 -07:00
rpc.md Move specifications into sub-directories per signal (#546) 2020-04-06 17:25:53 -04:00
span-general.md Move specifications into sub-directories per signal (#546) 2020-04-06 17:25:53 -04:00

README.md

Trace Semantic Conventions

In OpenTelemetry spans can be created freely and its up to the implementor to annotate them with attributes specific to the represented operation. Spans represent specific operations in and between systems. Some of these operations represent calls that use well-known protocols like HTTP or database calls. Depending on the protocol and the type of operation, additional information is needed to represent and analyze a span correctly in monitoring systems. It is also important to unify how this attribution is made in different languages. This way, the operator will not need to learn specifics of a language and telemetry collected from polyglot (multi-language) micro-service environments can still be easily correlated and cross-analyzed.

The following semantic conventions for spans are defined:

  • General: General semantic attributes that may be used in describing different kinds of operations.
  • HTTP: Spans for HTTP client and server.
  • Database: Spans for SQL and NoSQL client calls.
  • RPC/RMI: Spans for remote procedure calls (e.g., gRPC).
  • Messaging: Spans for interaction with messaging systems (queues, publish/subscribe, etc.).
  • FaaS: Spans for Function as a Service (e.g., AWS Lambda).