Create Span

spans.create() -> Span

POST/spans

Create a new span with the provided parameters

ParametersExpand Collapse

name: str

Name that describes what operation this span represents

start_time: Union[str, datetime]

The time the span started

formatdate-time

trace_id: str

Unique identifier for the trace this span belongs to

id: Optional[str]

Unique identifier for the span. If not provided, an ID will be generated.

data: Optional[Union[Dict[str, object], Iterable[Dict[str, object]], null]]

Any additional metadata or context for the span

One of the following:

Dict[str, object]

Iterable[Dict[str, object]]

end_time: Optional[Union[str, datetime, null]]

The time the span ended

formatdate-time

input: Optional[Union[Dict[str, object], Iterable[Dict[str, object]], null]]

Input parameters or data for the operation

One of the following:

Dict[str, object]

Iterable[Dict[str, object]]

output: Optional[Union[Dict[str, object], Iterable[Dict[str, object]], null]]

Output data resulting from the operation

One of the following:

Dict[str, object]

Iterable[Dict[str, object]]

parent_id: Optional[str]

ID of the parent span if this is a child span in a trace

task_id: Optional[str]

ID of the task this span belongs to

ReturnsExpand Collapse

class Span: …

id: str

name: str

Name that describes what operation this span represents

start_time: datetime

The time the span started

formatdate-time

trace_id: str

Unique identifier for the trace this span belongs to

data: Optional[Union[Dict[str, object], List[Dict[str, object]], null]]

Any additional metadata or context for the span

One of the following:

Dict[str, object]

List[Dict[str, object]]

end_time: Optional[datetime]

The time the span ended

formatdate-time

input: Optional[Union[Dict[str, object], List[Dict[str, object]], null]]

Input parameters or data for the operation

One of the following:

Dict[str, object]

List[Dict[str, object]]

output: Optional[Union[Dict[str, object], List[Dict[str, object]], null]]

Output data resulting from the operation

One of the following:

Dict[str, object]

List[Dict[str, object]]

parent_id: Optional[str]

ID of the parent span if this is a child span in a trace

task_id: Optional[str]

ID of the task this span belongs to

Create Span

import os
from datetime import datetime
from agentex import Agentex

client = Agentex(
    api_key=os.environ.get("AGENTEX_SDK_API_KEY"),  # This is the default and can be omitted
)
span = client.spans.create(
    name="name",
    start_time=datetime.fromisoformat("2019-12-27T18:11:19.117"),
    trace_id="trace_id",
)
print(span.id)

{
  "id": "id",
  "name": "name",
  "start_time": "2019-12-27T18:11:19.117Z",
  "trace_id": "trace_id",
  "data": {
    "foo": "bar"
  },
  "end_time": "2019-12-27T18:11:19.117Z",
  "input": {
    "foo": "bar"
  },
  "output": {
    "foo": "bar"
  },
  "parent_id": "parent_id",
  "task_id": "task_id"
}

Returns Examples

{
  "id": "id",
  "name": "name",
  "start_time": "2019-12-27T18:11:19.117Z",
  "trace_id": "trace_id",
  "data": {
    "foo": "bar"
  },
  "end_time": "2019-12-27T18:11:19.117Z",
  "input": {
    "foo": "bar"
  },
  "output": {
    "foo": "bar"
  },
  "parent_id": "parent_id",
  "task_id": "task_id"
}