tracequery
Creates, updates, deletes, gets or lists a tracequery
resource.
Overview
Name | tracequery |
Type | Resource |
Id | sumologic.tracing.tracequery |
Fields
The following fields are returned by SELECT
queries:
SELECT
not supported for this resource, use SHOW METHODS
to view available operations for the resource.
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
createTraceQuery | insert | region , data__queryRows , data__timeRange | Execute a trace search query and get the id to fetch its status and results. Use the [Trace Query Status] endpoint to check a query status. When the query has been completed, use the [Trace Query Result] endpoint to get the result of the asynchronous query. | |
cancelTraceQuery | exec | queryId , region | Cancel a currently processed trace search query with the given id. |
Parameters
Parameters can be passed in the WHERE
clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
Name | Datatype | Description |
---|---|---|
queryId | string | Identifier of the query to cancel. |
region | string | SumoLogic region (enum: [us2, au, ca, de, eu, fed, in, jp], default: us2) |
INSERT
examples
- createTraceQuery
- Manifest
Execute a trace search query and get the id to fetch its status and results. Use the [Trace Query Status] endpoint to check a query status. When the query has been completed, use the [Trace Query Result] endpoint to get the result of the asynchronous query.
INSERT INTO sumologic.tracing.tracequery (
data__queryRows,
data__timeRange,
region
)
SELECT
'{{ queryRows }}' /* required */,
'{{ timeRange }}' /* required */,
'{{ region }}'
RETURNING
queryId
;
# Description fields are for documentation purposes
- name: tracequery
props:
- name: region
value: string
description: Required parameter for the tracequery resource.
- name: queryRows
value: array
description: |
A list of trace queries.
- name: timeRange
value: object
Lifecycle Methods
- cancelTraceQuery
Cancel a currently processed trace search query with the given id.
EXEC sumologic.tracing.tracequery.cancelTraceQuery
@queryId='{{ queryId }}' --required,
@region='{{ region }}' --required
;