@effectstream/grafana-loki 0.100.14 → 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 +45 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# @effectstream/grafana-loki
|
|
2
|
+
|
|
3
|
+
NPM wrapper around [Grafana Loki](https://grafana.com/oss/loki/) — the
|
|
4
|
+
log-aggregation backend EffectStream nodes ship structured logs to in
|
|
5
|
+
local development. Installs a pinned binary into
|
|
6
|
+
`node_modules/.bin/grafana-loki`.
|
|
7
|
+
|
|
8
|
+
- Pinned Grafana Loki binary, the local log backend for `@effectstream/log` output.
|
|
9
|
+
- One-command start via `bunx grafana-loki -config.file=loki.yaml`.
|
|
10
|
+
- Pairs with `@effectstream/grafana-alloy` so traces and logs land in one place.
|
|
11
|
+
- Component-tagged logs queryable from a local Grafana out of the box.
|
|
12
|
+
|
|
13
|
+
## Install
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
bun add @effectstream/grafana-loki
|
|
17
|
+
# or
|
|
18
|
+
npm install @effectstream/grafana-loki
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Standalone usage
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
# Start Loki with a config file
|
|
25
|
+
bunx grafana-loki -config.file=loki.yaml
|
|
26
|
+
|
|
27
|
+
# Or invoke through this package
|
|
28
|
+
bun run --bun @effectstream/grafana-loki/start
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
The package downloads the pinned tarball for your OS/arch on install.
|
|
32
|
+
|
|
33
|
+
## Inside EffectStream
|
|
34
|
+
|
|
35
|
+
The orchestrator's observability step pairs this with
|
|
36
|
+
`@effectstream/grafana-alloy` so logs emitted via `@effectstream/log`
|
|
37
|
+
land in Loki, queryable from a local Grafana. Out of the box you get
|
|
38
|
+
component-tagged (`ComponentNames`) logs without writing any collector
|
|
39
|
+
config.
|
|
40
|
+
|
|
41
|
+
## Links
|
|
42
|
+
|
|
43
|
+
- Docs: https://effectstream.github.io/docs/packages/binaries/grafana-loki
|
|
44
|
+
- Source: https://github.com/effectstream/effectstream/tree/main/packages/binaries/grafana-loki
|
|
45
|
+
- Upstream Grafana Loki: https://grafana.com/oss/loki/
|