Cloud Monitor:Integrate OpenClaw Applications

Method 1: One-click installation (recommended)

Open a terminal on the machine where OpenClaw is installed, paste the copied installation command, and run it.

curl -fsSL https://arms-apm-cn-hangzhou-pre.oss-cn-hangzhou.aliyuncs.com/openclaw-cms-plugin/install.sh | bash -s -- \
  --endpoint "https://YOUR-ENDPOINT-URL" \
  --x-arms-license-key "YOUR-LICENSE-KEY" \
  --x-arms-project "YOUR-PROJECT" \
  --x-cms-workspace "YOUR-WORKSPACE" \
  --serviceName "YOUR-SERVICE-NAME"

The installation script automatically performs the following actions:

1. Checks the environment for Node.js, npm, and the OpenClaw CLI.

2. Downloads and extracts the openclaw-cms-plugin to the OpenClaw extensions directory.

3. Installs the runtime dependencies for the plugin.

4. Locates the diagnostics-otel extension and automatically installs its dependencies if they are not already installed.

5. Updates the openclaw.json file with the configurations for both plugins.

6. Restarts the gateway to apply the changes.

The following output indicates a successful installation:

[INFO]  Checking prerequisites...
[OK]    Node.js v24.14.0
[OK]    npm 11.9.0
[OK]    OpenClaw CLI found
[INFO]  Downloading plugin...
[OK]    Downloaded
[INFO]  Extracting...
[OK]    Extracted
[INFO]  Installing npm dependencies...
[OK]    Dependencies installed
[INFO]  Locating diagnostics-otel extension...
[OK]    Found diagnostics-otel at: /home/.../extensions/diagnostics-otel
[OK]    diagnostics-otel dependencies already present
[INFO]  Updating config...
[OK]    Config updated
[INFO]  Restarting OpenClaw gateway...
[OK]    Gateway restarted

════════════════════════════════════════════════════
  ✅ openclaw-cms-plugin installed successfully!
════════════════════════════════════════════════════

Method 2: Manual installation

To manually install the plugins, follow these steps.

curl -fsSL -o openclaw-cms-plugin.tar.gz https://arms-apm-cn-hangzhou-pre.oss-cn-hangzhou.aliyuncs.com/openclaw-cms-plugin/openclaw-cms-plugin.tar.gz
tar -xzf openclaw-cms-plugin.tar.gz
cd openclaw-cms-plugin
npm install --omit=dev

openclaw plugins enable diagnostics-otel

{
  "plugins": {
    "allow": ["openclaw-cms-plugin", "diagnostics-otel"],
    "load": {
      "paths": ["<PATH-TO-OPENCLAW-CMS-PLUGIN>"]
    },
    "entries": {
      "openclaw-cms-plugin": {
        "enabled": true,
        "config": {
          "endpoint": "<YOUR-ENDPOINT>",
          "headers": {
            "x-arms-license-key": "<YOUR-LICENSE-KEY>",
            "x-arms-project": "<YOUR-ARMS-PROJECT>",
            "x-cms-workspace": "<YOUR-WORKSPACE-ID>"
          },
          "serviceName": "<YOUR-SERVICE-NAME>"
        }
      },
      "diagnostics-otel": {
        "enabled": true
      }
    }
  },
  "diagnostics": {
    "enabled": true,
    "otel": {
      "enabled": true,
      "endpoint": "<YOUR-ENDPOINT>",
      "protocol": "http/protobuf",
      "headers": {
        "x-arms-license-key": "<YOUR-LICENSE-KEY>",
        "x-arms-project": "<YOUR-ARMS-PROJECT>",
        "x-cms-workspace": "<YOUR-WORKSPACE-ID>"
      },
      "serviceName": "<YOUR-SERVICE-NAME>",
      "traces": false,
      "metrics": true,
      "logs": false
    }
  }
}

openclaw gateway restart

No data appears in the console after configuration?

Check the following items in order:

1. Confirm that your OpenClaw version is v26.2.19 or later. Run openclaw --version to verify.

2. Confirm that the gateway has been restarted. The one-click installation restarts it automatically. For manual installations, you must run openclaw gateway restart. If the restart fails, run openclaw doctor, fix any issues, and then restart the gateway.

3. Confirm that the Endpoint URL is correct and reachable over the network. Test connectivity with curl.

4. Confirm that all three header values (x-arms-license-key, x-arms-project, and x-cms-workspace) are correctly entered.

5. Note that the default flushIntervalMs is 60 seconds. For short-lived tasks, wait a few minutes before data appears.

Does integration affect OpenClaw performance?

The performance impact is minimal. The openclaw-cms-plugin uses OpenTelemetry's batch export mechanism. The plugin buffers span data in memory and reports it in batches at regular intervals, which does not block the normal processing flow of the agent.

Can I install only the trace plugin?

Yes. During installation, add the --disable-metrics parameter to skip the configuration for diagnostics-otel. This enables trace reporting only.

Will diagnostics-otel and openclaw-cms-plugin traces conflict?

No. The installation script sets diagnostics.otel.traces to false by default, making the openclaw-cms-plugin solely responsible for trace reporting. Even if both are reported simultaneously, there is no conflict.

Will installation overwrite my diagnostics-otel configuration?

No. The installation script uses a merge-update strategy. It only updates necessary fields such as endpoint and headers, and preserves your existing configurations for traces, logs, and sampleRate.

Why is token consumption always 0?

A bug in OpenClaw version 2026.3.8 causes token consumption to be collected incorrectly. A community fix is in progress. For more information, see the related issue: openclaw/openclaw#46616.

Can I use gRPC to report data?

The diagnostics-otel plugin in OpenClaw supports only http/protobuf. If you set grpc, the setting is silently ignored. No error occurs, but the setting has no effect.