@effect/opentelemetry 4.0.0-beta.8 → 4.0.0-beta.81

package/src/WebSdk.ts

@@ -1,5 +1,13 @@
 /**
- * @since 1.0.0
+ * Browser OpenTelemetry setup for Effect applications.
+ *
+ * This module exports a `Configuration` type and layers for installing
+ * tracing, metrics, and logging in browser runtimes. The main `layer` builds
+ * the shared OpenTelemetry resource from explicit service metadata, then
+ * enables only the signal types that have processors or readers configured.
+ * `layerTracerProvider` creates a scoped `WebTracerProvider`.
+ *
+ * @since 4.0.0
  */
 import type * as Otel from "@opentelemetry/api"
 import type { LoggerProviderConfig, LogRecordProcessor } from "@opentelemetry/sdk-logs"
@@ -17,8 +25,10 @@ import * as Resource from "./Resource.ts"
 import * as Tracer from "./Tracer.ts"
 
 /**
- * @since 1.0.0
- * @category Models
+ * Configuration for the Web OpenTelemetry layer, including resource metadata and optional tracing, metrics, and logging settings.
+ *
+ * @category models
+ * @since 4.0.0
  */
 export interface Configuration {
   readonly spanProcessor?: SpanProcessor | ReadonlyArray<SpanProcessor> | undefined
@@ -36,8 +46,10 @@ export interface Configuration {
 }
 
 /**
- * @since 1.0.0
- * @category Layers
+ * Creates a scoped Web OpenTelemetry tracer provider from one or more span processors and shuts it down when the layer is released.
+ *
+ * @category layers
+ * @since 4.0.0
  */
 export const layerTracerProvider = (
   processor: SpanProcessor | NonEmptyReadonlyArray<SpanProcessor>,
@@ -65,18 +77,75 @@ export const layerTracerProvider = (
   )
 
 /**
- * @since 1.0.0
- * @category Layers
+ * Creates a Web OpenTelemetry layer from configuration, providing the resource and enabling tracing, metrics, and logging when configured.
+ *
+ * **When to use**
+ *
+ * Use to install browser OpenTelemetry support when service metadata is
+ * configured in code and telemetry processors or readers are supplied directly.
+ *
+ * **Details**
+ *
+ * The configuration can be provided lazily or effectfully. The layer always
+ * provides `Resource.Resource`; tracing, metrics, and logging are installed only
+ * when the corresponding processors or readers are non-empty.
+ *
+ * **Gotchas**
+ *
+ * Browser resource metadata is explicit; this layer does not read
+ * OpenTelemetry environment variables. Empty processor or reader arrays are
+ * treated as not configured.
+ *
+ * @category layers
+ * @since 4.0.0
  */
 export const layer: {
   /**
-   * @since 1.0.0
-   * @category Layers
+   * Creates a Web OpenTelemetry layer from configuration, providing the resource and enabling tracing, metrics, and logging when configured.
+   *
+   * **When to use**
+   *
+   * Use to install browser OpenTelemetry support when service metadata is
+   * configured in code and telemetry processors or readers are supplied directly.
+   *
+   * **Details**
+   *
+   * The configuration can be provided lazily or effectfully. The layer always
+   * provides `Resource.Resource`; tracing, metrics, and logging are installed only
+   * when the corresponding processors or readers are non-empty.
+   *
+   * **Gotchas**
+   *
+   * Browser resource metadata is explicit; this layer does not read
+   * OpenTelemetry environment variables. Empty processor or reader arrays are
+   * treated as not configured.
+   *
+   * @category layers
+   * @since 4.0.0
    */
   (evaluate: LazyArg<Configuration>): Layer.Layer<Resource.Resource>
   /**
-   * @since 1.0.0
-   * @category Layers
+   * Creates a Web OpenTelemetry layer from configuration, providing the resource and enabling tracing, metrics, and logging when configured.
+   *
+   * **When to use**
+   *
+   * Use to install browser OpenTelemetry support when service metadata is
+   * configured in code and telemetry processors or readers are supplied directly.
+   *
+   * **Details**
+   *
+   * The configuration can be provided lazily or effectfully. The layer always
+   * provides `Resource.Resource`; tracing, metrics, and logging are installed only
+   * when the corresponding processors or readers are non-empty.
+   *
+   * **Gotchas**
+   *
+   * Browser resource metadata is explicit; this layer does not read
+   * OpenTelemetry environment variables. Empty processor or reader arrays are
+   * treated as not configured.
+   *
+   * @category layers
+   * @since 4.0.0
    */
   <E, R>(evaluate: Effect.Effect<Configuration, E, R>): Layer.Layer<Resource.Resource, E, R>
 } = (

package/src/index.ts

@@ -1,35 +1,35 @@
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 
 // @barrel: Auto-generated exports. Do not edit manually.
 
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as Logger from "./Logger.ts"
 
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as Metrics from "./Metrics.ts"
 
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as NodeSdk from "./NodeSdk.ts"
 
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as Resource from "./Resource.ts"
 
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as Tracer from "./Tracer.ts"
 
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as WebSdk from "./WebSdk.ts"

package/src/internal/attributes.ts

@@ -1,6 +1,13 @@
 import type * as Otel from "@opentelemetry/api"
 import * as Inspectable from "effect/Inspectable"
 
+const bigint1e9 = BigInt(1_000_000_000)
+
+/** @internal */
+export const nanosToHrTime = (timestamp: bigint): Otel.HrTime => {
+  return [Number(timestamp / bigint1e9), Number(timestamp % bigint1e9)]
+}
+
 /** @internal */
 export const recordToAttributes = (record: Record<string, unknown>): Otel.Attributes => {
   const attributes: Otel.Attributes = {}

package/src/internal/metrics.ts

@@ -11,8 +11,8 @@ import type {
 import { AggregationTemporality, DataPointType, InstrumentType } from "@opentelemetry/sdk-metrics"
 import type { InstrumentDescriptor } from "@opentelemetry/sdk-metrics/build/src/InstrumentDescriptor.js"
 import * as Arr from "effect/Array"
+import type * as Context from "effect/Context"
 import * as Metric from "effect/Metric"
-import type * as ServiceMap from "effect/ServiceMap"
 import type * as Metrics from "../Metrics.ts"
 
 const sdkName = "@effect/opentelemetry/Metrics"
@@ -37,7 +37,7 @@ interface PreviousSummaryState {
 /** @internal */
 export class MetricProducerImpl implements MetricProducer {
   resource: Resources.Resource
-  services: ServiceMap.ServiceMap<never>
+  context: Context.Context<never>
   temporality: Metrics.TemporalityPreference
   startTimes: Map<string, HrTime>
   startTimeNanos: HrTime
@@ -49,11 +49,11 @@ export class MetricProducerImpl implements MetricProducer {
 
   constructor(
     resource: Resources.Resource,
-    services: ServiceMap.ServiceMap<never>,
+    context: Context.Context<never>,
     temporality: Metrics.TemporalityPreference = "cumulative"
   ) {
     this.resource = resource
-    this.services = services
+    this.context = context
     this.temporality = temporality
     this.startTimes = new Map()
     this.startTimeNanos = currentHrTime()
@@ -73,7 +73,7 @@ export class MetricProducerImpl implements MetricProducer {
   }
 
   collect(_options?: MetricCollectOptions): Promise<CollectionResult> {
-    const snapshot = Metric.snapshotUnsafe(this.services)
+    const snapshot = Metric.snapshotUnsafe(this.context)
     const hrTimeNow = currentHrTime()
     const metricData: Array<MetricData> = []
     const metricDataByName = new Map<string, MetricData>()
@@ -111,7 +111,7 @@ export class MetricProducerImpl implements MetricProducer {
               if (typeof currentCount === "bigint" && typeof previousCount === "bigint") {
                 reportValue = currentCount - previousCount
                 // Handle reset: if current < previous, report current value
-                if (reportValue < 0n) {
+                if (reportValue < BigInt(0)) {
                   reportValue = currentCount
                 }
               } else {