manifest 5.3.1 → 5.5.0

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 CHANGED
@@ -1,48 +1,44 @@
1
1
  # Manifest
2
2
 
3
- Observability plugin for [OpenClaw](https://github.com/open-claw/open-claw). Collects traces, metrics, and cost data from your AI agent and exports them to [Manifest](https://manifest.build) via OTLP/HTTP.
3
+ Observability plugin for [OpenClaw](https://github.com/open-claw/open-claw). Collects traces, metrics, and cost data from your AI agent and displays them in a local dashboard — zero configuration required.
4
4
 
5
5
  ## Install
6
6
 
7
7
  ```bash
8
8
  openclaw plugins install manifest
9
- openclaw config set plugins.entries.manifest.config.apiKey "mnfst_YOUR_KEY"
10
9
  openclaw gateway restart
11
10
  ```
12
11
 
13
- Or with environment variables:
14
-
15
- ```bash
16
- export MANIFEST_API_KEY=mnfst_YOUR_KEY
17
- ```
12
+ That's it. The plugin starts an embedded server with SQLite at `http://127.0.0.1:2099`. Open that URL to see your dashboard.
18
13
 
19
- ## Local mode
14
+ ### Cloud mode
20
15
 
21
- Run the full Manifest dashboard locally no cloud account needed. Data is stored in SQLite at `~/.openclaw/manifest/`.
16
+ To send telemetry to the hosted platform at [app.manifest.build](https://app.manifest.build) instead:
22
17
 
23
18
  ```bash
24
- openclaw plugins install manifest
25
- openclaw config set plugins.entries.manifest.config.mode "local"
19
+ openclaw config set plugins.entries.manifest.config.mode cloud
20
+ openclaw config set plugins.entries.manifest.config.apiKey "mnfst_YOUR_KEY"
26
21
  openclaw gateway restart
27
22
  ```
28
23
 
29
- Open `http://127.0.0.1:2099` to view the dashboard.
24
+ Or with environment variables:
30
25
 
31
- | Option | Type | Default | Description |
32
- |--------|------|---------|-------------|
33
- | `mode` | string | `cloud` | `local` for embedded server, `cloud` for hosted |
34
- | `port` | number | `2099` | Local server port |
35
- | `host` | string | `127.0.0.1` | Local server bind address |
26
+ ```bash
27
+ export MANIFEST_API_KEY=mnfst_YOUR_KEY
28
+ ```
36
29
 
37
30
  ## Configuration
38
31
 
39
32
  | Option | Type | Default | Description |
40
33
  |--------|------|---------|-------------|
41
- | `apiKey` | string | env `MANIFEST_API_KEY` | Agent API key (`mnfst_*`) |
42
- | `endpoint` | string | `https://app.manifest.build/api/v1/otlp` | OTLP endpoint URL |
34
+ | `mode` | string | `local` | `local` for embedded server + SQLite, `cloud` for app.manifest.build |
35
+ | `apiKey` | string | env `MANIFEST_API_KEY` | Agent API key (`mnfst_*`). Required for cloud mode only. |
36
+ | `endpoint` | string | `https://app.manifest.build/otlp` | OTLP endpoint URL (cloud mode) |
43
37
  | `serviceName` | string | `openclaw-gateway` | OpenTelemetry service name |
44
- | `captureContent` | boolean | `false` | Include message content in spans |
45
- | `metricsIntervalMs` | number | `30000` | Metrics export interval (min 5000ms) |
38
+ | `captureContent` | boolean | `false` | Include message content in spans. Always enabled in local mode. |
39
+ | `metricsIntervalMs` | number | `30000` | Metrics export interval (min 5000ms). 10s in local mode. |
40
+ | `port` | number | `2099` | Local server port (local mode only) |
41
+ | `host` | string | `127.0.0.1` | Local server bind address (local mode only) |
46
42
 
47
43
  Point to a self-hosted instance:
48
44
 
@@ -110,15 +106,14 @@ Local testing:
110
106
 
111
107
  ```bash
112
108
  openclaw plugins install -l ./packages/openclaw-plugin
113
- openclaw config set plugins.entries.manifest.config.apiKey "mnfst_YOUR_KEY"
114
- openclaw config set plugins.entries.manifest.config.endpoint "http://localhost:3001/otlp/v1"
115
109
  openclaw gateway restart
110
+ # Dashboard at http://127.0.0.1:2099
116
111
  ```
117
112
 
118
113
  ## Troubleshooting
119
114
 
120
115
  **No spans appearing?**
121
- - Check your API key starts with `mnfst_`
116
+ - In cloud mode, check your API key starts with `mnfst_`
122
117
  - Verify the endpoint is reachable: `curl -I http://your-endpoint/v1/traces`
123
118
  - Disable `diagnostics-otel` if enabled: `openclaw plugins disable diagnostics-otel`
124
119