The snapshot processor is used in custom distributions of the collector to provide snapshot functionality in Bindplane. It is not currently included in the official bindplane-agent.
- Logs
- Metrics
- Traces
- The user configures the processor in one or more pipelines. If the same processor ID is used across multiple pipelines or signal types, a single shared instance is created.
- Whenever telemetry passes through the processor, it is copied and stored in an in-memory buffer. The processor keeps a separate buffer per signal type, each holding roughly the most recent 100 log records, metric data points, or spans. Telemetry is passed through to the next consumer unmodified.
- On startup, the processor registers the
com.bindplane.snapshotcustom capability with the OpAMP extension named by theopampoption (typically theopampextension used alongside thebindplaneextension). - An OpAMP server (such as Bindplane) requests a snapshot by sending a
requestSnapshotcustom message. The request identifies a processor ID and pipeline type (logs,metrics, ortraces), and may include a search query and minimum timestamp to filter the buffered telemetry, as well as a maximum payload size (default 10MiB). - The processor serializes the matching buffered telemetry to JSON, gzip-compresses it, and sends it back over the same OpAMP connection as a
reportSnapshotcustom message. If the payload would exceed the maximum size, telemetry is sampled to fit.
| Field | Type | Default | Required | Description |
|---|---|---|---|---|
| enabled | bool | true |
false |
Whether the snapshot processor is enabled or not. When disabled, telemetry passes through without being buffered. |
| opamp | string | opamp |
false |
Specifies the ID of the opamp extension for sending custom messages. |
The snapshot processor may be used in a pipeline in order to temporarily catch telemetry data in a buffer, which an opamp server may request:
receivers:
file_log:
include: [/var/log/logfile.txt]
processors:
snapshotprocessor:
enabled: true
opamp: opamp
exporters:
nop:
extensions:
bindplane:
labels: "labelA=valueA,labelB=valueB"
opamp:
endpoint: "https://localhost:3001/v1/opamp"
service:
extensions: [bindplane, opamp]
pipelines:
logs:
receivers: [file_log]
processors: [snapshotprocessor]
exporters: [nop]In this instance, the OpAMP server can now request a snapshot using the com.bindplane.snapshot capability (see request.go for more information on the payload).