Skip to content

Commit 1fb4b31

Browse files
committed
peter's review [netlify-build]
1 parent 5e78ef8 commit 1fb4b31

File tree

1 file changed

+11
-17
lines changed

1 file changed

+11
-17
lines changed

src/monitor/granular-observability.md

Lines changed: 11 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ plan: failure-logs
66
Failure log collection gives you greater visibility into failed event deliveries, allowing you to identify, analyze, and troubleshoot issues with the events that Segment attempted to deliver.
77

88
> info "Failure log collection is in private beta"
9-
> During the private beta, failure log collection only supports streaming destinations.
9+
> During the private beta, failure log collection only supports streaming destinations receiving events from streaming sources or Engage sources.
1010
1111
## Enable failure logs
1212

@@ -29,7 +29,9 @@ Once you've enabled your failure logs in the Segment app, you can access them us
2929

3030
Segment has a Public API endpoint, available in [alpha](https://docs.segmentapis.com/tag/Versioning/){:target="_blank”}, that lets you generate presigned S3 URLs for a collection ID and a specific hour in [ISO 8601 format](https://www.iso.org/iso-8601-date-and-time-format.html){:target="_blank”}. Once you've generated a URL, you can only access that data for two hours. If Segment writes additional data to the specified collection and hour time frame, you must generate an additional Public API call to view the updated logs.
3131

32-
You can make up to 120 requests to the failure logs endpoint per day. Some of the request “tokens” replenish every hour. The rate limiting metadata follows the Segment API [Rate limit errors](https://docs.segmentapis.com/tag/Rate-Limits/#section/Rate-limit-errors){:target="_blank”} specification and the headers show how many remaining API calls can be made. If you exceed the rate limit, Segment returns a 429 status code.
32+
You can make up to 120 requests to the failure logs endpoint per day. Some of the request “tokens” replenish every hour. Once Segment collects the observability events, it takes 1-2 hours to populate the log.
33+
34+
The rate limiting metadata follows the Segment API [Rate limit errors](https://docs.segmentapis.com/tag/Rate-Limits/#section/Rate-limit-errors){:target="_blank”} specification and the headers show how many remaining API calls can be made. If you exceed the rate limit, Segment returns a 429 status code.
3335

3436
Here's an example call:
3537

@@ -60,21 +62,17 @@ Here's an example of an Error Logged event:
6062
{
6163
"type": "observability",
6264
"event": "Error Logged",
63-
"version": 1,
65+
"version": "v1",
6466
"properties": {
6567
"routed": {
6668
"to": [
67-
{ "type" : "destination", "id" : "abc" },
68-
{ "type" : "subscription", "id" : "def" }
69+
{ "type" : "destination", "id" : "abc" }
6970
],
7071
"from": [
7172
{ "type" : "source", "id" : "ghi" }
7273
]
7374
},
7475
"discarded": true | false,
75-
"attempt": 2,
76-
"reason": "failed insert function",
77-
"featureName": "destinationInsertFunction" | "delivery",
7876
"messageId": "m",
7977
"occurredAt": "2025-03-23T20:00:00Z",
8078
"loggedAt": "2025-03-23T20:00:00Z"
@@ -92,22 +90,19 @@ Here's an example of a Delivery Attempt Logged event:
9290
{
9391
"type": "observability",
9492
"event": "Delivery Attempt Logged",
95-
"version": 1,
93+
"version": "v1",
9694
"properties": {
9795
"routed": {
9896
"to": [
99-
{ "type" : "destination", "id" : "abc" },
100-
{ "type" : "subscription", "id" : "def" }
97+
{ "type" : "destination", "id" : "abc" }
10198
],
10299
"from": [
103100
{ "type" : "source", "id" : "ghi" }
104101
]
105102
},
106103
"attempt": 4,
107-
"reason": "some description for why",
108104
"outcome": "failure",
109105
"destinationExchangeId": "x",
110-
"featureName": "destinationInsertFunction" | "delivery",
111106
"messageId": "m",
112107
"occurredAt": "2025-03-23T20:00:00Z",
113108
"loggedAt": "2025-03-23T20:00:00Z"
@@ -126,20 +121,19 @@ Here's an example of a Delivery Exchange Logged event:
126121
{
127122
"type": "observability",
128123
"event": "Destination Exchange Logged",
129-
"version": 1,
124+
"version": "v1",
130125
"properties": {
131126
"requestToDestination": {
132127
"body": "{\"key\": \"value\"}"
133128
},
134129
"responseFromDestination": {
135130
"status" : 418,
136-
"headers": { "X-header": "value" }
131+
"headers": { "X-header": "value" },
137132
"body": "{\"key\": \"value\"}"
138133
},
139134
"routed": {
140135
"to": [
141-
{ "type" : "destination", "id" : "abc" },
142-
{ "type" : "subscription", "id" : "def" }
136+
{ "type" : "destination", "id" : "abc" }
143137
],
144138
"from": [
145139
{ "type" : "source", "id" : "ghi" }

0 commit comments

Comments
 (0)