Log Monitoring API - GET export logs
Gets the log records matching the provided criteria. Matching log records are sorted by the criteria specified in the sort query parameter.
Unlike the GET search logs request, this one does not impose a limit on the total number of resulting log records. However, if the resulting log is too large, pagination is applied. You can set the page size in the pageSize query parameter. In such cases, the first response contains the nextPageKey for the second page. Use it in the nextPageKey query parameter to obtain the second page, which in turn contains the nextPageKey for the third page, and so on.
The request produces an application/json
payload.
This request is an Early Adopter release and may be changed in non-compatible way.
GET | ManagedDynatrace for Government | https://{your-domain}/e/{your-environment-id}/api/v2/logs/export |
Environment and Cluster ActiveGate (default port 9999) | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/logs/export |
Authentication
To execute this request, you need an access token with logs.read
scope.
To learn how to obtain and use it, see Tokens and authentication.
Parameters
The start of the requested timeframe.
You can use one of the following formats:
- Timestamp in UTC milliseconds.
- Human-readable format of
2021-01-25T05:57:01.123+01:00
. If no time zone is specified, UTC is used. You can use a space character instead of theT
. Seconds and fractions of a second are optional. - Relative timeframe, back from now. The format is
now-NU/A
, whereN
is the amount of time,U
is the unit of time, andA
is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example,now-1y/w
is one year back, aligned by a week. You can also specify relative timeframe without an alignment:now-NU
. Supported time units for the relative timeframe are:m
: minutesh
: hoursd
: daysw
: weeksM
: monthsy
: years
If not set, the relative timeframe of two weeks is used (now-2w
).
The end of the requested timeframe.
You can use one of the following formats:
- Timestamp in UTC milliseconds.
- Human-readable format of
2021-01-25T05:57:01.123+01:00
. If no time zone is specified, UTC is used. You can use a space character instead of theT
. Seconds and fractions of a second are optional. - Relative timeframe, back from now. The format is
now-NU/A
, whereN
is the amount of time,U
is the unit of time, andA
is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example,now-1y/w
is one year back, aligned by a week. You can also specify relative timeframe without an alignment:now-NU
. Supported time units for the relative timeframe are:m
: minutesh
: hoursd
: daysw
: weeksM
: monthsy
: years
If not set, the current timestamp is used.
The cursor for the next page of results. You can find it in the nextPageKey field of the previous response.
The first page is always returned if you don't specify the nextPageKey query parameter.
When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters.
The number of results per result page.
The log search query.
The query must use the Dynatrace search query language.
Defines the ordering of the log records.
Each field has a sign prefix (+/-) for sorting order. If no sign prefix is set, then the +
option will be applied.
Currently, ordering is available only for the timestamp (+timestamp for the oldest records first, or -timestamp for the newest records first).
When millisecond resolution provided by the timestamp is not enough, log records are sorted based on the order in which they appear in the log source (remote process writing to REST API endpoint or remote process from which logs are collected).
Response
Response codes
Failed. The server either does not recognize the request method, or it lacks the ability to fulfill the request. May happen when Grail log storage is enabled.
Response body objects
The ExportedLogRecordList
object
A list of exported log records.
The cursor for the next page of results. Has the value of null
on the last page.
Use it in the nextPageKey query parameter to obtain subsequent pages of the result.
The number of entries per page.
The total number of entries in the result.
Optional warning messages.
The LogRecord
object
A single log record.
Additional columns of the log record.
The content of the log record.
Type of event
K8S
LOG
SFM
The log status (based on the log level).
ERROR
INFO
NONE
NOT_APPLICABLE
WARN
The timestamp of the log record, in UTC milliseconds.
Response body JSON model
{"nextPageKey": "___-2lZ43q0AAAAdeJxjYAAC1sLS1KJKBhjggtIijFCGHEwCAFiHAoP___7aVnjerQ","pageSize": 100,"results": [{"additionalColumns": {"custom.attribute": ["value1","value2"],"loglevel": ["SEVERE"]},"content": "example log content","event.type": "LOG","status": "ERROR","timestamp": "1631193089000"}],"totalCount": 150}