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

package/dist/index.d.ts

@@ -2,26 +2,145 @@
  * @since 4.0.0
  */
 /**
+ * Connects Effect's logging system to the OpenTelemetry Logs SDK.
+ *
+ * This module provides a logger provider service, an Effect `Logger` that
+ * emits OpenTelemetry log records, and layers for installing that logger in an
+ * application. It is commonly used to send Effect logs to OTLP, console, or
+ * vendor-specific exporters through OpenTelemetry `LogRecordProcessor`s while
+ * keeping logs correlated with Effect fibers and spans. Emitted records include
+ * the current fiber id, span identifiers when a parent span is present, log
+ * annotations, log spans, severity text, and the matching OpenTelemetry
+ * severity number.
+ *
+ * Log export depends on the configured OpenTelemetry processors and exporters;
+ * this module creates the provider and logger, but does not choose an exporter.
+ * Use the `Resource` layer to attach service and deployment metadata to the
+ * provider rather than repeating that data on every log record. When using
+ * `layerLoggerProvider`, the provider is scoped and is force-flushed and shut
+ * down when the layer is released, with a configurable shutdown timeout. If you
+ * supply or manage an OpenTelemetry provider yourself, make sure it is flushed
+ * and shut down during application shutdown, especially when using batching
+ * processors that may otherwise drop buffered logs.
+ *
  * @since 4.0.0
  */
 export * as Logger from "./Logger.ts";
 /**
+ * Bridges Effect metrics into OpenTelemetry by exposing the current Effect
+ * metric snapshot as an OpenTelemetry `MetricProducer` and registering it with
+ * one or more SDK `MetricReader`s. Use this module when an application already
+ * records metrics with Effect and needs those counters, gauges, histograms,
+ * frequencies, or summaries exported through OTLP, Prometheus, or another
+ * OpenTelemetry-compatible reader/exporter.
+ *
+ * The `layer` constructor is the usual entry point, and is also used by the
+ * Node and Web SDK layers when `metricReader` configuration is supplied. Metric
+ * readers are acquired inside the layer scope and shut down when the scope is
+ * released, so periodic exporters need the runtime to stay alive long enough to
+ * collect and export data. The exporter or backend determines whether
+ * cumulative or delta aggregation is expected; this module defaults to
+ * cumulative temporality and can be configured with `temporality: "delta"` for
+ * backends that require interval-based values.
+ *
  * @since 4.0.0
  */
 export * as Metrics from "./Metrics.ts";
 /**
+ * Provides an Effect layer for configuring OpenTelemetry in Node.js
+ * processes. The module wires the Effect tracer, metrics producer, and logger
+ * into OpenTelemetry SDK providers when span processors, metric readers, or log
+ * record processors are supplied, and it builds the shared resource from
+ * `OTEL_SERVICE_NAME`, `OTEL_RESOURCE_ATTRIBUTES`, and optional explicit
+ * service metadata.
+ *
+ * Use this module in Node services, workers, CLIs, or server runtimes that need
+ * Effect spans, metrics, and logs exported through OpenTelemetry processors and
+ * exporters. Telemetry is enabled only for the configured signal types, so an
+ * application can install tracing alone, metrics alone, logging alone, or any
+ * combination of them from the same layer.
+ *
+ * The layer is scoped. Tracer and logger providers are force-flushed and shut
+ * down when the scope is released, metric readers are shut down with the same
+ * lifecycle, and all shutdown waits are bounded by `shutdownTimeout` with a
+ * default of three seconds. Keep the layer scope alive for the lifetime of the
+ * process and release it during graceful shutdown so batched exporters have a
+ * chance to export final telemetry. When combining this layer with Node
+ * auto-instrumentations, register instrumentation before importing modules that
+ * should be patched, because many Node instrumentations hook module loading.
+ *
  * @since 4.0.0
  */
 export * as NodeSdk from "./NodeSdk.ts";
 /**
+ * Provides the OpenTelemetry resource used by the Effect OpenTelemetry layers.
+ *
+ * A resource describes the entity that produces telemetry, such as a service,
+ * process, deployment, or browser application. The tracing, metrics, logging,
+ * and SDK layers use this module's `Resource` service to configure providers
+ * and identify emitted telemetry with service-level metadata.
+ *
+ * Use `layer` when service metadata is known in code, `layerFromEnv` when
+ * deploying with `OTEL_SERVICE_NAME` and `OTEL_RESOURCE_ATTRIBUTES`, and
+ * `layerEmpty` when no resource attributes should be provided. Resource
+ * attributes are for stable process or service metadata, not per-span or
+ * per-log data. The explicit `layer` helper sets `service.name` and the
+ * `telemetry.sdk.*` attributes after merging custom attributes, so those keys
+ * are controlled by this integration. With `layerFromEnv`, `OTEL_SERVICE_NAME`
+ * overrides `service.name` from `OTEL_RESOURCE_ATTRIBUTES`, and additional
+ * attributes passed to the layer are merged last.
+ *
  * @since 4.0.0
  */
 export * as Resource from "./Resource.ts";
 /**
+ * Bridges Effect tracing into OpenTelemetry by installing an Effect `Tracer`
+ * that creates OpenTelemetry spans, records attributes, events, links, errors,
+ * and status, and keeps OpenTelemetry context active while traced effects run.
+ * Use this module when an application already has an OpenTelemetry
+ * `TracerProvider`, or when the Node and Web SDK layers should expose Effect
+ * spans to OTLP, console, or other OpenTelemetry-compatible exporters.
+ *
+ * The layer constructors wire Effect's tracer service to either the global
+ * OpenTelemetry tracer provider or an explicitly provided `OtelTracer`. This
+ * module does not create exporters or span processors by itself, so spans are
+ * exported only when the provider has been configured by the application or by
+ * the Node/Web SDK layers. Parentage is taken from Effect spans first and can
+ * also attach to the active OpenTelemetry context, while `makeExternalSpan` and
+ * `withSpanContext` are the entry points for continuing an incoming remote
+ * trace. Preserve `traceFlags` and `traceState` when building external spans;
+ * otherwise sampling defaults to sampled and trace state cannot be propagated.
+ *
  * @since 4.0.0
  */
 export * as Tracer from "./Tracer.ts";
 /**
+ * Provides an Effect layer for configuring OpenTelemetry in browser
+ * applications. The module builds a shared resource from explicit service
+ * metadata and wires Effect tracing, metrics, and logging into OpenTelemetry
+ * SDK providers when span processors, metric readers, or log record processors
+ * are supplied.
+ *
+ * Use this module in client-side applications that need Effect spans, metrics,
+ * and logs exported from browser runtimes, such as single-page apps,
+ * multi-page apps with hydrated Effect code, frontend workers, or UI flows
+ * that should be correlated with backend traces. Telemetry is enabled only for
+ * the configured signal types, so tracing, metrics, and logging can be
+ * installed independently from the same layer.
+ *
+ * Browser SDKs cannot rely on process environment resource configuration, so
+ * provide stable service metadata explicitly and use resource attributes for
+ * application, release, deployment, or page-shell identity rather than
+ * per-event data. This module does not create exporters; supply
+ * browser-compatible processors, readers, and exporters yourself, and make sure
+ * their endpoints are reachable from the browser with the required CORS and
+ * authentication behavior. The layer is scoped: tracer providers are
+ * force-flushed and shut down when the scope is released, while metric readers
+ * and logger providers follow their respective layer lifecycles. Keep the
+ * scope alive for the lifetime of the browser application and release it during
+ * application teardown when possible so batched exporters and periodic metric
+ * readers can deliver buffered telemetry before the page is unloaded.
+ *
  * @since 4.0.0
  */
 export * as WebSdk from "./WebSdk.ts";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH;;GAEG;AACH,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AAErC;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;GAEG;AACH,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAA;AAEzC;;GAEG;AACH,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AAErC;;GAEG;AACH,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AAErC;;;;;;;;;;;;;;;;;;GAkBG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAA;AAEzC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AAErC;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA"}

