-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
docs(bun): Add ESM/CJS and Bun-specific OTel docs #14594
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
1c26cd3
docs(node): Add snippet for OTel setup with NodeSDK
s1gr1d 3323e51
add ESM/CJS snippets
s1gr1d 0131ce7
docs(bun): Add OTel docs for Bun
s1gr1d e83b435
update imports
s1gr1d 7cc3bb1
remove duplicated import
s1gr1d 096686b
remove http spans: false
s1gr1d File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
49 changes: 49 additions & 0 deletions
49
...cludes/performance/opentelemetry-setup/error-monitoring-only/javascript.bun.mdx
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
```javascript | ||
import * as Sentry from "@sentry/bun"; | ||
import { SentryContextManager } from "@sentry/node-core"; | ||
import { SentryPropagator, SentrySampler } from "@sentry/opentelemetry"; | ||
|
||
import { NodeTracerProvider } from "@opentelemetry/sdk-trace-node"; | ||
import { BatchSpanProcessor } from "@opentelemetry/sdk-trace-base"; | ||
import { OTLPTraceExporter } from "@opentelemetry/exporter-otlp-http"; | ||
import { registerInstrumentations } from "@opentelemetry/instrumentation"; | ||
|
||
const sentryClient = Sentry.init({ | ||
dsn: "___DSN___", | ||
// Skipping the OpenTelemetry setup automatically disables emitting spans in the httpIntegration with `spans: false` | ||
skipOpenTelemetrySetup: true, | ||
|
||
// Important: We do not define a tracesSampleRate here at all! | ||
// This leads to tracing being disabled | ||
|
||
integrations: (integrations) => | ||
// Filter out the BunServer integration to avoid emitting spans from there | ||
integrations.filter((i) => i.name !== "BunServer") | ||
}); | ||
|
||
// Create and configure e.g. NodeTracerProvider | ||
const provider = new NodeTracerProvider({ | ||
// This ensures trace propagation works as expected | ||
sampler: sentryClient ? new SentrySampler(sentryClient) : undefined, | ||
}); | ||
|
||
provider.addSpanProcessor( | ||
new BatchSpanProcessor( | ||
new OTLPTraceExporter({ | ||
url: "http://OTLP-ENDPOINT.com/api", | ||
}) | ||
) | ||
); | ||
|
||
// Initialize the provider | ||
provider.register({ | ||
propagator: new SentryPropagator(), | ||
contextManager: new SentryContextManager(), | ||
}); | ||
|
||
registerInstrumentations({ | ||
instrumentations: [ | ||
// Add OTEL instrumentation here | ||
], | ||
}); | ||
``` |
88 changes: 88 additions & 0 deletions
88
...m-includes/performance/opentelemetry-setup/error-monitoring-only/javascript.mdx
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,88 @@ | ||
```javascript {tabTitle: ESM} | ||
import * as Sentry from "@sentry/node"; | ||
import { SentryPropagator, SentrySampler } from "@sentry/opentelemetry"; | ||
|
||
import { NodeTracerProvider } from "@opentelemetry/sdk-trace-node"; | ||
import { BatchSpanProcessor } from "@opentelemetry/sdk-trace-base"; | ||
import { OTLPTraceExporter } from "@opentelemetry/exporter-otlp-http"; | ||
import { registerInstrumentations } from "@opentelemetry/instrumentation"; | ||
|
||
const sentryClient = Sentry.init({ | ||
dsn: "___DSN___", | ||
// Skipping the OpenTelemetry setup automatically disables emitting spans in the httpIntegration with `spans: false` | ||
skipOpenTelemetrySetup: true, | ||
|
||
// Important: We do not define a tracesSampleRate here at all! | ||
// This leads to tracing being disabled | ||
}); | ||
|
||
// Create and configure e.g. NodeTracerProvider | ||
const provider = new NodeTracerProvider({ | ||
// This ensures trace propagation works as expected | ||
sampler: sentryClient ? new SentrySampler(sentryClient) : undefined, | ||
}); | ||
|
||
provider.addSpanProcessor( | ||
new BatchSpanProcessor( | ||
new OTLPTraceExporter({ | ||
url: "http://OTLP-ENDPOINT.com/api", | ||
}) | ||
) | ||
); | ||
|
||
// Initialize the provider | ||
provider.register({ | ||
propagator: new SentryPropagator(), | ||
contextManager: new Sentry.SentryContextManager(), | ||
}); | ||
|
||
registerInstrumentations({ | ||
instrumentations: [ | ||
// Add OTEL instrumentation here | ||
], | ||
}); | ||
``` | ||
```javascript {tabTitle: CJS} | ||
const Sentry = require("@sentry/node"); | ||
const { SentryPropagator, SentrySampler } = require("@sentry/opentelemetry"); | ||
|
||
const { NodeTracerProvider } = require("@opentelemetry/sdk-trace-node"); | ||
const { BatchSpanProcessor } = require("@opentelemetry/sdk-trace-base"); | ||
const { OTLPTraceExporter } = require("@opentelemetry/exporter-otlp-http"); | ||
const { registerInstrumentations } = require("@opentelemetry/instrumentation"); | ||
|
||
const sentryClient = Sentry.init({ | ||
dsn: "___DSN___", | ||
// Skipping the OpenTelemetry setup automatically disables emitting spans in the httpIntegration with `spans: false` | ||
skipOpenTelemetrySetup: true, | ||
|
||
// Important: We do not define a tracesSampleRate here at all! | ||
// This leads to tracing being disabled | ||
}); | ||
|
||
// Create and configure e.g. NodeTracerProvider | ||
const provider = new NodeTracerProvider({ | ||
// This ensures trace propagation works as expected | ||
sampler: sentryClient ? new SentrySampler(sentryClient) : undefined, | ||
}); | ||
|
||
provider.addSpanProcessor( | ||
new BatchSpanProcessor( | ||
new OTLPTraceExporter({ | ||
url: "http://OTLP-ENDPOINT.com/api", | ||
}) | ||
) | ||
); | ||
|
||
// Initialize the provider | ||
provider.register({ | ||
propagator: new SentryPropagator(), | ||
contextManager: new Sentry.SentryContextManager(), | ||
}); | ||
|
||
registerInstrumentations({ | ||
instrumentations: [ | ||
// Add OTEL instrumentation here | ||
], | ||
}); | ||
``` |
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
javascript.mdx
files are just copied from the general docs page.I only added some missing imports (
BatchSpanProcessor
andOTLPTraceExporter
) and added the ESM version of it.