diagnostics
Retrieves diagnostic events from a Tenzir node.
diagnostics [live=bool, retro=bool]Description
The diagnostics operator retrieves diagnostic events from a Tenzir
node.
live = bool (optional)
If true, emits diagnostic events as they are generated in real-time. Unless
retro=true is also given, this makes it so that previous diagnostics events
are not returned.
retro = bool (optional)
Return diagnostic events that were generated in the past. Unless live=true is
given, this is the default. If both are set to true, all previous events are
returned before beginning with the live events.
Schemas
Tenzir emits diagnostic information with the following schema:
tenzir.diagnostic
Contains detailed information about the diagnostic.
| Field | Type | Description |
|---|---|---|
pipeline_id | string | The ID of the pipeline that created the diagnostic. |
run | uint64 | The number of the run, starting at 1 for the first run. |
timestamp | time | The exact timestamp of the diagnostic creation. |
message | string | The diagnostic message. |
severity | string | The diagnostic severity. |
notes | list<record> | The diagnostic notes. Can be empty. |
annotations | list<record> | The diagnostic annotations. Can be empty. |
rendered | string | The rendered diagnostic, as printed on the command-line. |
The records in notes have the following schema:
| Field | Type | Description |
|---|---|---|
kind | string | The kind of note, which is note, usage, hint or docs. |
message | string | The message of this note. |
The records in annotations have the following schema:
| Field | Type | Description |
|---|---|---|
primary | bool | True if the source represents the underlying reason for the diagnostic, false if it is only related to it. |
text | string | A message for explanations. Can be empty. |
source | string | The character range in the pipeline string that this annotation is associated to. |
Examples
View all diagnostics generated in the past five minutes.
diagnostics
where timestamp > now() - 5min
Get a live feed of error diagnostics as they are emitted.
diagnostics live=true
where severity == "error"