@effect/opentelemetry 4.0.0-beta.67 → 4.0.0-beta.69

package/dist/Logger.d.ts

@@ -36,7 +36,7 @@ declare const OtelLoggerProvider_base: Context.ServiceClass<OtelLoggerProvider,
 /**
  * Context service containing the OpenTelemetry `LoggerProvider` used to emit Effect log records.
  *
- * @category Services
+ * @category services
  * @since 4.0.0
  */
 export declare class OtelLoggerProvider extends OtelLoggerProvider_base {
@@ -49,21 +49,21 @@ export declare class OtelLoggerProvider extends OtelLoggerProvider_base {
  * (e.g. Info=20000), which falls outside the OTel spec — backends that
  * validate the field map such values to `UNSPECIFIED`.
  *
- * @category Conversions
+ * @category converting
  * @since 4.0.0
  */
 export declare const logLevelToSeverityNumber: (level: LogLevel.LogLevel) => SeverityNumber;
 /**
  * Creates an Effect logger that emits log records through the configured OpenTelemetry logger provider.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export declare const make: Effect.Effect<Logger.Logger<unknown, void>, never, OtelLoggerProvider>;
 /**
  * Creates a layer that installs the OpenTelemetry-backed Effect logger, merging with existing loggers by default.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export declare const layer: (options: {
@@ -81,7 +81,7 @@ export declare const layer: (options: {
 /**
  * Creates a scoped OpenTelemetry logger provider from one or more log record processors, using the current `Resource` and flushing and shutting down the provider when the layer is released.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export declare const layerLoggerProvider: (processor: Otel.LogRecordProcessor | NonEmptyReadonlyArray<Otel.LogRecordProcessor>, config?: Omit<Otel.LoggerProviderConfig, "resource"> & {

package/dist/Logger.js

@@ -38,7 +38,7 @@ import { Resource } from "./Resource.js";
 /**
  * Context service containing the OpenTelemetry `LoggerProvider` used to emit Effect log records.
  *
- * @category Services
+ * @category services
  * @since 4.0.0
  */
 export class OtelLoggerProvider extends /*#__PURE__*/Context.Service()("@effect/opentelemetry/Logger/OtelLoggerProvider") {}
@@ -50,7 +50,7 @@ export class OtelLoggerProvider extends /*#__PURE__*/Context.Service()("@effect/
  * (e.g. Info=20000), which falls outside the OTel spec — backends that
  * validate the field map such values to `UNSPECIFIED`.
  *
- * @category Conversions
+ * @category converting
  * @since 4.0.0
  */
 export const logLevelToSeverityNumber = level => {
@@ -74,7 +74,7 @@ export const logLevelToSeverityNumber = level => {
 /**
  * Creates an Effect logger that emits log records through the configured OpenTelemetry logger provider.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const make = /*#__PURE__*/Effect.gen(function* () {
@@ -112,7 +112,7 @@ export const make = /*#__PURE__*/Effect.gen(function* () {
 /**
  * Creates a layer that installs the OpenTelemetry-backed Effect logger, merging with existing loggers by default.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layer = options => Logger.layer([make], {
@@ -121,7 +121,7 @@ export const layer = options => Logger.layer([make], {
 /**
  * Creates a scoped OpenTelemetry logger provider from one or more log record processors, using the current `Resource` and flushing and shutting down the provider when the layer is released.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layerLoggerProvider = (processor, config) => Layer.effect(OtelLoggerProvider, Effect.gen(function* () {

package/dist/Metrics.d.ts

@@ -35,21 +35,21 @@ import { Resource } from "./Resource.ts";
  * - `delta`: Reports changes since the last export. Each interval is
  *   independent with no dependency on previous measurements.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export type TemporalityPreference = "cumulative" | "delta";
 /**
  * Creates an OpenTelemetry metric producer from Effect metrics.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export declare const makeProducer: (temporality?: TemporalityPreference) => Effect.Effect<MetricProducer, never, Resource>;
 /**
  * Registers a metric producer with one or more metric readers.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export declare const registerProducer: (self: MetricProducer, metricReader: LazyArg<MetricReader | Arr.NonEmptyReadonlyArray<MetricReader>>, options?: {
@@ -83,7 +83,7 @@ export declare const registerProducer: (self: MetricProducer, metricReader: Lazy
  * )
  * ```
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export declare const layer: (evaluate: LazyArg<MetricReader | Arr.NonEmptyReadonlyArray<MetricReader>>, options?: {

package/dist/Metrics.js

@@ -5,7 +5,7 @@ import { Resource } from "./Resource.js";
 /**
  * Creates an OpenTelemetry metric producer from Effect metrics.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const makeProducer = temporality => Effect.gen(function* () {
@@ -16,7 +16,7 @@ export const makeProducer = temporality => Effect.gen(function* () {
 /**
  * Registers a metric producer with one or more metric readers.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const registerProducer = (self, metricReader, options) => Effect.acquireRelease(Effect.sync(() => {
@@ -53,7 +53,7 @@ export const registerProducer = (self, metricReader, options) => Effect.acquireR
  * )
  * ```
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layer = (evaluate, options) => Layer.effectDiscard(Effect.flatMap(makeProducer(options?.temporality), producer => registerProducer(producer, evaluate, options)));

package/dist/NodeSdk.d.ts

@@ -38,7 +38,7 @@ import * as Tracer from "./Tracer.ts";
 /**
  * Configuration for the Node OpenTelemetry layer, including optional tracing, metrics, logging, resource, and shutdown settings.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface Configuration {
@@ -59,7 +59,7 @@ export interface Configuration {
 /**
  * Creates a scoped Node OpenTelemetry tracer provider from one or more span processors and shuts it down when the layer is released.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export declare const layerTracerProvider: (processor: SpanProcessor | NonEmptyReadonlyArray<SpanProcessor>, config?: Omit<TracerConfig, "resource"> & {
@@ -68,21 +68,21 @@ export declare const layerTracerProvider: (processor: SpanProcessor | NonEmptyRe
 /**
  * Creates a Node OpenTelemetry layer from configuration, enabling tracing, metrics, and logging only when their processors or readers are supplied.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export declare const layer: {
     /**
      * Creates a Node OpenTelemetry layer from configuration, enabling tracing, metrics, and logging only when their processors or readers are supplied.
      *
-     * @category Layers
+     * @category layers
      * @since 4.0.0
      */
     (evaluate: LazyArg<Configuration>): Layer.Layer<Resource.Resource>;
     /**
      * Creates a Node OpenTelemetry layer from configuration, enabling tracing, metrics, and logging only when their processors or readers are supplied.
      *
-     * @category Layers
+     * @category layers
      * @since 4.0.0
      */
     <R, E>(evaluate: Effect.Effect<Configuration, E, R>): Layer.Layer<Resource.Resource, E, R>;
@@ -90,7 +90,7 @@ export declare const layer: {
 /**
  * Layer that provides an empty OpenTelemetry `Resource`.
  *
- * @category layer
+ * @category layers
  * @since 2.0.0
  */
 export declare const layerEmpty: Layer.Layer<Resource.Resource>;

package/dist/NodeSdk.js

@@ -10,7 +10,7 @@ import * as Tracer from "./Tracer.js";
 /**
  * Creates a scoped Node OpenTelemetry tracer provider from one or more span processors and shuts it down when the layer is released.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layerTracerProvider = (processor, config) => Layer.effect(Tracer.OtelTracerProvider, Effect.gen(function* () {
@@ -27,7 +27,7 @@ export const layerTracerProvider = (processor, config) => Layer.effect(Tracer.Ot
 /**
  * Creates a Node OpenTelemetry layer from configuration, enabling tracing, metrics, and logging only when their processors or readers are supplied.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layer = evaluate => Layer.unwrap(Effect.gen(function* () {
@@ -52,7 +52,7 @@ export const layer = evaluate => Layer.unwrap(Effect.gen(function* () {
 /**
  * Layer that provides an empty OpenTelemetry `Resource`.
  *
- * @category layer
+ * @category layers
  * @since 2.0.0
  */
 export const layerEmpty = Resource.layerEmpty;

package/dist/Resource.d.ts

@@ -26,7 +26,7 @@ declare const Resource_base: Context.ServiceClass<Resource, "@effect/opentelemet
 /**
  * Context service containing the OpenTelemetry `Resource` associated with emitted telemetry.
  *
- * @category Services
+ * @category services
  * @since 4.0.0
  */
 export declare class Resource extends Resource_base {
@@ -34,7 +34,7 @@ export declare class Resource extends Resource_base {
 /**
  * Creates a `Resource` layer from service metadata and additional OpenTelemetry attributes.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export declare const layer: (config: {
@@ -45,7 +45,7 @@ export declare const layer: (config: {
 /**
  * Converts resource configuration into OpenTelemetry attributes, adding service name, optional service version, and telemetry SDK metadata.
  *
- * @category Configuration
+ * @category configuration
  * @since 4.0.0
  */
 export declare const configToAttributes: (options: {
@@ -56,14 +56,14 @@ export declare const configToAttributes: (options: {
 /**
  * Creates a `Resource` layer from OpenTelemetry environment variables, optionally merging additional attributes.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export declare const layerFromEnv: (additionalAttributes?: OtelApi.Attributes | undefined) => Layer.Layer<Resource>;
 /**
  * Layer that provides an empty OpenTelemetry resource.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export declare const layerEmpty: Layer.Layer<Resource, never, never>;

package/dist/Resource.js

@@ -8,21 +8,21 @@ import * as Layer from "effect/Layer";
 /**
  * Context service containing the OpenTelemetry `Resource` associated with emitted telemetry.
  *
- * @category Services
+ * @category services
  * @since 4.0.0
  */
 export class Resource extends /*#__PURE__*/Context.Service()("@effect/opentelemetry/Resource") {}
 /**
  * Creates a `Resource` layer from service metadata and additional OpenTelemetry attributes.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layer = config => Layer.succeed(Resource, Resources.resourceFromAttributes(configToAttributes(config)));
 /**
  * Converts resource configuration into OpenTelemetry attributes, adding service name, optional service version, and telemetry SDK metadata.
  *
- * @category Configuration
+ * @category configuration
  * @since 4.0.0
  */
 export const configToAttributes = options => {
@@ -40,7 +40,7 @@ export const configToAttributes = options => {
 /**
  * Creates a `Resource` layer from OpenTelemetry environment variables, optionally merging additional attributes.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layerFromEnv = additionalAttributes => Layer.effect(Resource, Effect.gen(function* () {
@@ -67,7 +67,7 @@ export const layerFromEnv = additionalAttributes => Layer.effect(Resource, Effec
 /**
  * Layer that provides an empty OpenTelemetry resource.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layerEmpty = /*#__PURE__*/Layer.succeed(Resource, /*#__PURE__*/Resources.emptyResource());

package/dist/Tracer.d.ts

@@ -29,7 +29,7 @@ declare const OtelTracer_base: Context.ServiceClass<OtelTracer, "@effect/opentel
 /**
  * Context service containing the OpenTelemetry `Tracer` used to create spans for Effect tracing.
  *
- * @category Services
+ * @category services
  * @since 4.0.0
  */
 export declare class OtelTracer extends OtelTracer_base {
@@ -38,7 +38,7 @@ declare const OtelTracerProvider_base: Context.ServiceClass<OtelTracerProvider,
 /**
  * Context service containing the OpenTelemetry `TracerProvider` used to obtain tracers.
  *
- * @category Services
+ * @category services
  * @since 4.0.0
  */
 export declare class OtelTracerProvider extends OtelTracerProvider_base {
@@ -47,7 +47,7 @@ declare const OtelTraceFlags_base: Context.ServiceClass<OtelTraceFlags, "@effect
 /**
  * Context service containing OpenTelemetry trace flags used when constructing external span contexts.
  *
- * @category Services
+ * @category services
  * @since 4.0.0
  */
 export declare class OtelTraceFlags extends OtelTraceFlags_base {
@@ -56,7 +56,7 @@ declare const OtelTraceState_base: Context.ServiceClass<OtelTraceState, "@effect
 /**
  * Context service containing OpenTelemetry trace state used when constructing external span contexts.
  *
- * @category Services
+ * @category services
  * @since 4.0.0
  */
 export declare class OtelTraceState extends OtelTraceState_base {
@@ -64,14 +64,14 @@ export declare class OtelTraceState extends OtelTraceState_base {
 /**
  * Creates an Effect `Tracer` implementation backed by the configured OpenTelemetry tracer.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export declare const make: Effect.Effect<Tracer.Tracer, never, OtelTracer>;
 /**
  * Creates an Effect external span from an OpenTelemetry span context, preserving trace flags and trace state when provided.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export declare const makeExternalSpan: (options: {
@@ -83,42 +83,42 @@ export declare const makeExternalSpan: (options: {
 /**
  * Layer that provides the current global OpenTelemetry tracer provider.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export declare const layerGlobalProvider: Layer.Layer<OtelTracerProvider>;
 /**
  * Layer that creates an OpenTelemetry tracer from the provided tracer provider and resource metadata.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export declare const layerTracer: Layer.Layer<OtelTracer, never, OtelTracerProvider | Resource>;
 /**
  * Layer that creates an OpenTelemetry tracer from the global tracer provider and the current resource.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export declare const layerGlobalTracer: Layer.Layer<OtelTracer, never, Resource>;
 /**
  * Layer that installs an Effect tracer backed by the global OpenTelemetry tracer provider.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export declare const layerGlobal: Layer.Layer<OtelTracer, never, Resource>;
 /**
  * Layer that installs the Effect tracer using an `OtelTracer` already provided in the environment.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export declare const layerWithoutOtelTracer: Layer.Layer<never, never, OtelTracer>;
 /**
  * Layer that creates an OpenTelemetry tracer from a provider and resource, then installs it as the Effect tracer.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export declare const layer: Layer.Layer<OtelTracer, never, OtelTracerProvider | Resource>;

package/dist/Tracer.js

@@ -37,28 +37,28 @@ import { Resource } from "./Resource.js";
 /**
  * Context service containing the OpenTelemetry `Tracer` used to create spans for Effect tracing.
  *
- * @category Services
+ * @category services
  * @since 4.0.0
  */
 export class OtelTracer extends /*#__PURE__*/Context.Service()("@effect/opentelemetry/Tracer") {}
 /**
  * Context service containing the OpenTelemetry `TracerProvider` used to obtain tracers.
  *
- * @category Services
+ * @category services
  * @since 4.0.0
  */
 export class OtelTracerProvider extends /*#__PURE__*/Context.Service()("@effect/opentelemetry/Tracer/OtelTracerProvider") {}
 /**
  * Context service containing OpenTelemetry trace flags used when constructing external span contexts.
  *
- * @category Services
+ * @category services
  * @since 4.0.0
  */
 export class OtelTraceFlags extends /*#__PURE__*/Context.Service()("@effect/opentelemetry/Tracer/OtelTraceFlags") {}
 /**
  * Context service containing OpenTelemetry trace state used when constructing external span contexts.
  *
- * @category Services
+ * @category services
  * @since 4.0.0
  */
 export class OtelTraceState extends /*#__PURE__*/Context.Service()("@effect/opentelemetry/Tracer/OtelTraceState") {}
@@ -68,7 +68,7 @@ export class OtelTraceState extends /*#__PURE__*/Context.Service()("@effect/open
 /**
  * Creates an Effect `Tracer` implementation backed by the configured OpenTelemetry tracer.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const make = /*#__PURE__*/Effect.map(/*#__PURE__*/Effect.service(OtelTracer), tracer => Tracer.make({
@@ -86,7 +86,7 @@ export const make = /*#__PURE__*/Effect.map(/*#__PURE__*/Effect.service(OtelTrac
 /**
  * Creates an Effect external span from an OpenTelemetry span context, preserving trace flags and trace state when provided.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const makeExternalSpan = options => {
@@ -120,14 +120,14 @@ export const makeExternalSpan = options => {
 /**
  * Layer that provides the current global OpenTelemetry tracer provider.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layerGlobalProvider = /*#__PURE__*/Layer.sync(OtelTracerProvider, () => Otel.trace.getTracerProvider());
 /**
  * Layer that creates an OpenTelemetry tracer from the provided tracer provider and resource metadata.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layerTracer = /*#__PURE__*/Layer.effect(OtelTracer, /*#__PURE__*/Effect.gen(function* () {
@@ -138,28 +138,28 @@ export const layerTracer = /*#__PURE__*/Layer.effect(OtelTracer, /*#__PURE__*/Ef
 /**
  * Layer that creates an OpenTelemetry tracer from the global tracer provider and the current resource.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layerGlobalTracer = /*#__PURE__*/layerTracer.pipe(/*#__PURE__*/Layer.provide(layerGlobalProvider));
 /**
  * Layer that installs an Effect tracer backed by the global OpenTelemetry tracer provider.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layerGlobal = /*#__PURE__*/Layer.effect(Tracer.Tracer, make).pipe(/*#__PURE__*/Layer.provideMerge(layerGlobalTracer));
 /**
  * Layer that installs the Effect tracer using an `OtelTracer` already provided in the environment.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layerWithoutOtelTracer = /*#__PURE__*/Layer.effect(Tracer.Tracer, make);
 /**
  * Layer that creates an OpenTelemetry tracer from a provider and resource, then installs it as the Effect tracer.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layer = /*#__PURE__*/layerWithoutOtelTracer.pipe(/*#__PURE__*/Layer.provideMerge(layerTracer));

package/dist/WebSdk.d.ts

@@ -41,7 +41,7 @@ import * as Tracer from "./Tracer.ts";
 /**
  * Configuration for the Web OpenTelemetry layer, including resource metadata and optional tracing, metrics, and logging settings.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface Configuration {
@@ -61,28 +61,28 @@ export interface Configuration {
 /**
  * Creates a scoped Web OpenTelemetry tracer provider from one or more span processors and shuts it down when the layer is released.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export declare const layerTracerProvider: (processor: SpanProcessor | NonEmptyReadonlyArray<SpanProcessor>, config?: Omit<TracerConfig, "resource">) => Layer.Layer<Tracer.OtelTracerProvider, never, Resource.Resource>;
 /**
  * Creates a Web OpenTelemetry layer from configuration, providing the resource and enabling tracing, metrics, and logging when configured.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export declare const layer: {
     /**
      * Creates a Web OpenTelemetry layer from configuration, providing the resource and enabling tracing, metrics, and logging when configured.
      *
-     * @category Layers
+     * @category layers
      * @since 4.0.0
      */
     (evaluate: LazyArg<Configuration>): Layer.Layer<Resource.Resource>;
     /**
      * Creates a Web OpenTelemetry layer from configuration, providing the resource and enabling tracing, metrics, and logging when configured.
      *
-     * @category Layers
+     * @category layers
      * @since 4.0.0
      */
     <E, R>(evaluate: Effect.Effect<Configuration, E, R>): Layer.Layer<Resource.Resource, E, R>;

package/dist/WebSdk.js

@@ -10,7 +10,7 @@ import * as Tracer from "./Tracer.js";
 /**
  * Creates a scoped Web OpenTelemetry tracer provider from one or more span processors and shuts it down when the layer is released.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layerTracerProvider = (processor, config) => Layer.effect(Tracer.OtelTracerProvider, Effect.gen(function* () {
@@ -27,7 +27,7 @@ export const layerTracerProvider = (processor, config) => Layer.effect(Tracer.Ot
 /**
  * Creates a Web OpenTelemetry layer from configuration, providing the resource and enabling tracing, metrics, and logging when configured.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layer = evaluate => Layer.unwrap(Effect.gen(function* () {