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/semantic_conventions
History
Trask Stalnaker 29c9b6bc62
Add 'as reported by the JVM' qualifier to JVM cpu metrics (#115) 
Co-authored-by: Armin Ruech <armin.ruech@dynatrace.com>
 		2023-06-23 16:58:22 +02:00
..
deprecated BREAKING: Introduce common `url.*` attributes, and improve use of namespacing under `http.*` (#3355) 2023-05-08 19:55:53 -07:00
logs Editorial: add attribute_group type to log.record (#3374) 2023-04-12 11:14:21 -07:00
metrics Add 'as reported by the JVM' qualifier to JVM cpu metrics (#115) 2023-06-23 16:58:22 +02:00
resource Mark service.version as stable. (#106) 2023-06-20 10:43:49 -07:00
scope/exporter Define semantic conventions yaml for non-otlp conventions (#2850) 2022-10-25 08:46:06 -07:00
trace Change `server.address` and `server.port` from required to recommended on HTTP Server Spans (#114) 2023-06-21 16:01:51 -07:00
README.md Update all links to the specification to point at the 1.21.0 release (#45) 2023-05-23 11:50:37 -04:00
client.yaml BREAKING: Replace `net.peer.*`/`net.host.*` with `client.*`/`server.*` (and `source.*`/`destination.*`) (#3402) 2023-05-08 16:19:51 -07:00
destination.yaml BREAKING: Replace `net.peer.*`/`net.host.*` with `client.*`/`server.*` (and `source.*`/`destination.*`) (#3402) 2023-05-08 16:19:51 -07:00
exception.yaml Suggest column # as an extra source code attribute (#3029) 2023-01-02 18:01:32 -06:00
http-common.yaml Limit HTTP request method cardinality: original_method (option A) (#17) 2023-06-20 09:20:14 -07:00
server.yaml Recommend emitting server.socket.domain only if it's different from s… (#94) 2023-06-14 20:44:04 -07:00
source.yaml BREAKING: Replace `net.peer.*`/`net.host.*` with `client.*`/`server.*` (and `source.*`/`destination.*`) (#3402) 2023-05-08 16:19:51 -07:00
url.yaml BREAKING: Introduce common `url.*` attributes, and improve use of namespacing under `http.*` (#3355) 2023-05-08 19:55:53 -07:00
user-agent.yaml Rename http.user_agent to user_agent.original (#3190) 2023-03-02 14:47:29 -06:00
version.properties YAML Model for Semantic Conventions (#571) 2020-08-27 13:18:51 -07:00

README.md

YAML Model for Semantic Conventions

The YAML descriptions of semantic convention contained in this directory are intended to be used by the various OpenTelemetry language implementations to aid in automatic generation of semantics-related code.

⚠ If you want to read the semantic conventions and not edit them, please see the generated markdown output under /specification/*/semantic_conventions/, i.e.:

Writing semantic conventions

Semantic conventions for the spec MUST adhere to the attribute naming, attribute requirement level, and metric requirement level conventions.

Refer to the syntax for how to write the YAML files for semantic conventions and what the YAML properties mean.

A schema file for VS code is configured in the /.vscode/settings.json of this repository, enabling auto-completion and additional checks. Refer to the generator README for what extension you need.

Generating markdown

These YAML files are used by the make target table-generation to generate consistently formatted Markdown tables for all semantic conventions in the specification. Run it from the root of this repository using the command

make table-generation

For more information, see the semantic convention generator in the OpenTelemetry build tools repository. Using this build tool, it is also possible to generate code for use in OpenTelemetry language projects.

See also: