You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: cmd/opampsupervisor/README.md
+20-1Lines changed: 20 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ The design is still undergoing changes, and as such this implementation may chan
16
16
17
17
Binary and container images for the Supervisor are available under tags starting with `cmd/opampsupervisor`[here](https://github.com/open-telemetry/opentelemetry-collector-releases/tags).
The supervisor persists some data to disk in order to mantain state between restarts. The directory where this data is stored may be specified via the supervisor configuration:
124
+
124
125
```yaml
125
126
storage:
126
127
directory: "/path/to/storage/dir"
@@ -180,6 +181,24 @@ agent:
180
181
181
182
See [examples/supervisor_fallback.yaml](./examples/supervisor_fallback.yaml) for a complete example configuration with fallback enabled.
182
183
184
+
## Automatic Remote Configuration Rollback
185
+
186
+
The Supervisor supports automatic rollback when a remote configuration received from
187
+
the OpAMP backend causes the Collector to fail to start correctly. This feature is
188
+
**disabled by default** and can be enabled in the Supervisor configuration file:
189
+
190
+
```yaml
191
+
agent:
192
+
automatic_config_rollback: true
193
+
```
194
+
195
+
When enabled, the Supervisor will watch the health of the Collector after applying remote
196
+
configurations received from the OpAMP backend and it will cache the last working one in
197
+
disk, besides the last received. If a remote configurations causes the Collector
198
+
to fail to start correctly, the Supervisor will automatically swap to the last working one
199
+
and restart the Collector. During this process, a new "APPLIED" status will be reported for
200
+
the last working configuration.
201
+
183
202
## Status
184
203
185
204
The OpenTelemetry OpAMP Supervisor is intended to be the reference
0 commit comments