Add Observability (telemetry export) guide#131
Merged
Conversation
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>
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
marked this pull request as ready for review
June 11, 2026 02:44
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
approved these changes
Jun 11, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
https://github.com/tailor-inc/platform-core-services/issues/9829
Summary
User-facing documentation for the
telemetryrouterfeature: 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).tailor_telemetryrouter_telemetry_export,api_key/bearer_tokenauth. The full argument reference points to the Terraform Registry rather than duplicating tablestailor_telemetryrouter_resource_attributes_config(service name prefix, deployment environment)Accuracy notes (verified against the
telemetryrouterimplementation)authblock (Secret Manager–backed).headersis marked sensitive but its values persist in Terraform state, so it is documented for non-secret headers only.http://rejection. HTTPS is recommended.enable_metricsexists, 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(observability→opentelemetry), and allowlistsdocs.datadoghq.cominschema.yml.Verification
pnpm buildsucceeds (internal links, anchors, mermaid, markdown all compile); page generated at/guides/opentelemetry