Latency for all data flowing from the time a piece of data is ingested into Teradata Listener until the time it is written to a target. Latency values are returned in millisecond values; therefore, to get the value in seconds, multiply by 1,000.
Due to aggregation, this is useful for obtaining a sense of how well Listener is writing data to the system.
Definition
GET https://CLUSTER.DOMAIN/listener/appservices/targets/{target_id}/latency?interval,timeframe HTTP/1.1
| Parameter | Required | Type | Sample | Purpose |
|---|---|---|---|---|
| target_id | Required | string | 758fbda4-accc-4f90-8f09-cc0a164c8c28 | Time interval for each data point. |
| interval | Optional | string | 1m | Time interval for each data point. |
| timeframe | Optional | string | 7d | Time frame to query into the past. |
Parameters use an integer and character combination to denote the time range:
- s = seconds
- m = minutes
- h = hours
- d = days
- w = weeks
- M = months
Example Request
curl \
-H "Content-Type: application/json" \
-H "Authorization: Bearer TOKEN" \
-X GET \
-i \
https://CLUSTER.DOMAIN/listener/appservices/targets/758fbda4-accc-4f90-8f09-cc0a164c8c28/latency
Example Response
HTTP/1.1 200 OK Content-Type: application/json
[{
"doc_count": 4,
"latency": {
"avg": 74467.75,
"count": 4,
"max": 129258,
"min": 16396,
"sum": 297871
},
"time": "2017-11-17T20:00:00Z"
}]
The values in this example response are represented in milliseconds. The latency displayed in the Listener user interface is ‘avg’ (average latency) /1000 ~ 74.46 s.
The average latency value denotes the time taken for the record to reach the writer when the writer is in a running state. If the writer is in a paused state, the latency values might be higher.
Response Codes
| Code | Description |
|---|---|
| 200 | Metrics successfully loaded. |
| 401 | Authorization header not found. |
| 404 | Resource not found. |