- URL:
- https://<root>/logs/query
- Methods:
GET- Required Capability:
- Administrator
- Version Introduced:
- 12.2
Description
The query operation provides a way to aggregate, filter, and page through logs across the entire ArcGIS Data Pipelines Server site.
Request parameters
| Parameter | Details |
|---|---|
| Only records with a log level at or more severe than this level are returned. The default value is Values: |
| The most recent time to query. If the Example |
| The oldest time to include in the result set. You can use this to limit the query to the last few minutes or hours as needed. Example |
(Required) | Specifies that the filter Example |
(Required) | Filtering provides flexibility and specificity by combining any of the filter properties, each given as a comma-separated list. Example |
| The maximum number of log records to be returned by this query. The default messages per page is 1000. Example |
| The response format. The default value is Values: |
Filter properties
| Property | Description |
|---|---|
(Optional) | Specifies the log codes assigned to server logs. To query all codes, set the value to Example |
(Optional) | One or multiple users (separated by commas) whose related log messages to query. Example |
(Optional) | Specifies whether to query all or a specific machine in your server site. To query logs from all machines, set the value to Example |
(Optional) | Specifies the server components delivering the log message. To query logs from all components, set the value to Values: |
Example usage
The following is a sample GET request for the query operation.
https://organization.example.com/<context>/admin/logs/query?startTime=1310165288&endTime=1310125087&level=INFO&filterType=json&filter={"codes":[8271,9003],"users":[username1,username2],"machines":["machine.example.com"],"source":"*"}&pageSize=1000&f=pjsonJSON Response example
{
"hasMore": true,
"startTime": 1779470175920,
"endTime": 1779140650929,
"logMessages": [{
"elapsed": "",
"process": "123123",
"code": 1146,
"machine": "MACHINE.EXAMPLE.COM",
"requestID": "b05433ca-16bf-4c3c-a3a0-a575b9e256e5",
"methodName": "",
"time": 1779470175920,
"source": "Admin",
"thread": "37",
"type": "INFO",
"message": "Successfully updated the configuration store.",
"user": "admin_user"
}, {
"elapsed": "",
"process": "123123",
"code": 1032,
"machine": "MACHINE.EXAMPLE.COM",
"requestID": "b05433ca-16bf-4c3c-a3a0-a575b9e256e5",
"methodName": "",
"time": 1779470175920,
"source": "Admin",
"thread": "37",
"type": "INFO",
"message": "Log settings updated. '[Logs directory = '/data/arcgis/datapipelines/usr/logs/', Log level = DEBUG, Max age in days = 90]'",
"user": "admin_user"
}
]
}