Skip to content

Add Observability (telemetry export) guide#131

Merged
anukiransolur merged 7 commits into
mainfrom
docs/observability-telemetry-export
Jun 11, 2026
Merged

Add Observability (telemetry export) guide#131
anukiransolur merged 7 commits into
mainfrom
docs/observability-telemetry-export

Conversation

@tkosushi

@tkosushi tkosushi commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

https://github.com/tailor-inc/platform-core-services/issues/9829

Summary

User-facing documentation for the telemetryrouter feature: forwarding a workspace's OpenTelemetry traces and logs to external observability backends via the Tailor Terraform provider.

Guide: docs/guides/opentelemetry.md (/guides/opentelemetry, titled Observability / OpenTelemetry).

The guide is written around the platform user's mental model — the user configures telemetry exports, while TelemetryRouter is the internal component that routes a workspace's signals (and the source of the tailor_telemetryrouter_ resource prefix).

  • Intro / How telemetry export works — distinguishes external export from in-console log viewing; concept diagram (signals → TelemetryRouter → your telemetry exports); per-export signal toggles; Secret Manager–based auth
  • Configuring a telemetry exporttailor_telemetryrouter_telemetry_export, api_key / bearer_token auth. The full argument reference points to the Terraform Registry rather than duplicating tables
  • Endpoint format — HTTP/gRPC formats, automatic signal-path append, TLS guidance, private-host rejection
  • Backend examples — leads with direct-OTLP backends (New Relic, Honeycomb); the OpenTelemetry Collector path (Datadog) is presented as one option
  • Resource attributestailor_telemetryrouter_resource_attributes_config (service name prefix, deployment environment)

Accuracy notes (verified against the telemetryrouter implementation)

  • Credentials: the doc recommends the auth block (Secret Manager–backed). headers is marked sensitive but its values persist in Terraform state, so it is documented for non-secret headers only.
  • Datadog: Datadog offers a direct OTLP intake endpoint (traces in preview, with constraints), so the collector is described as the full-featured path rather than a hard requirement.
  • TLS: wording matches the implementation — only private/internal hosts are rejected at config time; there is no http:// rejection. HTTPS is recommended.
  • Metrics: enable_metrics exists, but the platform does not emit metric signals today, so the guide scopes destinations to traces and logs.

Also adds the guide to docs/guides/index.md, fixes the guides nav order entry in .vitepress/config/constants.ts (observabilityopentelemetry), and allowlists docs.datadoghq.com in schema.yml.

Verification

  • pnpm build succeeds (internal links, anchors, mermaid, markdown all compile); page generated at /guides/opentelemetry
  • schema-check / link-check / typo_check run in CI

Document the telemetryrouter feature for users: forwarding a workspace's
OpenTelemetry traces and logs to external backends via the Tailor Terraform
provider.

- New guide at docs/guides/observability.md covering telemetry export setup,
  authentication, endpoint format/validation rules, the Datadog-via-OTel-Collector
  pattern, and resource attributes config.
- Note that metrics are not yet supported.
- Add "observability" to the Guides nav order.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@tkosushi tkosushi self-assigned this Jun 8, 2026
tkosushi and others added 3 commits June 8, 2026 18:54
Replace the "Telemetry routing" wording in the How it works section with the
proper service name TelemetryRouter to remove inconsistent terminology.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Rename observability.md to opentelemetry.md and rewrite for the platform
user's mental model: the user-facing resource is the telemetry export,
while TelemetryRouter is the internal component (and resource-name prefix).

- Retitle to "Observability / OpenTelemetry" and distinguish from in-console
  log viewing
- Add a concept diagram (signals -> TelemetryRouter -> your telemetry exports)
- Lead with direct OTLP backends (New Relic, Honeycomb); present the
  collector path (Datadog) as one option, noting Datadog's direct OTLP
  intake has constraints (traces in preview)
- Point argument details to the Terraform Registry instead of duplicating tables
- Correct credential guidance: prefer the auth block (Secret Manager); headers
  are sensitive but persist in Terraform state, so not for secrets
- Soften endpoint TLS wording to match implementation (only private/internal
  hosts are rejected; no config-time http:// rejection)
- Add the guide to guides/index.md; allowlist docs.datadoghq.com in schema.yml

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@tkosushi
tkosushi marked this pull request as ready for review June 11, 2026 02:44
@tkosushi
tkosushi requested a review from a team as a code owner June 11, 2026 02:44
tkosushi and others added 3 commits June 11, 2026 12:11
Honeycomb and New Relic only offer US/EU data centers (no JP region), and the
endpoint region reflects the backend account's region, not Tailor's. Drop the
EU example and point to vendor docs for region-specific endpoints.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@anukiransolur
anukiransolur merged commit f26bc3b into main Jun 11, 2026
3 checks passed
@anukiransolur
anukiransolur deleted the docs/observability-telemetry-export branch June 11, 2026 19:24
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.

2 participants