span_query_facets

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

Overview

Name	span_query_facets
Type	Resource
Id	sumologic.tracing.span_query_facets

Fields

The following fields are returned by SELECT queries:

list

The list of facets from the executed query.

Name	Datatype	Description
name	string	Name of the field facet. (example: _sourceHost)
cardinality	integer (int32)	The number of unique values this field occured.
data_type	string	Data type of the field. (pattern: <code>^(String|Int|Long|Double|Boolean)$</code>, example: String, x-pattern-message: Should be either String, Int, Long, Double or Boolean.) (wire: dataType)
in_schema	boolean	Indicates whether the field is available in the span schema. (wire: inSchema)
value_frequency	object	Map of field value frequencies. (wire: valueFrequency)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	query_id, row_id, region		Get a list of facets of a span analytics query with the specified 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
query_id	string	Identifier of the executed query. (wire: queryId)
region	string	Sumo Logic deployment (au, ca, ch, de, eu, fed, in, jp, kr, us1, us2). Resolved from the SUMOLOGIC_ENVIRONMENT environment variable when it is set (x-stackQL-envVar, the same variable the Terraform provider reads); otherwise defaults to us2. A WHERE region = '...' value always takes precedence. (enum: [au, ca, ch, de, eu, fed, in, jp, kr, us1, us2], default: us2, x-stackQL-envVar: SUMOLOGIC_ENVIRONMENT)
row_id	string	Identifier of the query row. (wire: rowId)

SELECT examples

list

Get a list of facets of a span analytics query with the specified id.

SELECT
name,
cardinality,
data_type,
in_schema,
value_frequency
FROM sumologic.tracing.span_query_facets
WHERE query_id = '{{ query_id }}' -- required
AND row_id = '{{ row_id }}' -- required
AND region = '{{ region }}' -- required unless SUMOLOGIC_ENVIRONMENT is set
;