package/dist/index.js

@@ -3,26 +3,145 @@
  */
 // @barrel: Auto-generated exports. Do not edit manually.
 /**
+ * Connects Effect's logging system to the OpenTelemetry Logs SDK.
+ *
+ * This module provides a logger provider service, an Effect `Logger` that
+ * emits OpenTelemetry log records, and layers for installing that logger in an
+ * application. It is commonly used to send Effect logs to OTLP, console, or
+ * vendor-specific exporters through OpenTelemetry `LogRecordProcessor`s while
+ * keeping logs correlated with Effect fibers and spans. Emitted records include
+ * the current fiber id, span identifiers when a parent span is present, log
+ * annotations, log spans, severity text, and the matching OpenTelemetry
+ * severity number.
+ *
+ * Log export depends on the configured OpenTelemetry processors and exporters;
+ * this module creates the provider and logger, but does not choose an exporter.
+ * Use the `Resource` layer to attach service and deployment metadata to the
+ * provider rather than repeating that data on every log record. When using
+ * `layerLoggerProvider`, the provider is scoped and is force-flushed and shut
+ * down when the layer is released, with a configurable shutdown timeout. If you
+ * supply or manage an OpenTelemetry provider yourself, make sure it is flushed
+ * and shut down during application shutdown, especially when using batching
+ * processors that may otherwise drop buffered logs.
+ *
  * @since 4.0.0
  */
 export * as Logger from "./Logger.js";
 /**
+ * Bridges Effect metrics into OpenTelemetry by exposing the current Effect
+ * metric snapshot as an OpenTelemetry `MetricProducer` and registering it with
+ * one or more SDK `MetricReader`s. Use this module when an application already
+ * records metrics with Effect and needs those counters, gauges, histograms,
+ * frequencies, or summaries exported through OTLP, Prometheus, or another
+ * OpenTelemetry-compatible reader/exporter.
+ *
+ * The `layer` constructor is the usual entry point, and is also used by the
+ * Node and Web SDK layers when `metricReader` configuration is supplied. Metric
+ * readers are acquired inside the layer scope and shut down when the scope is
+ * released, so periodic exporters need the runtime to stay alive long enough to
+ * collect and export data. The exporter or backend determines whether
+ * cumulative or delta aggregation is expected; this module defaults to
+ * cumulative temporality and can be configured with `temporality: "delta"` for
+ * backends that require interval-based values.
+ *
  * @since 4.0.0
  */
 export * as Metrics from "./Metrics.js";
 /**
+ * Provides an Effect layer for configuring OpenTelemetry in Node.js
+ * processes. The module wires the Effect tracer, metrics producer, and logger
+ * into OpenTelemetry SDK providers when span processors, metric readers, or log
+ * record processors are supplied, and it builds the shared resource from
+ * `OTEL_SERVICE_NAME`, `OTEL_RESOURCE_ATTRIBUTES`, and optional explicit
+ * service metadata.
+ *
+ * Use this module in Node services, workers, CLIs, or server runtimes that need
+ * Effect spans, metrics, and logs exported through OpenTelemetry processors and
+ * exporters. Telemetry is enabled only for the configured signal types, so an
+ * application can install tracing alone, metrics alone, logging alone, or any
+ * combination of them from the same layer.
+ *
+ * The layer is scoped. Tracer and logger providers are force-flushed and shut
+ * down when the scope is released, metric readers are shut down with the same
+ * lifecycle, and all shutdown waits are bounded by `shutdownTimeout` with a
+ * default of three seconds. Keep the layer scope alive for the lifetime of the
+ * process and release it during graceful shutdown so batched exporters have a
+ * chance to export final telemetry. When combining this layer with Node
+ * auto-instrumentations, register instrumentation before importing modules that
+ * should be patched, because many Node instrumentations hook module loading.
+ *
  * @since 4.0.0
  */
 export * as NodeSdk from "./NodeSdk.js";
 /**
+ * Provides the OpenTelemetry resource used by the Effect OpenTelemetry layers.
+ *
+ * A resource describes the entity that produces telemetry, such as a service,
+ * process, deployment, or browser application. The tracing, metrics, logging,
+ * and SDK layers use this module's `Resource` service to configure providers
+ * and identify emitted telemetry with service-level metadata.
+ *
+ * Use `layer` when service metadata is known in code, `layerFromEnv` when
+ * deploying with `OTEL_SERVICE_NAME` and `OTEL_RESOURCE_ATTRIBUTES`, and
+ * `layerEmpty` when no resource attributes should be provided. Resource
+ * attributes are for stable process or service metadata, not per-span or
+ * per-log data. The explicit `layer` helper sets `service.name` and the
+ * `telemetry.sdk.*` attributes after merging custom attributes, so those keys
+ * are controlled by this integration. With `layerFromEnv`, `OTEL_SERVICE_NAME`
+ * overrides `service.name` from `OTEL_RESOURCE_ATTRIBUTES`, and additional
+ * attributes passed to the layer are merged last.
+ *
  * @since 4.0.0
  */
 export * as Resource from "./Resource.js";
 /**
+ * Bridges Effect tracing into OpenTelemetry by installing an Effect `Tracer`
+ * that creates OpenTelemetry spans, records attributes, events, links, errors,
+ * and status, and keeps OpenTelemetry context active while traced effects run.
+ * Use this module when an application already has an OpenTelemetry
+ * `TracerProvider`, or when the Node and Web SDK layers should expose Effect
+ * spans to OTLP, console, or other OpenTelemetry-compatible exporters.
+ *
+ * The layer constructors wire Effect's tracer service to either the global
+ * OpenTelemetry tracer provider or an explicitly provided `OtelTracer`. This
+ * module does not create exporters or span processors by itself, so spans are
+ * exported only when the provider has been configured by the application or by
+ * the Node/Web SDK layers. Parentage is taken from Effect spans first and can
+ * also attach to the active OpenTelemetry context, while `makeExternalSpan` and
+ * `withSpanContext` are the entry points for continuing an incoming remote
+ * trace. Preserve `traceFlags` and `traceState` when building external spans;
+ * otherwise sampling defaults to sampled and trace state cannot be propagated.
+ *
  * @since 4.0.0
  */
 export * as Tracer from "./Tracer.js";
 /**
+ * Provides an Effect layer for configuring OpenTelemetry in browser
+ * applications. The module builds a shared resource from explicit service
+ * metadata and wires Effect tracing, metrics, and logging into OpenTelemetry
+ * SDK providers when span processors, metric readers, or log record processors
+ * are supplied.
+ *
+ * Use this module in client-side applications that need Effect spans, metrics,
+ * and logs exported from browser runtimes, such as single-page apps,
+ * multi-page apps with hydrated Effect code, frontend workers, or UI flows
+ * that should be correlated with backend traces. Telemetry is enabled only for
+ * the configured signal types, so tracing, metrics, and logging can be
+ * installed independently from the same layer.
+ *
+ * Browser SDKs cannot rely on process environment resource configuration, so
+ * provide stable service metadata explicitly and use resource attributes for
+ * application, release, deployment, or page-shell identity rather than
+ * per-event data. This module does not create exporters; supply
+ * browser-compatible processors, readers, and exporters yourself, and make sure
+ * their endpoints are reachable from the browser with the required CORS and
+ * authentication behavior. The layer is scoped: tracer providers are
+ * force-flushed and shut down when the scope is released, while metric readers
+ * and logger providers follow their respective layer lifecycles. Keep the
+ * scope alive for the lifetime of the browser application and release it during
+ * application teardown when possible so batched exporters and periodic metric
+ * readers can deliver buffered telemetry before the page is unloaded.
+ *
  * @since 4.0.0
  */
 export * as WebSdk from "./WebSdk.js";

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["Logger","Metrics","NodeSdk","Resource","Tracer","WebSdk"],"sources":["../src/index.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAIA;AAEA;;;AAGA,OAAO,KAAKA,MAAM,MAAM,aAAa;AAErC;;;AAGA,OAAO,KAAKC,OAAO,MAAM,cAAc;AAEvC;;;AAGA,OAAO,KAAKC,OAAO,MAAM,cAAc;AAEvC;;;AAGA,OAAO,KAAKC,QAAQ,MAAM,eAAe;AAEzC;;;AAGA,OAAO,KAAKC,MAAM,MAAM,aAAa;AAErC;;;AAGA,OAAO,KAAKC,MAAM,MAAM,aAAa","ignoreList":[]}
+{"version":3,"file":"index.js","names":["Logger","Metrics","NodeSdk","Resource","Tracer","WebSdk"],"sources":["../src/index.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAIA;AAEA;;;;;;;;;;;;;;;;;;;;;;;;AAwBA,OAAO,KAAKA,MAAM,MAAM,aAAa;AAErC;;;;;;;;;;;;;;;;;;;AAmBA,OAAO,KAAKC,OAAO,MAAM,cAAc;AAEvC;;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,OAAO,KAAKC,OAAO,MAAM,cAAc;AAEvC;;;;;;;;;;;;;;;;;;;;AAoBA,OAAO,KAAKC,QAAQ,MAAM,eAAe;AAEzC;;;;;;;;;;;;;;;;;;;;AAoBA,OAAO,KAAKC,MAAM,MAAM,aAAa;AAErC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6BA,OAAO,KAAKC,MAAM,MAAM,aAAa","ignoreList":[]}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@effect/opentelemetry",
   "type": "module",
-  "version": "4.0.0-beta.67",
+  "version": "4.0.0-beta.69",
   "license": "MIT",
   "description": "OpenTelemetry integration for Effect",
   "homepage": "https://effect.website",
@@ -63,7 +63,7 @@
     "@opentelemetry/sdk-trace-node": "^2.0.0",
     "@opentelemetry/sdk-trace-web": "^2.0.0",
     "@opentelemetry/semantic-conventions": "^1.33.0",
-    "effect": "^4.0.0-beta.67"
+    "effect": "^4.0.0-beta.69"
   },
   "peerDependenciesMeta": {
     "@opentelemetry/api": {

package/src/Logger.ts

@@ -42,7 +42,7 @@ import { Resource } from "./Resource.ts"
 /**
  * Context service containing the OpenTelemetry `LoggerProvider` used to emit Effect log records.
  *
- * @category Services
+ * @category services
  * @since 4.0.0
  */
 export class OtelLoggerProvider extends Context.Service<
@@ -58,7 +58,7 @@ export class OtelLoggerProvider extends Context.Service<
  * (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: LogLevel.LogLevel): SeverityNumber => {
@@ -83,7 +83,7 @@ export const logLevelToSeverityNumber = (level: LogLevel.LogLevel): SeverityNumb
 /**
  * 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: Effect.Effect<
@@ -131,7 +131,7 @@ export const make: Effect.Effect<
 /**
  * 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: {
@@ -153,7 +153,7 @@ export 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 const layerLoggerProvider = (

package/src/Metrics.ts

@@ -37,7 +37,7 @@ 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"
@@ -45,7 +45,7 @@ export type TemporalityPreference = "cumulative" | "delta"
 /**
  * Creates an OpenTelemetry metric producer from Effect metrics.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const makeProducer = (temporality?: TemporalityPreference): Effect.Effect<MetricProducer, never, Resource> =>
@@ -58,7 +58,7 @@ export const makeProducer = (temporality?: TemporalityPreference): Effect.Effect
 /**
  * Registers a metric producer with one or more metric readers.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const registerProducer = (
@@ -115,7 +115,7 @@ export const registerProducer = (
  * )
  * ```
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layer = (

package/src/NodeSdk.ts

@@ -42,7 +42,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 {
@@ -64,7 +64,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 const layerTracerProvider = (
@@ -99,21 +99,21 @@ export const layerTracerProvider = (
 /**
  * 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: {
   /**
    * 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>
@@ -164,7 +164,7 @@ export const layer: {
 /**
  * Layer that provides an empty OpenTelemetry `Resource`.
  *
- * @category layer
+ * @category layers
  * @since 2.0.0
  */
 export const layerEmpty: Layer.Layer<Resource.Resource> = Resource.layerEmpty

package/src/Resource.ts

@@ -30,7 +30,7 @@ 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 Context.Service<
@@ -41,7 +41,7 @@ export class Resource extends Context.Service<
 /**
  * Creates a `Resource` layer from service metadata and additional OpenTelemetry attributes.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layer = (config: {
@@ -57,7 +57,7 @@ export 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 const configToAttributes = (options: {
@@ -82,7 +82,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 = (
@@ -121,7 +121,7 @@ export const layerFromEnv = (
 /**
  * Layer that provides an empty OpenTelemetry resource.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layerEmpty = Layer.succeed(

package/src/Tracer.ts

@@ -40,7 +40,7 @@ import { Resource } from "./Resource.ts"
 /**
  * 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 Context.Service<
@@ -51,7 +51,7 @@ export class OtelTracer extends Context.Service<
 /**
  * Context service containing the OpenTelemetry `TracerProvider` used to obtain tracers.
  *
- * @category Services
+ * @category services
  * @since 4.0.0
  */
 export class OtelTracerProvider extends Context.Service<
@@ -62,7 +62,7 @@ export class OtelTracerProvider extends Context.Service<
 /**
  * Context service containing OpenTelemetry trace flags used when constructing external span contexts.
  *
- * @category Services
+ * @category services
  * @since 4.0.0
  */
 export class OtelTraceFlags extends Context.Service<
@@ -73,7 +73,7 @@ export class OtelTraceFlags extends Context.Service<
 /**
  * Context service containing OpenTelemetry trace state used when constructing external span contexts.
  *
- * @category Services
+ * @category services
  * @since 4.0.0
  */
 export class OtelTraceState extends Context.Service<
@@ -88,7 +88,7 @@ export class OtelTraceState extends Context.Service<
 /**
  * Creates an Effect `Tracer` implementation backed by the configured OpenTelemetry tracer.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const make: Effect.Effect<Tracer.Tracer, never, OtelTracer> = Effect.map(
@@ -121,7 +121,7 @@ export const make: Effect.Effect<Tracer.Tracer, never, OtelTracer> = Effect.map(
 /**
  * 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: {
@@ -165,7 +165,7 @@ export const makeExternalSpan = (options: {
 /**
  * Layer that provides the current global OpenTelemetry tracer provider.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layerGlobalProvider: Layer.Layer<OtelTracerProvider> = Layer.sync(
@@ -176,7 +176,7 @@ export const layerGlobalProvider: Layer.Layer<OtelTracerProvider> = Layer.sync(
 /**
  * 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: Layer.Layer<OtelTracer, never, OtelTracerProvider | Resource> = Layer.effect(
@@ -194,7 +194,7 @@ export const layerTracer: Layer.Layer<OtelTracer, never, OtelTracerProvider | Re
 /**
  * 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: Layer.Layer<OtelTracer, never, Resource> = layerTracer.pipe(
@@ -204,7 +204,7 @@ export const layerGlobalTracer: Layer.Layer<OtelTracer, never, Resource> = layer
 /**
  * Layer that installs an Effect tracer backed by the global OpenTelemetry tracer provider.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layerGlobal: Layer.Layer<OtelTracer, never, Resource> = Layer.effect(Tracer.Tracer, make).pipe(
@@ -214,7 +214,7 @@ export const layerGlobal: Layer.Layer<OtelTracer, never, Resource> = Layer.effec
 /**
  * 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: Layer.Layer<never, never, OtelTracer> = Layer.effect(Tracer.Tracer, make)
@@ -222,7 +222,7 @@ export const layerWithoutOtelTracer: Layer.Layer<never, never, OtelTracer> = Lay
 /**
  * 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: Layer.Layer<OtelTracer, never, OtelTracerProvider | Resource> = layerWithoutOtelTracer.pipe(

package/src/WebSdk.ts

@@ -45,7 +45,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 {
@@ -66,7 +66,7 @@ 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 const layerTracerProvider = (
@@ -97,21 +97,21 @@ export const layerTracerProvider = (
 /**
  * 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: {
   /**
    * 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>