Arize Phoenix TS
    Preparing search index...

    Interface LogSpansParams

    Parameters to log spans to a project

    interface LogSpansParams {
        client?: {
            config: ClientOptions;
            DELETE: ClientMethod<paths, "delete", `${string}/${string}`>;
            GET: ClientMethod<paths, "get", `${string}/${string}`>;
            getServerVersion: () => Promise<SemanticVersion>;
            HEAD: ClientMethod<paths, "head", `${string}/${string}`>;
            OPTIONS: ClientMethod<paths, "options", `${string}/${string}`>;
            PATCH: ClientMethod<paths, "patch", `${string}/${string}`>;
            POST: ClientMethod<paths, "post", `${string}/${string}`>;
            PUT: ClientMethod<paths, "put", `${string}/${string}`>;
            request: ClientRequestMethod<paths, `${string}/${string}`>;
            TRACE: ClientMethod<paths, "trace", `${string}/${string}`>;
            eject(...middleware: Middleware[]): void;
            use(...middleware: Middleware[]): void;
        };
        project: ProjectIdentifier;
        spans: {
            attributes?: { [key: string]: unknown };
            context: { span_id: string; trace_id: string };
            end_time: string;
            events?: {
                attributes?: { [key: string]: unknown };
                name: string;
                timestamp: string;
            }[];
            id?: string;
            name: string;
            parent_id?: string
            | null;
            span_kind: string;
            start_time: string;
            status_code: string;
            status_message?: string;
        }[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    client? project spans

    Properties

    client?: {
        config: ClientOptions;
        DELETE: ClientMethod<paths, "delete", `${string}/${string}`>;
        GET: ClientMethod<paths, "get", `${string}/${string}`>;
        getServerVersion: () => Promise<SemanticVersion>;
        HEAD: ClientMethod<paths, "head", `${string}/${string}`>;
        OPTIONS: ClientMethod<paths, "options", `${string}/${string}`>;
        PATCH: ClientMethod<paths, "patch", `${string}/${string}`>;
        POST: ClientMethod<paths, "post", `${string}/${string}`>;
        PUT: ClientMethod<paths, "put", `${string}/${string}`>;
        request: ClientRequestMethod<paths, `${string}/${string}`>;
        TRACE: ClientMethod<paths, "trace", `${string}/${string}`>;
        eject(...middleware: Middleware[]): void;
        use(...middleware: Middleware[]): void;
    }

    An instance of the Phoenix client. If not provided, the client will be created using the default configuration.

    Type Declaration

    • config: ClientOptions
    • DELETE: ClientMethod<paths, "delete", `${string}/${string}`>

      Call a DELETE endpoint

    • GET: ClientMethod<paths, "get", `${string}/${string}`>

      Call a GET endpoint

    • getServerVersion: () => Promise<SemanticVersion>

      Get the Phoenix server version, returning a cached value if available.

      The version is first populated from the x-phoenix-server-version response header on any API call. If no version has been seen yet, this method fetches GET /arize_phoenix_version to populate the cache.

      If the server version cannot be determined (e.g. the server is unreachable or returned an unparseable version string).

    • HEAD: ClientMethod<paths, "head", `${string}/${string}`>

      Call a HEAD endpoint

    • OPTIONS: ClientMethod<paths, "options", `${string}/${string}`>

      Call a OPTIONS endpoint

    • PATCH: ClientMethod<paths, "patch", `${string}/${string}`>

      Call a PATCH endpoint

    • POST: ClientMethod<paths, "post", `${string}/${string}`>

      Call a POST endpoint

    • PUT: ClientMethod<paths, "put", `${string}/${string}`>

      Call a PUT endpoint

    • request: ClientRequestMethod<paths, `${string}/${string}`>
    • TRACE: ClientMethod<paths, "trace", `${string}/${string}`>

      Call a TRACE endpoint

    • eject: function
      • eject(...middleware: Middleware[]): void

        Unregister middleware

        Parameters

        • ...middleware: Middleware[]

        Returns void

    • use: function
      • use(...middleware: Middleware[]): void

        Register middleware

        Parameters

        • ...middleware: Middleware[]

        Returns void

    project: ProjectIdentifier

    The project to log spans into

    spans: {
        attributes?: { [key: string]: unknown };
        context: { span_id: string; trace_id: string };
        end_time: string;
        events?: {
            attributes?: { [key: string]: unknown };
            name: string;
            timestamp: string;
        }[];
        id?: string;
        name: string;
        parent_id?: string
        | null;
        span_kind: string;
        start_time: string;
        status_code: string;
        status_message?: string;
    }[]

    The spans to log

    Type Declaration

    • Optionalattributes?: { [key: string]: unknown }

      Attributes

      Span attributes

    • context: { span_id: string; trace_id: string }

      Span context containing trace_id and span_id

      • span_id: string

        Span Id

        OpenTelemetry span ID

      • trace_id: string

        Trace Id

        OpenTelemetry trace ID

    • end_time: string

      End Time Format: date-time

      End time of the span (must be timezone-aware)

    • Optionalevents?: { attributes?: { [key: string]: unknown }; name: string; timestamp: string }[]

      Events

      Span events

    • Optionalid?: string

      Id

      Span Global ID, distinct from the OpenTelemetry span ID
    • name: string

      Name

      Name of the span operation

    • Optionalparent_id?: string | null

      Parent Id

      OpenTelemetry span ID of the parent span

    • span_kind: string

      Span Kind

      Type of work that the span encapsulates

    • start_time: string

      Start Time Format: date-time

      Start time of the span (must be timezone-aware)

    • status_code: string

      Status Code

      Status code of the span

    • Optionalstatus_message?: string

      Status Message

      Status message

    Settings

    Member Visibility

    On This Page

    Properties