How to Set Up the Manifest Observability Plugin for OpenClaw Agents –
Step‑by‑Step Guide
OpenClaw is a flexible agent framework that lets you extend functionality
through plugins. One of the most useful plugins is the Manifest observability
plugin, which enables you to send telemetry data from your agents to the
Manifest platform. This guide walks you through the entire process of
installing, configuring, and verifying the Manifest plugin, so you can start
monitoring your OpenClaw deployments with confidence.
What Is the Manifest Plugin?
The Manifest plugin is an OpenClaw extension that integrates the OpenTelemetry
(OTel) SDK with the Manifest backend. Once installed, the plugin collects
metrics, traces, and logs from the agent and forwards them to a Manifest
endpoint using the OTLP protocol. This gives you visibility into agent
performance, error rates, and resource usage without writing custom
instrumentation code.
Key capabilities of the Manifest plugin include:
- Automatic collection of process and runtime metrics
- Trace propagation for distributed systems
- Log forwarding with structured fields
- Configurable API key and endpoint for self‑hosted Manifest instances
- Health checks that confirm the plugin is active
Prerequisites
Before you begin, make sure you have the following:
- OpenClaw CLI installed and available in your PATH
- Access to a Manifest account (you can sign up at https://app.manifest.build)
- Basic familiarity with terminal commands
Step 1 – Stop the Gateway
Changing plugin configuration while the gateway is running can cause
hot‑reload issues. To avoid problems, stop the gateway first.
Run the command below and confirm you want to proceed:
openclaw gateway stop
You should see output indicating the gateway has stopped. If you receive an
error, verify that the OpenClaw service is actually running by checking
openclaw gateway status.
Step 2 – Install the Manifest Plugin
With the gateway stopped, install the plugin from the official OpenClaw plugin
repository.
Execute the following command and confirm:
openclaw plugins install manifest
The CLI will download the plugin package, place it in the appropriate plugins
directory, and register it in your ~/.openclaw/openclaw.json configuration
file. If the installation fails, ensure that:
- OpenClaw is correctly installed
- The
openclawcommand is in your system PATH - You have network access to the plugin registry
Step 3 – Obtain a Manifest API Key
The Manifest plugin authenticates with the Manifest backend using an API key.
You need to create one in the Manifest UI.
- Navigate to https://app.manifest.build and log in (or create a new account).
- Once logged in, click the "Connect Agent" button.
- Manifest will generate a new API key that starts with the prefix
mnfst_. - Copy the key to your clipboard.
When you return to the terminal, paste the key when prompted. The system will
validate that the key begins with mnfst_. If the format looks incorrect, you
will be asked to try again.
Note: The API key is stored securely in ~/.openclaw/openclaw.json under
the path plugins.entries.manifest.config.apiKey. It persists on disk until
you manually remove it.
Step 4 – Configure the Plugin with Your API Key
Now that you have the key, configure the plugin to use it.
Run the following command, replacing USER_API_KEY with the actual key you
copied:
openclaw config set plugins.entries.manifest.config.apiKey 'USER_API_KEY'
Confirm the change when prompted.
Optional: If you are using a self‑hosted Manifest instance or a custom
endpoint, you can override the default URL. The default endpoint is
https://app.manifest.build/api/v1/otlp. To set a custom endpoint, execute:
openclaw config set plugins.entries.manifest.config.endpoint 'YOUR_ENDPOINT_URL'
Again, confirm the change. If you do not specify an endpoint, the plugin will
automatically use the default Manifest cloud URL.
Step 5 – Restart the Gateway
With the configuration saved, restart the OpenClaw gateway to load the new
plugin settings.
Run the command and confirm:
openclaw gateway restart
The gateway will shut down, load the Manifest plugin, and start up again. This
process usually takes a few seconds.
Step 6 – Verify the Installation
After the gateway has restarted, give it a moment to fully initialize (about
three seconds). Then check the gateway logs for signs that the Manifest plugin
is active.
Execute the following command to filter the log for Manifest entries:
grep 'manifest' ~/.openclaw/logs/gateway.log | tail -5
Look for a line similar to:
[manifest] Observability pipeline active
If you see this message, the plugin has successfully connected to Manifest and
is ready to receive telemetry.
If the line does not appear, examine the preceding log lines for error
messages. Common issues include:
- Missing apiKey – Return to Step 4 and ensure the API key is set correctly.
-
Invalid apiKey format – The key must start with
mnfst_. Re‑obtain a valid key from the Manifest UI. - Connection refused – The endpoint URL is unreachable. Verify your network connectivity and that the Manifest service is reachable.
-
Duplicate OTel registration – Another plugin (such as the built‑in diagnostics‑otel) may be registering the same OTel components. Disable the conflicting plugin with:
openclaw plugins disable diagnostics-otel
After making any necessary changes, repeat Step 5 and Step 6.
Troubleshooting Tips
Here are some additional tips to help you resolve common problems:
- Ensure your system clock is synchronized; significant time drift can cause authentication failures with Manifest.
- If you are behind a proxy, configure the
HTTPS_PROXYenvironment variable before running the OpenClaw CLI. - For detailed debug output, run the gateway with increased verbosity:
openclaw gateway start --verbose. - Check the Manifest dashboard for incoming spans and metrics; if nothing appears, double‑check that your agent is actually generating telemetry (e.g., by making a request that triggers internal instrumentation).
Why Use the Manifest Plugin?
Integrating Manifest with OpenClaw brings several advantages:
- Unified observability: Metrics, traces, and logs are all sent to a single backend, simplifying correlation.
- Zero‑code instrumentation: The plugin automatically instruments common libraries and runtime components.
- Scalable backend: Manifest is designed to handle high volumes of telemetry data, making it suitable for production workloads.
- OpenTelemetry compatibility: Because Manifest accepts OTLP, you can later switch to other OTel‑compatible backends without changing your agent code.
Conclusion
Setting up the Manifest observability plugin for OpenClaw is a straightforward
process that yields powerful insights into your agents’ behavior. By following
the six steps outlined above—stopping the gateway, installing the plugin,
obtaining and configuring an API key, optionally setting a custom endpoint,
restarting the gateway, and verifying the activation—you can have telemetry
flowing to Manifest in just a few minutes.
Once the plugin is active, you can leverage Manifest’s dashboards, alerts, and
query capabilities to monitor performance, detect anomalies, and improve the
reliability of your OpenClaw‑based services. Should you encounter any issues,
refer to the troubleshooting section or consult the OpenClaw and Manifest
documentation for further guidance.
Start observing your agents today and take full advantage of the observability
stack that Manifest provides.
Skill can be found at:
https://github.com/openclaw/skills/tree/main/skills/sebconejo/manifest/SKILL.md
Top comments (0)