semantic-conventions/model
Josh Suereth 2ce39aa87d
Merge experimental and stable attributes per resource type. (#1423)
Co-authored-by: Joao Grassi <5938087+joaopgrassi@users.noreply.github.com>
2024-11-06 08:24:28 -08:00
..
android Fixed typos in folder names (android and graphql) (#1412) 2024-09-17 07:21:59 -04:00
artifact Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
aspnetcore Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
aws Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
azure Render events with bodies (#1464) 2024-10-18 15:07:22 -07:00
browser Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
cicd Use wikipedia for OSI link instead of osi-model.com (#1547) 2024-11-05 10:01:50 +01:00
client Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
cloud [chore] Improve markdown gen for registry pages (#1496) 2024-10-21 07:32:21 -07:00
cloudevents Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
cloudfoundry Fix typo in CloudFoundry conventions (#1467) 2024-10-10 11:33:17 -07:00
code Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
container Add network.interface.name attribute (#1492) 2024-10-31 01:32:28 +00:00
cpu Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
database Cosmos DB: Operation Level Metrics (#1438) 2024-10-28 16:49:22 -07:00
deployment [chore] Improve markdown gen for registry pages (#1496) 2024-10-21 07:32:21 -07:00
destination Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
device Render events with bodies (#1464) 2024-10-18 15:07:22 -07:00
disk Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
dns Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
dotnet Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
enduser/deprecated Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
error [chore] Improve markdown gen for registry pages (#1496) 2024-10-21 07:32:21 -07:00
event Render events with bodies (#1464) 2024-10-18 15:07:22 -07:00
exceptions Render events with bodies (#1464) 2024-10-18 15:07:22 -07:00
faas [chore] Improve markdown gen for registry pages (#1496) 2024-10-21 07:32:21 -07:00
feature-flag Render events with bodies (#1464) 2024-10-18 15:07:22 -07:00
file Fix `make table-check` command and regenerate tables (#1441) 2024-09-30 10:23:45 -04:00
gcp Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
gen-ai genai: add system_fingerprint attribute (#1355) 2024-11-01 03:00:09 +00:00
go Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
graphql Fixed typos in folder names (android and graphql) (#1412) 2024-09-17 07:21:59 -04:00
hardware Update hardware group name to match metric_name (#1457) 2024-10-07 16:51:58 -04:00
heroku Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
host Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
http Define semantic convention group and mixed stability rules (#1472) 2024-10-24 16:23:32 -07:00
ios/deprecated Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
jvm Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
k8s [chore] Improve markdown gen for registry pages (#1496) 2024-10-21 07:32:21 -07:00
kestrel Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
linux Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
log Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
messaging Change messaging.operation.type=publish to send (#1422) 2024-10-07 17:12:41 +00:00
network Use wikipedia for OSI link instead of osi-model.com (#1547) 2024-11-05 10:01:50 +01:00
nodejs Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
oci Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
opentracing Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
os Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
otel Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
peer Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
process Make table generation and check targets strict and fix violations (#1535) 2024-10-30 10:17:48 -07:00
profile Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
rpc Render events with bodies (#1464) 2024-10-18 15:07:22 -07:00
server Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
service Merge experimental and stable attributes per resource type. (#1423) 2024-11-06 08:24:28 -08:00
session Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
signalr Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
source Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
system Add network.interface.name attribute (#1492) 2024-10-31 01:32:28 +00:00
telemetry Merge experimental and stable attributes per resource type. (#1423) 2024-11-06 08:24:28 -08:00
test Use wikipedia for OSI link instead of osi-model.com (#1547) 2024-11-05 10:01:50 +01:00
thread Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
tls Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
url Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
user Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
user-agent Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
v8js Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
vcs Use wikipedia for OSI link instead of osi-model.com (#1547) 2024-11-05 10:01:50 +01:00
webengine Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
README.md Update schema url to the weaver one and replace other links to build-tools (#1405) 2024-09-17 13:32:05 +02: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 Weaver as our code generations tool.

See also: