trace

Update Trace

Changed on

Update a trace with the given ID.

patch/public/v2/projects/{project_id}/traces/{trace_id}

Request

  • Base URL
    https://api.galileo.ai
  • URL
    https://api.galileo.ai/public/v2/projects/{project_id}/traces/{trace_id}
  • Auth
    • API key in header Splunk-AO-API-Key
    • or API key in header Galileo-API-Key
    • or OAuth 2
      Password
      Token URL: https://api.galileo.ai/login
    • or HTTP basic

Path parameters

trace_idstring uuid4 required
project_idstring uuid4 required

Request body

log_stream_idstring uuid4 nullable

Log stream id associated with the traces.

experiment_idstring uuid4 nullable

Experiment id associated with the traces.

metrics_testing_idstring uuid4 nullable

Metrics testing id associated with the traces.

logging_method'playground' | 'python_client' | 'typescript_client' | 'api_direct'
client_versionstring nullable
reliableboolean

Whether or not to use reliable logging. If set to False, the method will respond immediately before verifying that the traces have been successfully ingested, and no error message will be returned if ingestion fails. If set to True, the method will wait for the traces to be durably accepted or return an error message if there is an ingestion failure. On the streaming write path (kafka_metrics_pipeline) accepted means acknowledged by Kafka; the records become readable after the data-writer flush, about GALILEO_STREAMING_EXPECTED_LAG_SECONDS (default 2.5 s) later, so a read issued immediately after the response can miss them.

trace_idstring uuid4 required

Trace id to update.

inputstring nullable

Input of the trace. Overwrites previous value if present.

outputstring nullable

Output of the trace. Overwrites previous value if present.

status_codeinteger nullable

Status code of the trace. Overwrites previous value if present.

tagsstring[] nullable

Tags to add to the trace.

is_completeboolean nullable

Whether or not the records in this request are complete.

duration_nsinteger nullable

Duration in nanoseconds. Overwrites previous value if present.

Response

Successful Response

log_stream_idstring uuid4 nullable

Log stream id associated with the traces.

experiment_idstring uuid4 nullable

Experiment id associated with the traces.

metrics_testing_idstring uuid4 nullable

Metrics testing id associated with the traces.

project_idstring uuid4 required

Project id associated with the traces.

project_namestring required

Project name associated with the traces.

session_idstring uuid4 nullable

Session id associated with the traces.

records_countinteger required

Total number of records ingested

trace_idstring uuid4 required

Trace id associated with the updated trace.

Changes