@vercel/otel 1.3.1-e26a383e-20240221194233 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -55,15 +55,20 @@ Registers the OpenTelemetry SDK with the specified configuration. Configuration
55
55
  - `propagateContextUrls`: A set of URL matchers (string prefix or regex) for which the tracing context should be propagated (see `propagators`). By default the context is propagated _only_ for the [deployment URLs](https://vercel.com/docs/deployments/generated-urls), all other URLs should be enabled explicitly. Example: `fetch: { propagateContextUrls: [ /my.api/ ] }`.
56
56
  - `dontPropagateContextUrls`: A set of URL matchers (string prefix or regex) for which the tracing context should not be propagated (see `propagators`). This allows you to exclude a subset of URLs allowed by the `propagateContextUrls`.
57
57
  - `resourceNameTemplate`: A string for the "resource.name" attribute that can include attribute expressions in `{}`. Example: `fetch: { resourceNameTemplate: "{http.host}" }`.
58
+ - The `fetch` instrumentation also allows the caller to pass relevant telemetry parameters via `fetch(..., { opentelemetry: {} })` argument (requires Next 14.1.1 or above), which may include the following fields:
59
+ - `ignore: boolean`: overrides `ignoreUrls` for this call.
60
+ - `propagateContext: boolean`: overrides `propagateContextUrls` for this call.
61
+ - `spanName: string`: overrides the computed span name for this call.
62
+ - `attributes: Attributes`: overrides the computed attributes for this call.
58
63
  - `propagators`: A set of propagators that may extend inbound and outbound contexts. By default, `@vercel/otel` configures [W3C Trace Context](https://www.w3.org/TR/trace-context/) propagator.
59
64
  - `traceSampler`: The sampler to be used to decide which requests should be traced. By default, all requests are traced. This option can be changed to, for instance, only trace 1% of all requests.
60
65
  - `spanProcessors` and `traceExporter`: The export mechanism for traces. By default, `@vercel/otel` configures the best export mechanism for the environment. For instance, if a [tracing integrations](https://vercel.com/docs/observability/otel-overview/quickstart) is configured on Vercel, this integration will be automatically used for export; otherwise an [OTLP exporter](https://opentelemetry.io/docs/specs/otel/configuration/sdk-environment-variables/#otlp-exporter) can be used if configured in environment variables.
61
66
 
62
- See [API](https://otel-site-git-dimavoytenko-tsdoc.vercel.sh/api/) for more details.
67
+ See [API](https://otel.vercel.sh/api/) for more details.
63
68
 
64
69
  ## 📝 Changelog
65
70
 
66
- See [CHANGELOG.md](https://otel-site-git-dimavoytenko-tsdoc.vercel.sh/CHANGELOG.md).
71
+ See [CHANGELOG.md](https://otel.vercel.sh/CHANGELOG.md).
67
72
 
68
73
  ## 🔗 References
69
74
 
@@ -74,7 +79,7 @@ See [CHANGELOG.md](https://otel-site-git-dimavoytenko-tsdoc.vercel.sh/CHANGELOG.
74
79
 
75
80
  ## 📄 License
76
81
 
77
- [MIT](https://otel-site-git-dimavoytenko-tsdoc.vercel.sh/LICENSE)
82
+ [MIT](https://otel.vercel.sh/LICENSE)
78
83
 
79
84
  ---
80
85