@effectstream/log 0.100.15 → 0.100.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +15 -10
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -5,6 +5,11 @@ OpenTelemetry-instrumented structured logging for EffectStream. Wraps
|
|
|
5
5
|
both pretty console output (`log.local`) and OTLP traces/logs to your
|
|
6
6
|
collector (`log.remote`).
|
|
7
7
|
|
|
8
|
+
- OpenTelemetry-instrumented structured logging on top of `tslog`.
|
|
9
|
+
- Pretty console output and OTLP traces / logs from one `log` object.
|
|
10
|
+
- Used by every package in the framework so the node emits one trace tree.
|
|
11
|
+
- `ComponentNames` constants tag log records by component, powering per-component log views.
|
|
12
|
+
|
|
8
13
|
## Install
|
|
9
14
|
|
|
10
15
|
```bash
|
|
@@ -62,16 +67,16 @@ powers the orchestrator's per-component log views.
|
|
|
62
67
|
|
|
63
68
|
## Key exports
|
|
64
69
|
|
|
65
|
-
- `log.local(component, namespace, level, deferred)
|
|
66
|
-
- `log.localForce(...)`
|
|
67
|
-
- `log.remote(...)
|
|
68
|
-
- `log.remoteForce(...)`
|
|
70
|
+
- `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.
|
|
71
|
+
- `log.localForce(...)` bypasses level filtering.
|
|
72
|
+
- `log.remote(...)`: console + OpenTelemetry log record. Same signature as `local`.
|
|
73
|
+
- `log.remoteForce(...)` is `remote` without level filtering.
|
|
69
74
|
- `log.formatMessage(...)` — the formatter used internally; useful for custom transports.
|
|
70
|
-
- `defaultOtelSetup(opts)
|
|
71
|
-
- `attachTransport(transport)`
|
|
72
|
-
- `SeverityNumber
|
|
73
|
-
- `ComponentNames
|
|
74
|
-
- `Namespace
|
|
75
|
+
- `defaultOtelSetup(opts)`: one-call OpenTelemetry SDK setup with sensible defaults.
|
|
76
|
+
- `attachTransport(transport)` registers a custom tslog transport (e.g. ship logs to a file).
|
|
77
|
+
- `SeverityNumber`: re-export of OpenTelemetry severity levels.
|
|
78
|
+
- `ComponentNames`: string-enum constants used to tag logs by component.
|
|
79
|
+
- `Namespace`: `string | string[]` for log namespacing.
|
|
75
80
|
|
|
76
81
|
## Examples
|
|
77
82
|
|
|
@@ -80,4 +85,4 @@ Runnable: [`test/examples.test.ts`](./test/examples.test.ts).
|
|
|
80
85
|
## Links
|
|
81
86
|
|
|
82
87
|
- Docs: https://effectstream.github.io/docs/packages/sdk/log
|
|
83
|
-
- Source: https://github.com/
|
|
88
|
+
- Source: https://github.com/effectstream/effectstream/tree/main/packages/effectstream-sdk/log
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@effectstream/log",
|
|
3
|
-
"version": "0.100.
|
|
3
|
+
"version": "0.100.16",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"homepage": "https://effectstream.github.io/docs/",
|
|
6
6
|
"repository": {
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
},
|
|
14
14
|
"exports": "./src/mod.ts",
|
|
15
15
|
"dependencies": {
|
|
16
|
-
"@effectstream/utils": "0.100.
|
|
16
|
+
"@effectstream/utils": "0.100.16",
|
|
17
17
|
"@opentelemetry/api": "^1.9.0",
|
|
18
18
|
"@opentelemetry/api-logs": "0.56.0",
|
|
19
19
|
"@opentelemetry/exporter-logs-otlp-http": "0.56.0",
|