spanquery

Creates, updates, deletes, gets or lists a spanquery resource.

Overview

Name	spanquery
Type	Resource
Id	sumologic.tracing.spanquery

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
createSpanQuery	insert	region, data__queryRows, data__timeRange		Execute a span analytics query and get the id to fetch its status and results. Use the [Span Query Status] endpoint to check a query status. When the query has been completed, use the [Span Query Result] endpoint to get the result of the asynchronous query.
cancelSpanQuery	exec	queryId, region		Cancel a currently processed span 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

createSpanQuery

Execute a span analytics query and get the id to fetch its status and results. Use the [Span Query Status] endpoint to check a query status. When the query has been completed, use the [Span Query Result] endpoint to get the result of the asynchronous query.

INSERT INTO sumologic.tracing.spanquery (
data__queryRows,
data__timeRange,
data__timeZone,
region
)
SELECT 
'{{ queryRows }}' /* required */,
'{{ timeRange }}' /* required */,
'{{ timeZone }}',
'{{ region }}'
RETURNING
hasErrors,
queryId,
queryRows,
timeRange
;

Manifest

# Description fields are for documentation purposes
- name: spanquery
  props:
    - name: region
      value: string
      description: Required parameter for the spanquery resource.
    - name: queryRows
      value: array
      description: |
        A list of span analytics queries.
    - name: timeRange
      value: object
    - name: timeZone
      value: string
      description: |
        Time zone for the query time ranges. Follow the format in the [IANA Time Zone Database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).
      default: UTC

Lifecycle Methods

cancelSpanQuery

Cancel a currently processed span search query with the given id.

EXEC sumologic.tracing.spanquery.cancelSpanQuery 
@queryId='{{ queryId }}' --required, 
@region='{{ region }}' --required
;