traces
Creates, updates, deletes, gets or lists a traces resource.
Overview​
| Name | traces |
| Type | Resource |
| Id | sumologic.tracing.traces |
Fields​
The following fields are returned by SELECT queries:
- get
Details of the trace with the given identifier.
| Name | Datatype | Description |
|---|---|---|
id | string | Trace identifier. (example: 00000000000120CB) |
root_operation_name | string | The name of the operation given to the root span. (example: retrieveAccount) (wire: rootOperationName) |
critical_path_service_breakdown_summary | object | (wire: criticalPathServiceBreakdownSummary) |
metrics | object | Calculated trace metrics. |
root_resource | string | Root resource on which the trace was started. Examples: db.query, http.request, rpc.call, container (example: http.request) (wire: rootResource) |
root_service | string | Root service which started the trace. Examples: user-service, authentication-service, payment-service, /shopping-cart (example: user-service) (wire: rootService) |
root_status | object | (wire: rootStatus) |
started_at | string (date-time) | Date and time the trace was started in [ISO 8601 / RFC3339](https:​//tools.ietf.org/html/rfc3339) format. (example: 2019-11-22T09:00:00.000Z) (wire: startedAt) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | trace_id, region | Get details of a trace with the given identifier. |
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 |
|---|---|---|
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) |
trace_id | string | Identifier of the trace to get the details. (wire: traceId) |
SELECT examples​
- get
Get details of a trace with the given identifier.
SELECT
id,
root_operation_name,
critical_path_service_breakdown_summary,
metrics,
root_resource,
root_service,
root_status,
started_at
FROM sumologic.tracing.traces
WHERE trace_id = '{{ trace_id }}' -- required
AND region = '{{ region }}' -- required unless SUMOLOGIC_ENVIRONMENT is set
;