opentelemetry-js/experimental/packages/otlp-transformer
Marc Pichler bac68fc7d4
feat: add api release preparation scripts, github release creation scripts (#4704)
* feat: add more scripts for release creation

* Update scripts/extract-latest-release-notes.js

* fix: replace console.log() with console.warn(), ensure get-version.js is a version by checking against a regex

* chore: add comment to describe the regex
2024-05-21 14:36:43 +02:00
..
protos@1608f92cf0 feat!: move serialization to `@opentelemetry/otlp-transformer` (#4542) 2024-04-26 16:11:38 +02:00
src feat!: move serialization to `@opentelemetry/otlp-transformer` (#4542) 2024-04-26 16:11:38 +02:00
test feat!: move serialization to `@opentelemetry/otlp-transformer` (#4542) 2024-04-26 16:11:38 +02:00
.eslintignore feat(proto): add @opentelemetry/otlp-transformer package with hand-rolled transformation (#2746) 2022-03-23 13:51:15 -04:00
.eslintrc.js chore(deps): update dependency eslint to v8.43.0 (#3929) 2023-07-06 15:14:56 +02:00
.gitignore feat!: move serialization to `@opentelemetry/otlp-transformer` (#4542) 2024-04-26 16:11:38 +02:00
README.md feat(exporter-logs-otlp-grpc): implements otlp-grpc exporters for logs (#3712) 2023-04-26 11:05:21 +02:00
karma.conf.js feat(proto): add @opentelemetry/otlp-transformer package with hand-rolled transformation (#2746) 2022-03-23 13:51:15 -04:00
package.json feat: add api release preparation scripts, github release creation scripts (#4704) 2024-05-21 14:36:43 +02:00
submodule.md feat!: move serialization to `@opentelemetry/otlp-transformer` (#4542) 2024-04-26 16:11:38 +02:00
tsconfig.esm.json feat!: move serialization to `@opentelemetry/otlp-transformer` (#4542) 2024-04-26 16:11:38 +02:00
tsconfig.esnext.json feat!: move serialization to `@opentelemetry/otlp-transformer` (#4542) 2024-04-26 16:11:38 +02:00
tsconfig.json feat!: move serialization to `@opentelemetry/otlp-transformer` (#4542) 2024-04-26 16:11:38 +02:00

README.md

OpenTelemetry Protocol

NPM Published Version Apache License

Note: This package is intended for internal use only.

Note: This is an experimental package under active development. New releases may include breaking changes.

This package provides everything needed to serialize OpenTelemetry SDK traces, metrics and logs into the OpenTelemetry Protocol format.

Quick Start

To get started you will need to install a compatible OpenTelemetry API.

Install Peer Dependencies

npm install @opentelemetry/api

Serialize Traces/Metrics/Logs

This module exports functions to serialize traces, metrics and logs from the OpenTelemetry SDK into protocol buffers which can be sent over HTTP to the OpenTelemetry collector or a compatible receiver.

import {
  createExportTraceServiceRequest,
  createExportMetricsServiceRequest,
  createExportLogsServiceRequest,
} from '@opentelemetry/otlp-transformer';

const serializedSpans = createExportTraceServiceRequest(readableSpans);
const serializedMetrics = createExportMetricsServiceRequest(readableMetrics);
const serializedLogs = createExportLogsServiceRequest(readableLogRecords);

License

Apache 2.0 - See LICENSE for more information.