semantic-conventions/model
Daniel Dyla 1582ea46db
Fix `make table-check` command and regenerate tables (#1441)
2024-09-30 10:23:45 -04: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 Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
browser Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
cicd Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
client Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
cloud Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
cloudevents Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
cloudfoundry Add CloudFoundry Resource Attributes (#624) 2024-09-27 14:39:32 -07:00
code Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
container container: add CSI attributes (#1337) 2024-09-20 10:55:19 -07:00
cpu Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
database Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
deployment Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
destination Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
device Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -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 Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
event Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
exceptions Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
faas Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
feature-flag Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -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 Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07: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 Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07: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 Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -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 Add k8s.{pod,node}.memory.usage metrics (#1406) 2024-09-21 03:36:30 +00: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 Fix deprecated note for service bus attributes (#1418) 2024-09-19 14:37:53 -07:00
network Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07: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 Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
profile Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
rpc Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
server Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
service Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07: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 Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
telemetry Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07:00
test Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07: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 Group yaml files by root namespace instead of signal (#1345) 2024-09-16 20:22:50 -07: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: