Skip to content

docs(otel): document OTLP serialization performance characteristics#101

Merged
intech merged 1 commit intomainfrom
docs/otel-otlp-perf-characteristics
Apr 19, 2026
Merged

docs(otel): document OTLP serialization performance characteristics#101
intech merged 1 commit intomainfrom
docs/otel-otlp-perf-characteristics

Conversation

@intech
Copy link
Copy Markdown
Contributor

@intech intech commented Apr 19, 2026

Summary

  • Adds Performance Characteristics section to @connectum/otel README
  • Documents OTLP protobuf serializer status per signal (logs/traces/metrics)
  • Explains otlp-transformer version pin rationale
  • Provides guidance for high-volume span workloads

Context

OTel JS attempted to migrate otlp-transformer to @bufbuild/protobuf in PR #6179 but reverted in PR #6225 due to ~13x serialization slowdown (see issue #6221). Hand-rolled ProtobufLogsSerializer landed in v0.215.0 via PR #6390; traces and metrics migrations are still pending (see #6570).

This doc makes the current state explicit for @connectum/otel consumers.

Test plan

  • Markdown renders correctly (biome check passes)
  • Links to upstream issues/PRs resolve
  • No impact on package code

🤖 Generated with Claude Code

…ristics

Adds a Performance Characteristics section to packages/otel/README.md
explaining the current state of OTLP protobuf serialization (hand-rolled
for logs via #6390, protobufjs for traces/metrics post-#6225 revert),
rationale for the otlp-transformer version pin, and guidance for
high-volume span workloads.

Refs: open-telemetry/opentelemetry-js#6221, #6225, #6390, #6570
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 19, 2026

Warning

Rate limit exceeded

@intech has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 17 minutes and 18 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 17 minutes and 18 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 621adc18-9af7-4fec-a0b2-c283ebed0de6

📥 Commits

Reviewing files that changed from the base of the PR and between 5b3f01d and bcdc880.

📒 Files selected for processing (1)
  • packages/otel/README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/otel-otlp-perf-characteristics

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions github-actions Bot added type:docs Documentation: guides, README, JSDoc pkg:otel @connectum/otel (Layer 2: OpenTelemetry) labels Apr 19, 2026
@intech intech self-assigned this Apr 19, 2026
@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented Apr 19, 2026

Open in StackBlitz

@connectum/auth

npm i https://pkg.pr.new/@connectum/auth@101

@connectum/cli

npm i https://pkg.pr.new/@connectum/cli@101

@connectum/core

npm i https://pkg.pr.new/@connectum/core@101

@connectum/events

npm i https://pkg.pr.new/@connectum/events@101

@connectum/events-amqp

npm i https://pkg.pr.new/@connectum/events-amqp@101

@connectum/events-kafka

npm i https://pkg.pr.new/@connectum/events-kafka@101

@connectum/events-nats

npm i https://pkg.pr.new/@connectum/events-nats@101

@connectum/events-redis

npm i https://pkg.pr.new/@connectum/events-redis@101

@connectum/healthcheck

npm i https://pkg.pr.new/@connectum/healthcheck@101

@connectum/interceptors

npm i https://pkg.pr.new/@connectum/interceptors@101

@connectum/otel

npm i https://pkg.pr.new/@connectum/otel@101

@connectum/reflection

npm i https://pkg.pr.new/@connectum/reflection@101

@connectum/testing

npm i https://pkg.pr.new/@connectum/testing@101

commit: bcdc880

@intech intech merged commit e29b598 into main Apr 19, 2026
15 checks passed
@intech intech deleted the docs/otel-otlp-perf-characteristics branch April 19, 2026 00:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pkg:otel @connectum/otel (Layer 2: OpenTelemetry) type:docs Documentation: guides, README, JSDoc

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant