@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
1.1.0
opentelemetry-resources
exporter-trace-otlp-http, opentelemetry-core
instrumentation-http
opentelemetry-core, opentelemetry-exporter-jaeger
exporter-trace-otlp-grpc, exporter-trace-otlp-http, exporter-trace-otlp-proto, opentelemetry-context-async-hooks, opentelemetry-context-zone-peer-dep, opentelemetry-core, opentelemetry-exporter-jaeger, opentelemetry-exporter-zipkin, opentelemetry-propagator-b3, opentelemetry-propagator-jaeger, opentelemetry-resources, opentelemetry-sdk-trace-base, opentelemetry-sdk-trace-node, opentelemetry-sdk-trace-web, opentelemetry-shim-opentracing
opentelemetry-sdk-trace-web
exporter-trace-otlp-http, exporter-trace-otlp-proto
exporter-trace-otlp-grpc, exporter-trace-otlp-http, exporter-trace-otlp-proto, opentelemetry-core, opentelemetry-exporter-jaeger, opentelemetry-sdk-trace-base
opentelemetry-propagator-jaeger
exporter-trace-otlp-grpc, exporter-trace-otlp-http, exporter-trace-otlp-proto
opentelemetry-context-zone-peer-dep, opentelemetry-context-zone, opentelemetry-core, opentelemetry-exporter-zipkin, opentelemetry-propagator-b3, opentelemetry-resources, opentelemetry-sdk-trace-base, opentelemetry-sdk-trace-web, opentelemetry-semantic-conventions
exporter-trace-otlp-grpc, exporter-trace-otlp-http, exporter-trace-otlp-proto
opentelemetry-sdk-trace-base
opentelemetry-core
opentelemetry-exporter-jaeger
opentelemetry-resources
opentelemetry-propagator-jaeger
opentelemetry-exporter-zipkin, opentelemetry-sdk-trace-web
exporter-trace-otlp-grpc
opentelemetry-context-async-hooks
opentelemetry-context-async-hooks, opentelemetry-sdk-trace-node
opentelemetry-sdk-trace-base
exporter-trace-otlp-http, opentelemetry-context-zone-peer-dep, opentelemetry-context-zone, opentelemetry-core, opentelemetry-exporter-zipkin, opentelemetry-propagator-b3, opentelemetry-resources, opentelemetry-sdk-trace-base, opentelemetry-sdk-trace-web, opentelemetry-semantic-conventions
opentelemetry-core
exporter-trace-otlp-grpc, exporter-trace-otlp-http, exporter-trace-otlp-proto, opentelemetry-exporter-jaeger, opentelemetry-exporter-zipkin, opentelemetry-propagator-b3, opentelemetry-resources, opentelemetry-sdk-trace-base, opentelemetry-sdk-trace-web, opentelemetry-semantic-conventions
exporter-trace-otlp-grpc, exporter-trace-otlp-http, exporter-trace-otlp-proto, opentelemetry-context-async-hooks, opentelemetry-context-zone-peer-dep, opentelemetry-context-zone, opentelemetry-core, opentelemetry-exporter-jaeger, opentelemetry-exporter-zipkin, opentelemetry-propagator-b3, opentelemetry-propagator-jaeger, opentelemetry-resources, opentelemetry-sdk-trace-base, opentelemetry-sdk-trace-node, opentelemetry-sdk-trace-web, opentelemetry-semantic-conventions, opentelemetry-shim-opentracing, template
opentelemetry-context-async-hooks, opentelemetry-context-zone-peer-dep, opentelemetry-context-zone, opentelemetry-core, opentelemetry-exporter-jaeger, opentelemetry-exporter-zipkin, opentelemetry-propagator-b3, opentelemetry-propagator-jaeger, opentelemetry-resources, opentelemetry-sdk-trace-base, opentelemetry-sdk-trace-node, opentelemetry-sdk-trace-web, opentelemetry-semantic-conventions, opentelemetry-shim-opentracing
opentelemetry-exporter-jaeger, opentelemetry-exporter-zipkin, opentelemetry-resources, opentelemetry-semantic-conventions
opentelemetry-sdk-trace-web
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 { SemanticAttributes } from '@opentelemetry/semantic-conventions';
const span = tracer.startSpan().startSpan(spanName, spanOptions)
.setAttributes({
[SemanticAttributes.NET_PEER_NAME]: 'localhost',
});
Apache 2.0 - See LICENSE for more information.
FAQs
Unknown package
The npm package @opentelemetry/semantic-conventions receives a total of 11,484,389 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 0 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.
Research
Security News
Socket researchers unpack a typosquatting package with malicious code that logs keystrokes and exfiltrates sensitive data to a remote server.
Security News
The JavaScript community has launched the e18e initiative to improve ecosystem performance by cleaning up dependency trees, speeding up critical parts of the ecosystem, and documenting lighter alternatives to established tools.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.