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/model
History
Alexandra Konrad a09cbef18b
Move url to the registry (#400) 
Co-authored-by: Joao Grassi <joao.grassi@dynatrace.com>
 		2023-10-18 12:59:44 +02:00
..
deprecated Rename/replace `(client|server).socket.(address|port)` attributes with `network.(peer|local).(address|port)`. (#342) 2023-10-10 17:13:16 +02:00
logs Renamed `specification` and `semantic_conventions` to `model` and `docs` (#166) 2023-07-06 11:43:47 -07:00
metrics Remove outdated note about not recording HTTP `server.address` when only IP address available (#413) 2023-10-18 11:56:27 +02:00
registry Move url to the registry (#400) 2023-10-18 12:59:44 +02:00
resource [resource/host] Add semantic convention for IP addresses of a host (#203) 2023-10-09 07:28:44 +02:00
scope/exporter Renamed `specification` and `semantic_conventions` to `model` and `docs` (#166) 2023-07-06 11:43:47 -07:00
trace Remove `network.type` from HTTP semconv (changing it from recommended to opt-in) (#410) 2023-10-17 18:16:53 +02:00
README.md Bump to latest specification version. (#379) 2023-10-11 09:29:44 -04:00
client.yaml Rename/replace `(client|server).socket.(address|port)` attributes with `network.(peer|local).(address|port)`. (#342) 2023-10-10 17:13:16 +02:00
destination.yaml Rename/replace `(client|server).socket.(address|port)` attributes with `network.(peer|local).(address|port)`. (#342) 2023-10-10 17:13:16 +02:00
error.yaml Clarify that `error.type` should be the fully-qualified exception class name (if applicable) when it represents an exception type (#387) 2023-10-13 13:35:40 +02:00
exception.yaml Renamed `specification` and `semantic_conventions` to `model` and `docs` (#166) 2023-07-06 11:43:47 -07:00
faas-common.yaml Generate FaaS metrics semconv from YAML (#88) 2023-08-07 08:27:53 -07:00
general.yaml Move non-`network.*` attributes out of network.yaml (#296) 2023-09-22 18:55:56 +02:00
http-common.yaml Remove outdated note about not recording HTTP `server.address` when only IP address available (#413) 2023-10-18 11:56:27 +02:00
network.yaml Rename/replace `(client|server).socket.(address|port)` attributes with `network.(peer|local).(address|port)`. (#342) 2023-10-10 17:13:16 +02:00
server.yaml Rename/replace `(client|server).socket.(address|port)` attributes with `network.(peer|local).(address|port)`. (#342) 2023-10-10 17:13:16 +02:00
session.yaml Session.id semantic convention (#215) 2023-09-22 09:04:05 +02:00
source.yaml Rename/replace `(client|server).socket.(address|port)` attributes with `network.(peer|local).(address|port)`. (#342) 2023-10-10 17:13:16 +02:00
url.yaml Move url to the registry (#400) 2023-10-18 12:59:44 +02:00
user-agent.yaml Renamed `specification` and `semantic_conventions` to `model` and `docs` (#166) 2023-07-06 11:43:47 -07:00
version.properties Renamed `specification` and `semantic_conventions` to `model` and `docs` (#166) 2023-07-06 11:43:47 -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 in the docs folder.

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: