@smthrs/observability 0.33.0

package/otel-collector-config.yml

@@ -0,0 +1,38 @@
+receivers:
+  otlp:
+    protocols:
+      grpc:
+        endpoint: "0.0.0.0:4317"
+      http:
+        endpoint: "0.0.0.0:4318"
+
+exporters:
+  prometheus:
+    endpoint: "0.0.0.0:8889"
+    namespace: smithers
+  otlp_grpc/tempo:
+    endpoint: "tempo:4317"
+    tls:
+      insecure: true
+  otlp_http/loki:
+    endpoint: "http://loki:3100/otlp"
+
+processors:
+  batch:
+    timeout: 5s
+    send_batch_size: 1024
+
+service:
+  pipelines:
+    metrics:
+      receivers: [otlp]
+      processors: [batch]
+      exporters: [prometheus]
+    traces:
+      receivers: [otlp]
+      processors: [batch]
+      exporters: [otlp_grpc/tempo]
+    logs:
+      receivers: [otlp]
+      processors: [batch]
+      exporters: [otlp_http/loki]

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@smthrs/observability",
+  "version": "0.33.0",
+  "description": "Concrete Smithers metrics, logging, tracing, and observability integrations",
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "import": "./src/index.js",
+      "default": "./src/index.js"
+    },
+    "./metrics": {
+      "types": "./src/metrics/index.d.ts",
+      "import": "./src/metrics/index.js",
+      "default": "./src/metrics/index.js"
+    },
+    "./*": {
+      "types": "./src/index.d.ts",
+      "import": "./src/*.js",
+      "default": "./src/*.js"
+    }
+  },
+  "files": [
+    "src/",
+    "docker-compose.otel.yml",
+    "otel-collector-config.yml",
+    "prometheus/",
+    "tempo/",
+    "loki/",
+    "grafana/"
+  ],
+  "dependencies": {
+    "@effect/opentelemetry": "4.0.0-beta.102",
+    "@effect/platform-bun": "4.0.0-beta.102",
+    "effect": "4.0.0-beta.102"
+  },
+  "devDependencies": {
+    "@types/bun": "latest",
+    "typescript": "~6.0.3"
+  },
+  "scripts": {
+    "build": "rm -f src/index.d.ts src/metrics/index.d.ts src/*-*.d.ts && tsup --dts-only",
+    "test": "bun test tests",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  }
+}

package/prometheus/prometheus.yml

@@ -0,0 +1,8 @@
+global:
+  scrape_interval: 15s
+  evaluation_interval: 15s
+
+scrape_configs:
+  - job_name: "otel-collector"
+    static_configs:
+      - targets: ["otel-collector:8889"]

package/src/MetricName.ts

@@ -0,0 +1 @@
+export type MetricName = string;

package/src/MetricsServiceLive.js

@@ -0,0 +1,9 @@
+import { MetricsService } from "./_coreMetrics.js";
+import { Effect, Layer } from "effect";
+import { metricsServiceAdapter } from "./metrics/index.js";
+import { renderPrometheusMetrics } from "./renderPrometheusMetrics.js";
+/** @type {Layer.Layer<MetricsService, never, never>} */
+export const MetricsServiceLive = Layer.succeed(MetricsService, {
+  ...metricsServiceAdapter,
+  renderPrometheus: () => Effect.sync(renderPrometheusMetrics),
+});

package/src/README.md

@@ -0,0 +1,28 @@
+# @smthrs/observability — src
+
+The concrete observability implementation: Effect-based metrics, logging, and
+tracing services, OTLP layer wiring (`createSmithersObservabilityLayer`,
+`createSmithersOtelLayer`, `createSmithersRuntimeLayer`), the agent-trace
+pipeline (`detectAgentFamily`, `detectCaptureMode`, `_traceEventNormalizers`,
+`_traceRedaction`, the `*ToOtelLogRecord` builders, `_sessionFileResolvers`),
+and Prometheus text rendering.
+
+Conventions: one export per file, with type-only `.ts` sidecars next to the
+`.js` implementations. `package.json` exposes a `./*` wildcard onto `src/`, so
+EVERY file here is an importable public subpath — `packages/engine` imports the
+underscore modules directly (e.g. `observability/_traceEventNormalizers`). Do
+not rename, move, or delete files. `_core*` modules hold shared implementations
+behind the root shim files that `index.js` re-exports. The correlation context
+is dual-tracked (AsyncLocalStorage for imperative reads, FiberRef for Effect
+code) under `_coreCorrelation/`.
+
+Entry points: `index.js` (main export), `metrics/index.js` (the `./metrics`
+subpath), `createSmithersObservabilityLayer.js` (layer composition), and
+`logging.js` (fire-and-forget logs with a pluggable runtime via
+`setSmithersLogRunner`).
+
+Gotchas: `index.d.ts`, `metrics/index.d.ts`, and the hash-suffixed `*-*.d.ts`
+chunks are build artifacts of `tsup --dts-only` (the build script `rm`s them
+first) — never edit them. `correlation.js`'s `updateCurrentCorrelationContext`
+is a deliberately mutating legacy shim, distinct from the Effect version in
+`_coreCorrelation/`.

package/src/ResolvedSmithersObservabilityOptions.ts

@@ -0,0 +1,12 @@
+import type { LogLevel } from "effect";
+import type { SmithersLogFormat } from "./SmithersLogFormat";
+
+export type ResolvedSmithersObservabilityOptions = {
+  readonly enabled: boolean;
+  readonly endpoint: string;
+  readonly headers: Record<string, string> | undefined;
+  readonly serviceName: string;
+  readonly logFormat: SmithersLogFormat;
+  readonly logLevel: LogLevel.LogLevel;
+  readonly installLogger: boolean;
+};