openclaw-observability-plugin/openclaw.plugin.json at main · henrikrexed/openclaw-observability-plugin · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
{
  "id": "otel-observability",
  "name": "OpenTelemetry Observability",
  "description": "Traces, metrics, and logs for OpenClaw using OpenLLMetry and OpenTelemetry",
  "version": "0.9.1",
  "minOpenClawVersion": "2026.4.21",
  "contracts": {
    "tools": [
      "otel_status"
    ]
  },
  "toolMetadata": {
    "otel_status": {
      "optional": true
    }
  },
  "uiHints": {
    "endpoint": {
      "label": "OTLP Endpoint",
      "placeholder": "http://localhost:4318"
    },
    "protocol": {
      "label": "OTLP Protocol",
      "help": "Use 'http' for OTLP/HTTP (port 4318) or 'grpc' for OTLP/gRPC (port 4317)"
    },
    "serviceName": {
      "label": "Service Name",
      "placeholder": "openclaw-gateway"
    },
    "headers": {
      "label": "OTLP Headers",
      "help": "Custom headers for OTLP export (e.g., Authorization for Dynatrace)"
    },
    "traces": {
      "label": "Enable Traces"
    },
    "metrics": {
      "label": "Enable Metrics"
    },
    "logs": {
      "label": "Enable Logs"
    },
    "captureContent": {
      "label": "Capture Prompt/Completion Content",
      "help": "Accepts `true` / `false` (legacy, all-on or all-off) or a granular ContentCapturePolicy object with the per-category flags `inputMessages`, `outputMessages`, `toolInputs`, `toolOutputs`, `systemPrompt`. Default is everything off."
    },
    "metricsIntervalMs": {
      "label": "Metrics Export Interval (ms)",
      "advanced": true
    },
    "sampleRate": {
      "label": "Trace Sampling Rate",
      "help": "Optional head-based sampling rate from 0.0 to 1.0",
      "advanced": true
    },
    "resourceAttributes": {
      "label": "Extra Resource Attributes",
      "advanced": true
    },
    "logConfig": {
      "label": "Log Pipeline Filters",
      "advanced": true
    }
  },
  "configSchema": {
    "type": "object",
    "additionalProperties": false,
    "properties": {
      "endpoint": {
        "type": "string",
        "description": "OTLP endpoint URL (e.g., http://localhost:4318 for HTTP, http://localhost:4317 for gRPC)"
      },
      "protocol": {
        "type": "string",
        "enum": [
          "http",
          "grpc"
        ],
        "description": "OTLP export protocol"
      },
      "serviceName": {
        "type": "string",
        "description": "OpenTelemetry service name"
      },
      "headers": {
        "type": "object",
        "additionalProperties": {
          "type": "string"
        },
        "description": "Custom headers for OTLP export"
      },
      "traces": {
        "type": "boolean",
        "description": "Enable trace export"
      },
      "metrics": {
        "type": "boolean",
        "description": "Enable metrics export"
      },
      "logs": {
        "type": "boolean",
        "description": "Enable log export"
      },
      "captureContent": {
        "description": "Content capture policy. `true`/`false` toggle every category at once; an object selects categories individually. Unknown keys are tolerated by the parser and ignored at runtime. See docs/security/privacy.md.",
        "oneOf": [
          {
            "type": "boolean"
          },
          {
            "type": "object",
            "additionalProperties": true,
            "properties": {
              "inputMessages": {
                "type": "boolean",
                "description": "Capture inbound user message text on the request/agent.turn spans."
              },
              "outputMessages": {
                "type": "boolean",
                "description": "Capture outbound assistant reply text on the message.sent span."
              },
              "toolInputs": {
                "type": "boolean",
                "description": "Capture full tool-call input arguments on the execute_tool span."
              },
              "toolOutputs": {
                "type": "boolean",
                "description": "Capture tool-call result text on the execute_tool span."
              },
              "systemPrompt": {
                "type": "boolean",
                "description": "Capture the system prompt on the agent.turn span."
              }
            }
          }
        ]
      },
      "metricsIntervalMs": {
        "type": "integer",
        "minimum": 1000,
        "description": "Metrics export interval in milliseconds"
      },
      "sampleRate": {
        "type": "number",
        "minimum": 0,
        "maximum": 1,
        "description": "Optional head-based trace sampling rate from 0.0 to 1.0"
      },
      "resourceAttributes": {
        "type": "object",
        "additionalProperties": {
          "type": "string"
        },
        "description": "Additional OTel resource attributes"
      },
      "logConfig": {
        "type": "object",
        "additionalProperties": true,
        "description": "Optional log pipeline filtering configuration"
      }
    }
  }
}