open-telemetry
/
semantic-conventions
mirror of https://github.com/open-telemetry/semantic-conventions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
semantic-conventions/specification/trace/semantic_conventions
History
Christian Neumüller 30fed0f050 Clarify some cases for http.host and http.client_ip. (#1890) 
* Clarify some cases for http.host and http.client_ip.

* Fill in PR#.
 		2021-09-07 19:18:49 +00:00
..
instrumentation Lambda instrumentations should check if X-Ray parent context is valid (#1867) 2021-08-17 14:28:52 +02:00
README.md AWS SDK common and dynamodb conventions (#1422) 2021-03-30 18:53:48 +02:00
database.md Add cockroachdb to db.system semantic conventions (#1725) 2021-05-28 16:26:21 +02:00
exceptions.md Add lifecycle statuses to all documents (#1385) 2021-02-04 15:06:46 +01:00
faas.md [semantic conventions] add alibaba cloud as a cloud provider (#1831) 2021-08-03 11:22:31 +00:00
http.md Clarify some cases for http.host and http.client_ip. (#1890) 2021-09-07 19:18:49 +00:00
messaging.md Add `consumer_id` to identify the consumer (#1810) 2021-08-23 20:27:08 +02:00
rpc.md Add event semantic conventions, update semantic convention generator to v0.5.0 (#1843) 2021-09-03 16:59:33 +02:00
span-general.md Adjust .NET casing (#1883) 2021-08-23 10:02:35 +02:00

README.md

Trace Semantic Conventions

Status: Experimental

In OpenTelemetry spans can be created freely and it’s 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).
  • Exceptions: Attributes for recording exceptions associated with a span.

The following library-specific semantic conventions are defined:

Apart from semantic conventions for traces and metrics, OpenTelemetry also defines the concept of overarching Resources with their own Resource Semantic Conventions.