critical_paths
Creates, updates, deletes, gets or lists a critical_paths resource.
Overview​
| Name | critical_paths |
| Type | Resource |
| Id | sumologic.tracing.critical_paths |
Fields​
The following fields are returned by SELECT queries:
- list
List of span segments composing the critical path.
| Name | Datatype | Description |
|---|---|---|
span_id | string | Span identifier. (example: 00000000000120CB) (wire: spanId) |
duration | integer (int64) | Number of nanoseconds the span segment lasted. |
fraction | number (double) | The fraction (value between 0.0 and 1.0) from the trace duration time this segment took. |
service | string | The name of the service this span is part of. (example: user-service) |
service_color | string | Color hex code assigned to the service. (example: #fa41c6) (wire: serviceColor) |
start_offset | integer (int64) | Number of nanoseconds from the span startedAt the segment started. (wire: startOffset) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | trace_id, region | limit, token | Get a list of span segments composing the critical path of the trace. A span segment represents the processing time that was consumed within the span itself and does not incorporate the processing time of its children. The critical path is the sequence of span segments that contribute to the total trace duration. An increase of the processing time of any segment from the critical path would result in an increase of the total trace processing time. |
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. (wire: traceId) |
limit | integer (int32) | The maximum number of results to fetch. |
token | string | Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. token is set to null when no more pages are left. |
SELECT examples​
- list
Get a list of span segments composing the critical path of the trace. A span segment represents the processing time that was consumed within the span itself and does not incorporate the processing time of its children. The critical path is the sequence of span segments that contribute to the total trace duration. An increase of the processing time of any segment from the critical path would result in an increase of the total trace processing time.
SELECT
span_id,
duration,
fraction,
service,
service_color,
start_offset
FROM sumologic.tracing.critical_paths
WHERE trace_id = '{{ trace_id }}' -- required
AND region = '{{ region }}' -- required unless SUMOLOGIC_ENVIRONMENT is set
AND limit = '{{ limit }}'
AND token = '{{ token }}'
;