Skip to content

Commit 06f1bc6

Browse files
committed
1 parent 589d1ca commit 06f1bc6

File tree

2 files changed

+14
-26
lines changed

2 files changed

+14
-26
lines changed

docs/telemetry.md

Lines changed: 10 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -18,28 +18,16 @@ The following metrics are available:
1818

1919
### Ingestion
2020

21-
#### Success or failure
22-
23-
- `sc.audit.ingestion.success` - Successful ingested audit message count (Counter)
24-
- `sc.audit.ingestion.retry` - Retried audit message count (Counter)
25-
- `sc.audit.ingestion.failed` - Failed audit message count (Counter)
26-
27-
The above metrics also have the following attributes attached:
28-
29-
- `messaging.message.body.size` - The size of the message body in bytes
30-
- `messaging.message.type` - The logical message type of the message if present
31-
32-
#### Details
33-
34-
- `sc.audit.ingestion.duration` - Audit message processing duration in milliseconds (Histogram)
35-
- `sc.audit.ingestion.forwarded` - Count of the number of forwarded audit messages if forwarding is enabled (Counter)
36-
37-
### Batching
38-
39-
- `sc.audit.ingestion.batch_duration` - Batch processing duration in milliseconds (Histogram)
40-
- Attributes:
41-
- `ingestion.batch_size`
42-
- `sc.audit.ingestion.consecutive_batch_failures` - Consecutive batch failures (Counter)
21+
The following ingestion metrics with their corresponding dimensions are available:
22+
23+
- `sc.audit.ingestion.batch_duration_seconds` - Message batch processing duration in seconds
24+
- `result` - Indicates if the full batch size was used (batch size == max concurrency of the transport): `full` or `partial`
25+
- `sc.audit.ingestion.message_duration_seconds` - Audit message processing duration in seconds
26+
- `message.category` - Indicates the category of the message ingested: `audit-message`, `saga-update` or `control-message`
27+
- `sc.audit.ingestion.failures_total` - Failure counter
28+
- `message.category` - Indicates the category of the message ingested: `audit-message`, `saga-update` or `control-message`
29+
- `result` - Indicates how the failure was resolved: `retry` or `stored-poision`
30+
- `sc.audit.ingestion.consecutive_batch_failure_total` - Consecutive batch failures
4331

4432
## Monitoring
4533

src/ServiceControl.Audit/Auditing/Metrics/IngestionMetrics.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ public IngestionMetrics(IMeterFactory meterFactory)
1515
{
1616
var meter = meterFactory.Create(MeterName, MeterVersion);
1717

18-
batchDuration = meter.CreateHistogram<double>(CreateInstrumentName("batch_duration"), unit: "seconds", "Average audit message batch processing duration");
19-
ingestionDuration = meter.CreateHistogram<double>(CreateInstrumentName("message_duration"), unit: "seconds", description: "Average incoming audit message processing duration");
20-
consecutiveBatchFailureGauge = meter.CreateObservableGauge(CreateInstrumentName("consecutive_batch_failures"), () => consecutiveBatchFailures, description: "Consecutive audit ingestion batch failure");
21-
failureCounter = meter.CreateCounter<long>(CreateInstrumentName("failure_count"), description: "Audit ingestion failure count");
18+
batchDuration = meter.CreateHistogram<double>(CreateInstrumentName("batch_duration_seconds"), unit: "seconds", "Message batch processing duration in seconds");
19+
ingestionDuration = meter.CreateHistogram<double>(CreateInstrumentName("message_duration_seconds"), unit: "seconds", description: "Audit message processing duration in seconds");
20+
consecutiveBatchFailureGauge = meter.CreateObservableGauge(CreateInstrumentName("consecutive_batch_failure_total"), () => consecutiveBatchFailures, description: "Consecutive audit ingestion batch failure");
21+
failureCounter = meter.CreateCounter<long>(CreateInstrumentName("failures_total"), description: "Audit ingestion failure count");
2222
}
2323

2424
public MessageMetrics BeginIngestion(MessageContext messageContext) => new(messageContext, ingestionDuration);

0 commit comments

Comments
 (0)