mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-10-16 14:57:20 +00:00
chore(api)!: BREAKING CHANGE: remove ALL telemetry APIs (#3740)
# What does this PR do? As discussed on discord, we do not need to reinvent the wheel for telemetry. Instead we'll lean into the canonical OTEL stack. Logs/traces/metrics will still be sent via OTEL - they just won't be stored on, queried through Stack. This is the first of many PRs to remove telemetry API from Stack. 1) removed webmethod decorators to remove from API spec 2) removed tests as @iamemilio is adding them on otel directly. ## Test Plan
This commit is contained in:
ehhuang
GitHub
parent
15900472ad
commit
866c13cdc2
13 changed files with 2 additions and 6738 deletions
942
docs/static/stainless-llama-stack-spec.yaml
vendored
942
docs/static/stainless-llama-stack-spec.yaml
vendored
|
|
@ -1947,33 +1947,6 @@ paths:
|
|||
$ref: '#/components/schemas/SyntheticDataGenerateRequest'
|
||||
required: true
|
||||
deprecated: false
|
||||
/v1/telemetry/events:
|
||||
post:
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
'400':
|
||||
$ref: '#/components/responses/BadRequest400'
|
||||
'429':
|
||||
$ref: >-
|
||||
#/components/responses/TooManyRequests429
|
||||
'500':
|
||||
$ref: >-
|
||||
#/components/responses/InternalServerError500
|
||||
default:
|
||||
$ref: '#/components/responses/DefaultError'
|
||||
tags:
|
||||
- Telemetry
|
||||
summary: Log an event.
|
||||
description: Log an event.
|
||||
parameters: []
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/LogEventRequest'
|
||||
required: true
|
||||
deprecated: false
|
||||
/v1/tool-runtime/invoke:
|
||||
post:
|
||||
responses:
|
||||
|
|
@ -4285,238 +4258,6 @@ paths:
|
|||
$ref: '#/components/schemas/SupervisedFineTuneRequest'
|
||||
required: true
|
||||
deprecated: false
|
||||
/v1alpha/telemetry/metrics/{metric_name}:
|
||||
post:
|
||||
responses:
|
||||
'200':
|
||||
description: A QueryMetricsResponse.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/QueryMetricsResponse'
|
||||
'400':
|
||||
$ref: '#/components/responses/BadRequest400'
|
||||
'429':
|
||||
$ref: >-
|
||||
#/components/responses/TooManyRequests429
|
||||
'500':
|
||||
$ref: >-
|
||||
#/components/responses/InternalServerError500
|
||||
default:
|
||||
$ref: '#/components/responses/DefaultError'
|
||||
tags:
|
||||
- Telemetry
|
||||
summary: Query metrics.
|
||||
description: Query metrics.
|
||||
parameters:
|
||||
- name: metric_name
|
||||
in: path
|
||||
description: The name of the metric to query.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/QueryMetricsRequest'
|
||||
required: true
|
||||
deprecated: false
|
||||
/v1alpha/telemetry/spans:
|
||||
post:
|
||||
responses:
|
||||
'200':
|
||||
description: A QuerySpansResponse.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/QuerySpansResponse'
|
||||
'400':
|
||||
$ref: '#/components/responses/BadRequest400'
|
||||
'429':
|
||||
$ref: >-
|
||||
#/components/responses/TooManyRequests429
|
||||
'500':
|
||||
$ref: >-
|
||||
#/components/responses/InternalServerError500
|
||||
default:
|
||||
$ref: '#/components/responses/DefaultError'
|
||||
tags:
|
||||
- Telemetry
|
||||
summary: Query spans.
|
||||
description: Query spans.
|
||||
parameters: []
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/QuerySpansRequest'
|
||||
required: true
|
||||
deprecated: false
|
||||
/v1alpha/telemetry/spans/export:
|
||||
post:
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
'400':
|
||||
$ref: '#/components/responses/BadRequest400'
|
||||
'429':
|
||||
$ref: >-
|
||||
#/components/responses/TooManyRequests429
|
||||
'500':
|
||||
$ref: >-
|
||||
#/components/responses/InternalServerError500
|
||||
default:
|
||||
$ref: '#/components/responses/DefaultError'
|
||||
tags:
|
||||
- Telemetry
|
||||
summary: Save spans to a dataset.
|
||||
description: Save spans to a dataset.
|
||||
parameters: []
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/SaveSpansToDatasetRequest'
|
||||
required: true
|
||||
deprecated: false
|
||||
/v1alpha/telemetry/spans/{span_id}/tree:
|
||||
post:
|
||||
responses:
|
||||
'200':
|
||||
description: A QuerySpanTreeResponse.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/QuerySpanTreeResponse'
|
||||
'400':
|
||||
$ref: '#/components/responses/BadRequest400'
|
||||
'429':
|
||||
$ref: >-
|
||||
#/components/responses/TooManyRequests429
|
||||
'500':
|
||||
$ref: >-
|
||||
#/components/responses/InternalServerError500
|
||||
default:
|
||||
$ref: '#/components/responses/DefaultError'
|
||||
tags:
|
||||
- Telemetry
|
||||
summary: Get a span tree by its ID.
|
||||
description: Get a span tree by its ID.
|
||||
parameters:
|
||||
- name: span_id
|
||||
in: path
|
||||
description: The ID of the span to get the tree from.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/GetSpanTreeRequest'
|
||||
required: true
|
||||
deprecated: false
|
||||
/v1alpha/telemetry/traces:
|
||||
post:
|
||||
responses:
|
||||
'200':
|
||||
description: A QueryTracesResponse.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/QueryTracesResponse'
|
||||
'400':
|
||||
$ref: '#/components/responses/BadRequest400'
|
||||
'429':
|
||||
$ref: >-
|
||||
#/components/responses/TooManyRequests429
|
||||
'500':
|
||||
$ref: >-
|
||||
#/components/responses/InternalServerError500
|
||||
default:
|
||||
$ref: '#/components/responses/DefaultError'
|
||||
tags:
|
||||
- Telemetry
|
||||
summary: Query traces.
|
||||
description: Query traces.
|
||||
parameters: []
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/QueryTracesRequest'
|
||||
required: true
|
||||
deprecated: false
|
||||
/v1alpha/telemetry/traces/{trace_id}:
|
||||
get:
|
||||
responses:
|
||||
'200':
|
||||
description: A Trace.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Trace'
|
||||
'400':
|
||||
$ref: '#/components/responses/BadRequest400'
|
||||
'429':
|
||||
$ref: >-
|
||||
#/components/responses/TooManyRequests429
|
||||
'500':
|
||||
$ref: >-
|
||||
#/components/responses/InternalServerError500
|
||||
default:
|
||||
$ref: '#/components/responses/DefaultError'
|
||||
tags:
|
||||
- Telemetry
|
||||
summary: Get a trace by its ID.
|
||||
description: Get a trace by its ID.
|
||||
parameters:
|
||||
- name: trace_id
|
||||
in: path
|
||||
description: The ID of the trace to get.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
deprecated: false
|
||||
/v1alpha/telemetry/traces/{trace_id}/spans/{span_id}:
|
||||
get:
|
||||
responses:
|
||||
'200':
|
||||
description: A Span.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Span'
|
||||
'400':
|
||||
$ref: '#/components/responses/BadRequest400'
|
||||
'429':
|
||||
$ref: >-
|
||||
#/components/responses/TooManyRequests429
|
||||
'500':
|
||||
$ref: >-
|
||||
#/components/responses/InternalServerError500
|
||||
default:
|
||||
$ref: '#/components/responses/DefaultError'
|
||||
tags:
|
||||
- Telemetry
|
||||
summary: Get a span by its ID.
|
||||
description: Get a span by its ID.
|
||||
parameters:
|
||||
- name: trace_id
|
||||
in: path
|
||||
description: >-
|
||||
The ID of the trace to get the span from.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
- name: span_id
|
||||
in: path
|
||||
description: The ID of the span to get.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
deprecated: false
|
||||
jsonSchemaDialect: >-
|
||||
https://json-schema.org/draft/2020-12/schema
|
||||
components:
|
||||
|
|
@ -10010,267 +9751,6 @@ components:
|
|||
description: >-
|
||||
Response from the synthetic data generation. Batch of (prompt, response, score)
|
||||
tuples that pass the threshold.
|
||||
Event:
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/UnstructuredLogEvent'
|
||||
- $ref: '#/components/schemas/MetricEvent'
|
||||
- $ref: '#/components/schemas/StructuredLogEvent'
|
||||
discriminator:
|
||||
propertyName: type
|
||||
mapping:
|
||||
unstructured_log: '#/components/schemas/UnstructuredLogEvent'
|
||||
metric: '#/components/schemas/MetricEvent'
|
||||
structured_log: '#/components/schemas/StructuredLogEvent'
|
||||
EventType:
|
||||
type: string
|
||||
enum:
|
||||
- unstructured_log
|
||||
- structured_log
|
||||
- metric
|
||||
title: EventType
|
||||
description: >-
|
||||
The type of telemetry event being logged.
|
||||
LogSeverity:
|
||||
type: string
|
||||
enum:
|
||||
- verbose
|
||||
- debug
|
||||
- info
|
||||
- warn
|
||||
- error
|
||||
- critical
|
||||
title: LogSeverity
|
||||
description: The severity level of a log message.
|
||||
MetricEvent:
|
||||
type: object
|
||||
properties:
|
||||
trace_id:
|
||||
type: string
|
||||
description: >-
|
||||
Unique identifier for the trace this event belongs to
|
||||
span_id:
|
||||
type: string
|
||||
description: >-
|
||||
Unique identifier for the span this event belongs to
|
||||
timestamp:
|
||||
type: string
|
||||
format: date-time
|
||||
description: Timestamp when the event occurred
|
||||
attributes:
|
||||
type: object
|
||||
additionalProperties:
|
||||
oneOf:
|
||||
- type: string
|
||||
- type: integer
|
||||
- type: number
|
||||
- type: boolean
|
||||
- type: 'null'
|
||||
description: >-
|
||||
(Optional) Key-value pairs containing additional metadata about the event
|
||||
type:
|
||||
$ref: '#/components/schemas/EventType'
|
||||
const: metric
|
||||
default: metric
|
||||
description: Event type identifier set to METRIC
|
||||
metric:
|
||||
type: string
|
||||
description: The name of the metric being measured
|
||||
value:
|
||||
oneOf:
|
||||
- type: integer
|
||||
- type: number
|
||||
description: >-
|
||||
The numeric value of the metric measurement
|
||||
unit:
|
||||
type: string
|
||||
description: >-
|
||||
The unit of measurement for the metric value
|
||||
additionalProperties: false
|
||||
required:
|
||||
- trace_id
|
||||
- span_id
|
||||
- timestamp
|
||||
- type
|
||||
- metric
|
||||
- value
|
||||
- unit
|
||||
title: MetricEvent
|
||||
description: >-
|
||||
A metric event containing a measured value.
|
||||
SpanEndPayload:
|
||||
type: object
|
||||
properties:
|
||||
type:
|
||||
$ref: '#/components/schemas/StructuredLogType'
|
||||
const: span_end
|
||||
default: span_end
|
||||
description: Payload type identifier set to SPAN_END
|
||||
status:
|
||||
$ref: '#/components/schemas/SpanStatus'
|
||||
description: >-
|
||||
The final status of the span indicating success or failure
|
||||
additionalProperties: false
|
||||
required:
|
||||
- type
|
||||
- status
|
||||
title: SpanEndPayload
|
||||
description: Payload for a span end event.
|
||||
SpanStartPayload:
|
||||
type: object
|
||||
properties:
|
||||
type:
|
||||
$ref: '#/components/schemas/StructuredLogType'
|
||||
const: span_start
|
||||
default: span_start
|
||||
description: >-
|
||||
Payload type identifier set to SPAN_START
|
||||
name:
|
||||
type: string
|
||||
description: >-
|
||||
Human-readable name describing the operation this span represents
|
||||
parent_span_id:
|
||||
type: string
|
||||
description: >-
|
||||
(Optional) Unique identifier for the parent span, if this is a child span
|
||||
additionalProperties: false
|
||||
required:
|
||||
- type
|
||||
- name
|
||||
title: SpanStartPayload
|
||||
description: Payload for a span start event.
|
||||
SpanStatus:
|
||||
type: string
|
||||
enum:
|
||||
- ok
|
||||
- error
|
||||
title: SpanStatus
|
||||
description: >-
|
||||
The status of a span indicating whether it completed successfully or with
|
||||
an error.
|
||||
StructuredLogEvent:
|
||||
type: object
|
||||
properties:
|
||||
trace_id:
|
||||
type: string
|
||||
description: >-
|
||||
Unique identifier for the trace this event belongs to
|
||||
span_id:
|
||||
type: string
|
||||
description: >-
|
||||
Unique identifier for the span this event belongs to
|
||||
timestamp:
|
||||
type: string
|
||||
format: date-time
|
||||
description: Timestamp when the event occurred
|
||||
attributes:
|
||||
type: object
|
||||
additionalProperties:
|
||||
oneOf:
|
||||
- type: string
|
||||
- type: integer
|
||||
- type: number
|
||||
- type: boolean
|
||||
- type: 'null'
|
||||
description: >-
|
||||
(Optional) Key-value pairs containing additional metadata about the event
|
||||
type:
|
||||
$ref: '#/components/schemas/EventType'
|
||||
const: structured_log
|
||||
default: structured_log
|
||||
description: >-
|
||||
Event type identifier set to STRUCTURED_LOG
|
||||
payload:
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/SpanStartPayload'
|
||||
- $ref: '#/components/schemas/SpanEndPayload'
|
||||
discriminator:
|
||||
propertyName: type
|
||||
mapping:
|
||||
span_start: '#/components/schemas/SpanStartPayload'
|
||||
span_end: '#/components/schemas/SpanEndPayload'
|
||||
description: >-
|
||||
The structured payload data for the log event
|
||||
additionalProperties: false
|
||||
required:
|
||||
- trace_id
|
||||
- span_id
|
||||
- timestamp
|
||||
- type
|
||||
- payload
|
||||
title: StructuredLogEvent
|
||||
description: >-
|
||||
A structured log event containing typed payload data.
|
||||
StructuredLogType:
|
||||
type: string
|
||||
enum:
|
||||
- span_start
|
||||
- span_end
|
||||
title: StructuredLogType
|
||||
description: >-
|
||||
The type of structured log event payload.
|
||||
UnstructuredLogEvent:
|
||||
type: object
|
||||
properties:
|
||||
trace_id:
|
||||
type: string
|
||||
description: >-
|
||||
Unique identifier for the trace this event belongs to
|
||||
span_id:
|
||||
type: string
|
||||
description: >-
|
||||
Unique identifier for the span this event belongs to
|
||||
timestamp:
|
||||
type: string
|
||||
format: date-time
|
||||
description: Timestamp when the event occurred
|
||||
attributes:
|
||||
type: object
|
||||
additionalProperties:
|
||||
oneOf:
|
||||
- type: string
|
||||
- type: integer
|
||||
- type: number
|
||||
- type: boolean
|
||||
- type: 'null'
|
||||
description: >-
|
||||
(Optional) Key-value pairs containing additional metadata about the event
|
||||
type:
|
||||
$ref: '#/components/schemas/EventType'
|
||||
const: unstructured_log
|
||||
default: unstructured_log
|
||||
description: >-
|
||||
Event type identifier set to UNSTRUCTURED_LOG
|
||||
message:
|
||||
type: string
|
||||
description: The log message text
|
||||
severity:
|
||||
$ref: '#/components/schemas/LogSeverity'
|
||||
description: The severity level of the log message
|
||||
additionalProperties: false
|
||||
required:
|
||||
- trace_id
|
||||
- span_id
|
||||
- timestamp
|
||||
- type
|
||||
- message
|
||||
- severity
|
||||
title: UnstructuredLogEvent
|
||||
description: >-
|
||||
An unstructured log event containing a simple text message.
|
||||
LogEventRequest:
|
||||
type: object
|
||||
properties:
|
||||
event:
|
||||
$ref: '#/components/schemas/Event'
|
||||
description: The event to log.
|
||||
ttl_seconds:
|
||||
type: integer
|
||||
description: The time to live of the event.
|
||||
additionalProperties: false
|
||||
required:
|
||||
- event
|
||||
- ttl_seconds
|
||||
title: LogEventRequest
|
||||
InvokeToolRequest:
|
||||
type: object
|
||||
properties:
|
||||
|
|
@ -13981,425 +13461,6 @@ components:
|
|||
- hyperparam_search_config
|
||||
- logger_config
|
||||
title: SupervisedFineTuneRequest
|
||||
QueryMetricsRequest:
|
||||
type: object
|
||||
properties:
|
||||
start_time:
|
||||
type: integer
|
||||
description: The start time of the metric to query.
|
||||
end_time:
|
||||
type: integer
|
||||
description: The end time of the metric to query.
|
||||
granularity:
|
||||
type: string
|
||||
description: The granularity of the metric to query.
|
||||
query_type:
|
||||
type: string
|
||||
enum:
|
||||
- range
|
||||
- instant
|
||||
description: The type of query to perform.
|
||||
label_matchers:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
description: The name of the label to match
|
||||
value:
|
||||
type: string
|
||||
description: The value to match against
|
||||
operator:
|
||||
type: string
|
||||
enum:
|
||||
- '='
|
||||
- '!='
|
||||
- =~
|
||||
- '!~'
|
||||
description: >-
|
||||
The comparison operator to use for matching
|
||||
default: '='
|
||||
additionalProperties: false
|
||||
required:
|
||||
- name
|
||||
- value
|
||||
- operator
|
||||
title: MetricLabelMatcher
|
||||
description: >-
|
||||
A matcher for filtering metrics by label values.
|
||||
description: >-
|
||||
The label matchers to apply to the metric.
|
||||
additionalProperties: false
|
||||
required:
|
||||
- start_time
|
||||
- query_type
|
||||
title: QueryMetricsRequest
|
||||
MetricDataPoint:
|
||||
type: object
|
||||
properties:
|
||||
timestamp:
|
||||
type: integer
|
||||
description: >-
|
||||
Unix timestamp when the metric value was recorded
|
||||
value:
|
||||
type: number
|
||||
description: >-
|
||||
The numeric value of the metric at this timestamp
|
||||
unit:
|
||||
type: string
|
||||
additionalProperties: false
|
||||
required:
|
||||
- timestamp
|
||||
- value
|
||||
- unit
|
||||
title: MetricDataPoint
|
||||
description: >-
|
||||
A single data point in a metric time series.
|
||||
MetricLabel:
|
||||
type: object
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
description: The name of the label
|
||||
value:
|
||||
type: string
|
||||
description: The value of the label
|
||||
additionalProperties: false
|
||||
required:
|
||||
- name
|
||||
- value
|
||||
title: MetricLabel
|
||||
description: A label associated with a metric.
|
||||
MetricSeries:
|
||||
type: object
|
||||
properties:
|
||||
metric:
|
||||
type: string
|
||||
description: The name of the metric
|
||||
labels:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/MetricLabel'
|
||||
description: >-
|
||||
List of labels associated with this metric series
|
||||
values:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/MetricDataPoint'
|
||||
description: >-
|
||||
List of data points in chronological order
|
||||
additionalProperties: false
|
||||
required:
|
||||
- metric
|
||||
- labels
|
||||
- values
|
||||
title: MetricSeries
|
||||
description: A time series of metric data points.
|
||||
QueryMetricsResponse:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/MetricSeries'
|
||||
description: >-
|
||||
List of metric series matching the query criteria
|
||||
additionalProperties: false
|
||||
required:
|
||||
- data
|
||||
title: QueryMetricsResponse
|
||||
description: >-
|
||||
Response containing metric time series data.
|
||||
QueryCondition:
|
||||
type: object
|
||||
properties:
|
||||
key:
|
||||
type: string
|
||||
description: The attribute key to filter on
|
||||
op:
|
||||
$ref: '#/components/schemas/QueryConditionOp'
|
||||
description: The comparison operator to apply
|
||||
value:
|
||||
oneOf:
|
||||
- type: 'null'
|
||||
- type: boolean
|
||||
- type: number
|
||||
- type: string
|
||||
- type: array
|
||||
- type: object
|
||||
description: The value to compare against
|
||||
additionalProperties: false
|
||||
required:
|
||||
- key
|
||||
- op
|
||||
- value
|
||||
title: QueryCondition
|
||||
description: A condition for filtering query results.
|
||||
QueryConditionOp:
|
||||
type: string
|
||||
enum:
|
||||
- eq
|
||||
- ne
|
||||
- gt
|
||||
- lt
|
||||
title: QueryConditionOp
|
||||
description: >-
|
||||
Comparison operators for query conditions.
|
||||
QuerySpansRequest:
|
||||
type: object
|
||||
properties:
|
||||
attribute_filters:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/QueryCondition'
|
||||
description: >-
|
||||
The attribute filters to apply to the spans.
|
||||
attributes_to_return:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
description: The attributes to return in the spans.
|
||||
max_depth:
|
||||
type: integer
|
||||
description: The maximum depth of the tree.
|
||||
additionalProperties: false
|
||||
required:
|
||||
- attribute_filters
|
||||
- attributes_to_return
|
||||
title: QuerySpansRequest
|
||||
Span:
|
||||
type: object
|
||||
properties:
|
||||
span_id:
|
||||
type: string
|
||||
description: Unique identifier for the span
|
||||
trace_id:
|
||||
type: string
|
||||
description: >-
|
||||
Unique identifier for the trace this span belongs to
|
||||
parent_span_id:
|
||||
type: string
|
||||
description: >-
|
||||
(Optional) Unique identifier for the parent span, if this is a child span
|
||||
name:
|
||||
type: string
|
||||
description: >-
|
||||
Human-readable name describing the operation this span represents
|
||||
start_time:
|
||||
type: string
|
||||
format: date-time
|
||||
description: Timestamp when the operation began
|
||||
end_time:
|
||||
type: string
|
||||
format: date-time
|
||||
description: >-
|
||||
(Optional) Timestamp when the operation finished, if completed
|
||||
attributes:
|
||||
type: object
|
||||
additionalProperties:
|
||||
oneOf:
|
||||
- type: 'null'
|
||||
- type: boolean
|
||||
- type: number
|
||||
- type: string
|
||||
- type: array
|
||||
- type: object
|
||||
description: >-
|
||||
(Optional) Key-value pairs containing additional metadata about the span
|
||||
additionalProperties: false
|
||||
required:
|
||||
- span_id
|
||||
- trace_id
|
||||
- name
|
||||
- start_time
|
||||
title: Span
|
||||
description: >-
|
||||
A span representing a single operation within a trace.
|
||||
QuerySpansResponse:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/Span'
|
||||
description: >-
|
||||
List of spans matching the query criteria
|
||||
additionalProperties: false
|
||||
required:
|
||||
- data
|
||||
title: QuerySpansResponse
|
||||
description: Response containing a list of spans.
|
||||
SaveSpansToDatasetRequest:
|
||||
type: object
|
||||
properties:
|
||||
attribute_filters:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/QueryCondition'
|
||||
description: >-
|
||||
The attribute filters to apply to the spans.
|
||||
attributes_to_save:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
description: The attributes to save to the dataset.
|
||||
dataset_id:
|
||||
type: string
|
||||
description: >-
|
||||
The ID of the dataset to save the spans to.
|
||||
max_depth:
|
||||
type: integer
|
||||
description: The maximum depth of the tree.
|
||||
additionalProperties: false
|
||||
required:
|
||||
- attribute_filters
|
||||
- attributes_to_save
|
||||
- dataset_id
|
||||
title: SaveSpansToDatasetRequest
|
||||
GetSpanTreeRequest:
|
||||
type: object
|
||||
properties:
|
||||
attributes_to_return:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
description: The attributes to return in the tree.
|
||||
max_depth:
|
||||
type: integer
|
||||
description: The maximum depth of the tree.
|
||||
additionalProperties: false
|
||||
title: GetSpanTreeRequest
|
||||
SpanWithStatus:
|
||||
type: object
|
||||
properties:
|
||||
span_id:
|
||||
type: string
|
||||
description: Unique identifier for the span
|
||||
trace_id:
|
||||
type: string
|
||||
description: >-
|
||||
Unique identifier for the trace this span belongs to
|
||||
parent_span_id:
|
||||
type: string
|
||||
description: >-
|
||||
(Optional) Unique identifier for the parent span, if this is a child span
|
||||
name:
|
||||
type: string
|
||||
description: >-
|
||||
Human-readable name describing the operation this span represents
|
||||
start_time:
|
||||
type: string
|
||||
format: date-time
|
||||
description: Timestamp when the operation began
|
||||
end_time:
|
||||
type: string
|
||||
format: date-time
|
||||
description: >-
|
||||
(Optional) Timestamp when the operation finished, if completed
|
||||
attributes:
|
||||
type: object
|
||||
additionalProperties:
|
||||
oneOf:
|
||||
- type: 'null'
|
||||
- type: boolean
|
||||
- type: number
|
||||
- type: string
|
||||
- type: array
|
||||
- type: object
|
||||
description: >-
|
||||
(Optional) Key-value pairs containing additional metadata about the span
|
||||
status:
|
||||
$ref: '#/components/schemas/SpanStatus'
|
||||
description: >-
|
||||
(Optional) The current status of the span
|
||||
additionalProperties: false
|
||||
required:
|
||||
- span_id
|
||||
- trace_id
|
||||
- name
|
||||
- start_time
|
||||
title: SpanWithStatus
|
||||
description: A span that includes status information.
|
||||
QuerySpanTreeResponse:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
type: object
|
||||
additionalProperties:
|
||||
$ref: '#/components/schemas/SpanWithStatus'
|
||||
description: >-
|
||||
Dictionary mapping span IDs to spans with status information
|
||||
additionalProperties: false
|
||||
required:
|
||||
- data
|
||||
title: QuerySpanTreeResponse
|
||||
description: >-
|
||||
Response containing a tree structure of spans.
|
||||
QueryTracesRequest:
|
||||
type: object
|
||||
properties:
|
||||
attribute_filters:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/QueryCondition'
|
||||
description: >-
|
||||
The attribute filters to apply to the traces.
|
||||
limit:
|
||||
type: integer
|
||||
description: The limit of traces to return.
|
||||
offset:
|
||||
type: integer
|
||||
description: The offset of the traces to return.
|
||||
order_by:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
description: The order by of the traces to return.
|
||||
additionalProperties: false
|
||||
title: QueryTracesRequest
|
||||
Trace:
|
||||
type: object
|
||||
properties:
|
||||
trace_id:
|
||||
type: string
|
||||
description: Unique identifier for the trace
|
||||
root_span_id:
|
||||
type: string
|
||||
description: >-
|
||||
Unique identifier for the root span that started this trace
|
||||
start_time:
|
||||
type: string
|
||||
format: date-time
|
||||
description: Timestamp when the trace began
|
||||
end_time:
|
||||
type: string
|
||||
format: date-time
|
||||
description: >-
|
||||
(Optional) Timestamp when the trace finished, if completed
|
||||
additionalProperties: false
|
||||
required:
|
||||
- trace_id
|
||||
- root_span_id
|
||||
- start_time
|
||||
title: Trace
|
||||
description: >-
|
||||
A trace representing the complete execution path of a request across multiple
|
||||
operations.
|
||||
QueryTracesResponse:
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/Trace'
|
||||
description: >-
|
||||
List of traces matching the query criteria
|
||||
additionalProperties: false
|
||||
required:
|
||||
- data
|
||||
title: QueryTracesResponse
|
||||
description: Response containing a list of traces.
|
||||
responses:
|
||||
BadRequest400:
|
||||
description: The request was invalid or malformed
|
||||
|
|
@ -14513,8 +13574,6 @@ tags:
|
|||
description: ''
|
||||
- name: SyntheticDataGeneration (Coming Soon)
|
||||
description: ''
|
||||
- name: Telemetry
|
||||
description: ''
|
||||
- name: ToolGroups
|
||||
description: ''
|
||||
- name: ToolRuntime
|
||||
|
|
@ -14542,7 +13601,6 @@ x-tagGroups:
|
|||
- ScoringFunctions
|
||||
- Shields
|
||||
- SyntheticDataGeneration (Coming Soon)
|
||||
- Telemetry
|
||||
- ToolGroups
|
||||
- ToolRuntime
|
||||
- VectorIO
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue