package PB.Failures

Get desktop application:
View/edit binary Protocol Buffers messages

One failed check, as the core saw it leave execute_query.

Used in: FailuresResponseMessage.Response

• uint64 index = 1

  Monotonic and 1-based for the lifetime of the process; a cleared store does not restart it. A poller asks for `since = <the last index it saw>` and gets only what it has not seen.

• int64 timestamp = 2

  When the check finished, seconds since the unix epoch.

• string subject = 3

  Who asked: the caller subject resolved from the request header, in the `module[:principal]` form the permission layer uses ("NRPEServer", "WEBServer:admin", "Scheduler"); "*" when the caller is unknown.

• int32 depth = 4

  How deeply nested the check was: 0 for one a transport asked for directly, 1 for one a check_multi or check_and_forward ran on its behalf, and so on. Both ends of such a pair are recorded.

• optional Commands.QueryResponseMessage.Response response = 5

  The payload as it was returned, after the core's caps: the lines are truncated, the perf list is capped and `data` is cleared. `arguments` is filled from the request - with credential-looking values redacted - only when [/settings/core/failed checks] `record arguments` is on, and cleared otherwise.

Failures request message. Consumer (REST, the `nscp test` console, a module) -> core.

• optional Common.Header header = 1

• repeated FailuresRequestMessage.Request payload = 2

Used in: FailuresRequestMessage

• int64 id = 1

• Request.Command command = 2

• uint64 since = 3

  Only entries whose index is greater than this. 0 is everything.

• uint32 limit = 4

  At most this many entries, the newest ones. 0 is no limit beyond what the store holds.

Used in: Request

• GET = 0

• CLEAR = 1

  Drop every stored entry, then answer as GET does (with an empty list and `removed` set).

Failures response message. The entries asked for, newest first, plus what a consumer needs to say how the store is configured and whether it has missed anything.

• optional Common.Header header = 1

• repeated FailuresResponseMessage.Response payload = 2

Used in: FailuresResponseMessage

• int64 id = 1

• optional Common.Result result = 2

• repeated FailedCheck entries = 3

  Newest first.

• bool enabled = 4

  The store's configuration, so a UI can say "recording is off" or "arguments are not recorded" instead of showing an empty column.

• uint64 max_entries = 5

• bool arguments_recorded = 6

• string statuses = 7

  The statuses that are recorded, as configured ("warning,critical,unknown").

• uint64 last_index = 8

  The highest index handed out so far; 0 before the first failure. A poller that sees it move past its own `since` plus the entries it got knows the cap evicted something in between.

• uint64 dropped = 9

  Entries the cap has evicted since the process started.

• uint64 removed = 10

  For CLEAR: how many entries were removed.