Skip to content

Commit 955b0c5

Browse files
authored
docs(monitoring): document worker operation metrics (#2296)
1 parent 80281e2 commit 955b0c5

2 files changed

Lines changed: 20 additions & 4 deletions

File tree

hindsight-docs/docs/developer/monitoring.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,9 @@ curl http://localhost:8888/metrics
5757
| `hindsight.operation.total` | Counter | operation, bank_id, source, budget, max_tokens, success | Total number of operations executed |
5858

5959
**Labels:**
60-
- `operation`: Operation type (`retain`, `recall`, `reflect`)
60+
- `operation`: Operation type (`retain`, `recall`, `reflect`, plus async worker task types such as `consolidation`)
6161
- `bank_id`: Memory bank identifier
62-
- `source`: Where the operation was triggered from (`api`, `reflect`, `internal`)
62+
- `source`: Where the operation was triggered from (`api`, `reflect`, `internal`, `worker`)
6363
- `budget`: Budget level if specified (`low`, `mid`, `high`)
6464
- `max_tokens`: Max tokens if specified
6565
- `success`: Whether the operation succeeded (`true`, `false`)
@@ -68,6 +68,14 @@ The `source` label allows distinguishing between:
6868
- `api`: Direct API calls from clients
6969
- `reflect`: Internal recall calls made during reflect operations
7070
- `internal`: Other internal operations
71+
- `worker`: Async worker completions recorded when a claimed task reaches a terminal outcome
72+
73+
For `source="worker"`, the `success` label is a completion-throughput signal:
74+
`false` means the task raised out to the poller after retries were exhausted or
75+
an unexpected error occurred. Failures handled inside the executor and returned
76+
normally still record `success="true"` here; use
77+
`hindsight_async_operations{status="failed"}` for authoritative async operation
78+
failure status.
7179

7280
### LLM Metrics
7381

skills/hindsight-docs/references/developer/monitoring.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,9 @@ curl http://localhost:8888/metrics
5757
| `hindsight.operation.total` | Counter | operation, bank_id, source, budget, max_tokens, success | Total number of operations executed |
5858

5959
**Labels:**
60-
- `operation`: Operation type (`retain`, `recall`, `reflect`)
60+
- `operation`: Operation type (`retain`, `recall`, `reflect`, plus async worker task types such as `consolidation`)
6161
- `bank_id`: Memory bank identifier
62-
- `source`: Where the operation was triggered from (`api`, `reflect`, `internal`)
62+
- `source`: Where the operation was triggered from (`api`, `reflect`, `internal`, `worker`)
6363
- `budget`: Budget level if specified (`low`, `mid`, `high`)
6464
- `max_tokens`: Max tokens if specified
6565
- `success`: Whether the operation succeeded (`true`, `false`)
@@ -68,6 +68,14 @@ The `source` label allows distinguishing between:
6868
- `api`: Direct API calls from clients
6969
- `reflect`: Internal recall calls made during reflect operations
7070
- `internal`: Other internal operations
71+
- `worker`: Async worker completions recorded when a claimed task reaches a terminal outcome
72+
73+
For `source="worker"`, the `success` label is a completion-throughput signal:
74+
`false` means the task raised out to the poller after retries were exhausted or
75+
an unexpected error occurred. Failures handled inside the executor and returned
76+
normally still record `success="true"` here; use
77+
`hindsight_async_operations{status="failed"}` for authoritative async operation
78+
failure status.
7179

7280
### LLM Metrics
7381

0 commit comments

Comments
 (0)