@opentelemetry/semantic-conventions
Advanced tools
Package description
The @opentelemetry/semantic-conventions package provides standardized naming and semantic conventions for attributes in OpenTelemetry. These conventions help ensure that telemetry data is consistent, interpretable, and analyzable across different systems and services. The package includes constants for resource attributes, span attributes, and event names that are recommended by the OpenTelemetry specification.
Resource Attributes
Defines standard attributes to be used for service resources, allowing you to annotate your telemetry data with information about the service instance.
{"service.name": 'my-service', "service.version": '1.0.0', "service.instance.id": 'instance-123'}Span Attributes
Provides a set of standard attributes for spans, which represent individual operations within a trace. These attributes can be used to add metadata about the operation, such as HTTP method, URL, and status code.
{"http.method": 'GET', "http.url": 'https://example.com', "http.status_code": 200}Event Names
Includes standardized event names for logging exceptions, messages, and metrics within spans. This helps in categorizing and querying telemetry events.
"exception", "message", "metric"Elastic APM Node.js Agent is a real user monitoring library that provides similar functionality to OpenTelemetry. It allows you to instrument your Node.js applications to track performance metrics and errors. While it also adheres to certain conventions, it is tailored to work with the Elastic Stack, and may not be as flexible as OpenTelemetry in terms of vendor neutrality.
This package is part of the Zipkin ecosystem and provides instrumentation for the HTTP protocol. Similar to OpenTelemetry, it allows for tracing of requests and responses but uses Zipkin's conventions and data model, which differ from OpenTelemetry's semantic conventions.
Jaeger client libraries provide features for distributed tracing similar to OpenTelemetry. They offer their own set of conventions for tracing data. While Jaeger is compatible with OpenTelemetry through exporters, its native conventions are not the same as those defined by OpenTelemetry's semantic conventions.
Changelog
0.12.0
opentelemetry-api, opentelemetry-exporter-collector-grpc, opentelemetry-exporter-collector-proto, opentelemetry-exporter-collector, opentelemetry-exporter-prometheus, opentelemetry-metrics
opentelemetry-api, opentelemetry-core, opentelemetry-plugin-http, opentelemetry-plugin-https, opentelemetry-shim-opentracing
opentelemetry-resource-detector-aws, opentelemetry-resources
opentelemetry-api, opentelemetry-core, opentelemetry-plugin-fetch, opentelemetry-plugin-xml-http-request
opentelemetry-core, opentelemetry-tracing
opentelemetry-exporter-prometheus
opentelemetry-core, opentelemetry-exporter-prometheus, opentelemetry-metrics, opentelemetry-sdk-node, opentelemetry-tracing
opentelemetry-api, opentelemetry-exporter-collector-grpc, opentelemetry-exporter-collector-proto, opentelemetry-exporter-collector, opentelemetry-exporter-prometheus, opentelemetry-metrics
opentelemetry-core, opentelemetry-tracing
opentelemetry-instrumentation
opentelemetry-core
opentelemetry-exporter-prometheus
opentelemetry-api, opentelemetry-core, opentelemetry-exporter-collector-proto, opentelemetry-exporter-collector, opentelemetry-exporter-jaeger, opentelemetry-exporter-prometheus, opentelemetry-exporter-zipkin, opentelemetry-metrics, opentelemetry-tracing
opentelemetry-api, opentelemetry-core, opentelemetry-node, opentelemetry-plugin-http, opentelemetry-plugin-https, opentelemetry-shim-opentracing, opentelemetry-tracing
opentelemetry-node, opentelemetry-sdk-node
opentelemetry-exporter-collector, opentelemetry-exporter-jaeger, opentelemetry-exporter-zipkin, opentelemetry-grpc-utils, opentelemetry-plugin-grpc-js, opentelemetry-plugin-grpc, opentelemetry-plugin-http, opentelemetry-plugin-https
x-opentelemetry-outgoing-request header #1547 (@vmarchaud)opentelemetry-api, opentelemetry-instrumentation, opentelemetry-node
opentelemetry-api, opentelemetry-tracing
opentelemetry-resource-detector-aws, opentelemetry-resources
opentelemetry-node
opentelemetry-resources, opentelemetry-sdk-node
opentelemetry-api, opentelemetry-context-async-hooks, opentelemetry-context-base, opentelemetry-context-zone-peer-dep, opentelemetry-core, opentelemetry-shim-opentracing, opentelemetry-tracing, opentelemetry-web
opentelemetry-exporter-zipkin
opentelemetry-exporter-collector-grpc, opentelemetry-exporter-collector-proto, opentelemetry-exporter-collector, opentelemetry-exporter-jaeger, opentelemetry-exporter-prometheus, opentelemetry-exporter-zipkin, opentelemetry-metrics, opentelemetry-plugin-fetch, opentelemetry-plugin-xml-http-request, opentelemetry-tracing
opentelemetry-plugin-http
opentelemetry-metrics
opentelemetry-plugin-http, opentelemetry-plugin-https
opentelemetry-context-async-hooks
opentelemetry-exporter-collector-grpc, opentelemetry-exporter-collector-proto
opentelemetry-exporter-collector-proto, opentelemetry-exporter-collector
opentelemetry-resource-detector-aws, opentelemetry-resources
opentelemetry-exporter-zipkin
Readme
Semantic Convention constants for use with the OpenTelemetry SDK/APIs. This document defines standard attributes for traces.
npm install --save @opentelemetry/semantic-conventions
import { GeneralAttribute } from '@opentelemetry/semantic-conventions';
const span = tracer.startSpan().startSpan(spanName, spanOptions)
.setAttributes({
[GeneralAttribute.NET_PEER_HOSTNAME]: 'localhost',
});
Apache 2.0 - See LICENSE for more information.
FAQs
OpenTelemetry semantic conventions
The npm package @opentelemetry/semantic-conventions receives a total of 12,336,154 weekly downloads. As such, @opentelemetry/semantic-conventions popularity was classified as popular.
We found that @opentelemetry/semantic-conventions demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).
Security News
LDAPjs, an LDAP Client and Server API for Node.js, was decommissioned after its maintainer received an abusive email from a user, raising concerns about this form of abuse as a potential attack vector.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.