Skip to content

docs(byoc): document OTLP/HTTP vs OTLP/gRPC transport selection#669

Open
kenahrens wants to merge 1 commit into
mainfrom
byoc-docs-otlp-transports
Open

docs(byoc): document OTLP/HTTP vs OTLP/gRPC transport selection#669
kenahrens wants to merge 1 commit into
mainfrom
byoc-docs-otlp-transports

Conversation

@kenahrens
Copy link
Copy Markdown
Member

Summary

The BYOC guide pointed users at port 4318 (Fluent Bit's OTLP/HTTP input) without mentioning that the Speedscale forwarder's byoc_otel exporter was historically gRPC-only — so the documented example silently produced zero log records.

The forwarder change (separate gitlab MR on speedscale/speedscale) now picks the transport from the endpoint's port (:4318 → HTTP, :4317 → gRPC, no port → gRPC) and logs the chosen transport at boot. This PR documents:

  • The two OTLP transports and which port each uses
  • How the forwarder auto-selects between them
  • The silent-failure mode so users who change ports also fix their collector receiver
  • An OTel Collector receiver snippet covering both protocols, with a working otel_endpoint example

Test plan

  • Local Docusaurus preview renders the new section cleanly (table, code blocks, :::caution admonition)
  • Existing Fluent Bit example still reads correctly with the new section appended
  • No broken anchors / links

🤖 Generated with Claude Code

The BYOC guide pointed users at port 4318 (Fluent Bit's OTLP/HTTP input)
with no mention that the Speedscale forwarder's byoc_otel exporter was
historically gRPC-only — so the documented example silently produced
zero log records.

The forwarder now picks transport from the endpoint's port (:4318 →
HTTP, :4317 → gRPC, no port → gRPC) and logs the chosen transport at
boot. Document the mapping, add an OTel Collector receiver example
covering both protocols, and call out the silent-failure mode so users
who change ports also change their collector receiver to match.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant