feat(docs): add instrumentation providers to the integrations directory#673
Draft
allenzhou101 wants to merge 1 commit into
Draft
feat(docs): add instrumentation providers to the integrations directory#673allenzhou101 wants to merge 1 commit into
allenzhou101 wants to merge 1 commit into
Conversation
Adds an "instrumentation" integration kind to the shared catalog and an Instrumentation section to the docs integrations gallery, covering the OpenTelemetry backends the instrumentation guide names (Braintrust, Raindrop, Arize, Honeycomb, Datadog, Jaeger) plus Sentry, each with install, quick start, and configure steps for agent/instrumentation.ts. Signed-off-by: Allen Zhou <46854522+allenzhou101@users.noreply.github.com>
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
1 participant
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.
Summary
Adds an Instrumentation section to the docs Integrations page, listing the OpenTelemetry backends an eve agent can export traces to from
agent/instrumentation.ts.@vercel/eve-catalogwith a thirdIntegrationKind,"instrumentation", aninstrumentationEntries()helper, and seven entries: the providers the instrumentation guide names (Braintrust, Raindrop, Arize, Honeycomb, Datadog, Jaeger) plus Sentry.apps/docs/lib/integrations/data.tswith hand-authored install / quick start / configure markdown per provider, following the channel (markdown) shape. Every quick start is a completeagent/instrumentation.tsusingdefineInstrumentation+registerOTel.SiBraintrustandSiJaegerfrom simple-icons, Arize's brand mark (from their official logo SVG), and a simplified Raindrop droplet incurrentColor(matching the hand-authored Honeycomb precedent).Slugs stay unique across the catalog, so providers that already ship a connection use an
-instrumentationsuffix (sentry-instrumentation,datadog-instrumentation,honeycomb-instrumentation); the rest keep bare slugs.Provider endpoints/auth were checked against each provider's current docs: Sentry direct OTLP traces intake (
x-sentry-auth), Honeycomb (x-honeycomb-team), Arize AX (space_id/api_key+openinference.project.namerouting), Raindrop (Bearer write key), Datadog (site-specific OTLP intake, noted as Preview with the Collector recommendation), Jaeger (local OTLP), Braintrust (@braintrust/otel, per the existing guide).No changeset: docs app + private
@vercel/eve-catalogonly; the publishedevepackage is untouched.Verification
pnpm typecheck,pnpm lint,pnpm fmt,pnpm guard:invariantsall pass.@vercel/eve-catalogunit tests updated for the three-way partition and pass (8/8)./integrationsrenders the new filter + seven cards, and all seven detail pages (200) render their setup markdown.