@effectstream/log 0.100.15 → 0.100.17

package/README.md

@@ -5,6 +5,11 @@ OpenTelemetry-instrumented structured logging for EffectStream. Wraps
 both pretty console output (`log.local`) and OTLP traces/logs to your
 collector (`log.remote`).
 
+- OpenTelemetry-instrumented structured logging on top of `tslog`.
+- Pretty console output and OTLP traces / logs from one `log` object.
+- Used by every package in the framework so the node emits one trace tree.
+- `ComponentNames` constants tag log records by component, powering per-component log views.
+
 ## Install
 
 ```bash
@@ -26,7 +31,7 @@ import {
   SeverityNumber,
 } from "@effectstream/log";
 
-// Initialize OpenTelemetry once at startup (optional — defaults work too).
+// Initialize OpenTelemetry once at startup (optional - defaults work too).
 defaultOtelSetup({ serviceName: "my-app" });
 
 // Local-only: pretty console output, no OTLP.
@@ -47,7 +52,7 @@ log.remote(
 ```
 
 The deferred `(l) => l(...)` form means message construction is skipped
-entirely when the level is filtered out — handy when log arguments are
+entirely when the level is filtered out - handy when log arguments are
 expensive to format (`JSON.stringify` of a big object).
 
 Point the SDK at any OTLP-compatible collector (Grafana Alloy, Tempo,
@@ -55,23 +60,23 @@ Honeycomb, …) via the standard `OTEL_EXPORTER_OTLP_ENDPOINT` env var.
 
 ## Inside EffectStream
 
-Every package in the framework — sync, runtime, batcher, sm — logs through
+Every package in the framework - sync, runtime, batcher, sm - logs through
 this module so the whole node emits one consistent trace tree. The
 `ComponentNames` constants tag log records by component, which is what
 powers the orchestrator's per-component log views.
 
 ## Key exports
 
-- `log.local(component, namespace, level, deferred)` — console-only logging. `level` is `SeverityNumber`; `deferred = (l) => l(...args)` is called only if the level passes the filter.
-- `log.localForce(...)` — bypasses level filtering.
-- `log.remote(...)` — console + OpenTelemetry log record. Same signature as `local`.
-- `log.remoteForce(...)` — `remote` without level filtering.
-- `log.formatMessage(...)` — the formatter used internally; useful for custom transports.
-- `defaultOtelSetup(opts)` — one-call OpenTelemetry SDK setup with sensible defaults.
-- `attachTransport(transport)` — register a custom tslog transport (e.g. ship logs to a file).
-- `SeverityNumber` — re-export of OpenTelemetry severity levels.
-- `ComponentNames` — string-enum constants used to tag logs by component.
-- `Namespace` — `string | string[]` for log namespacing.
+- `log.local(component, namespace, level, deferred)`: console-only logging. `level` is `SeverityNumber`; `deferred = (l) => l(...args)` is called only if the level passes the filter.
+- `log.localForce(...)` bypasses level filtering.
+- `log.remote(...)`: console + OpenTelemetry log record. Same signature as `local`.
+- `log.remoteForce(...)` is `remote` without level filtering.
+- `log.formatMessage(...)` - the formatter used internally; useful for custom transports.
+- `defaultOtelSetup(opts)`: one-call OpenTelemetry SDK setup with sensible defaults.
+- `attachTransport(transport)` registers a custom tslog transport (e.g. ship logs to a file).
+- `SeverityNumber`: re-export of OpenTelemetry severity levels.
+- `ComponentNames`: string-enum constants used to tag logs by component.
+- `Namespace`: `string | string[]` for log namespacing.
 
 ## Examples
 
@@ -80,4 +85,4 @@ Runnable: [`test/examples.test.ts`](./test/examples.test.ts).
 ## Links
 
 - Docs: https://effectstream.github.io/docs/packages/sdk/log
-- Source: https://github.com/PaimaStudios/paima-engine/tree/main/packages/effectstream-sdk/log
+- Source: https://github.com/effectstream/effectstream/tree/main/packages/effectstream-sdk/log

package/package.json

@@ -1,19 +1,19 @@
 {
   "name": "@effectstream/log",
-  "version": "0.100.15",
+  "version": "0.100.17",
   "license": "MIT",
   "homepage": "https://effectstream.github.io/docs/",
   "repository": {
     "type": "git",
-    "url": "https://github.com/PaimaStudios/paima-engine",
+    "url": "https://github.com/effectstream/effectstream",
     "directory": "packages/effectstream-sdk/log"
   },
   "bugs": {
-    "url": "https://github.com/PaimaStudios/paima-engine/issues"
+    "url": "https://github.com/effectstream/effectstream/issues"
   },
   "exports": "./src/mod.ts",
   "dependencies": {
-    "@effectstream/utils": "0.100.15",
+    "@effectstream/utils": "0.100.17",
     "@opentelemetry/api": "^1.9.0",
     "@opentelemetry/api-logs": "0.56.0",
     "@opentelemetry/exporter-logs-otlp-http": "0.56.0",