Interface LogSpanAnnotationsParams

Parameters to log multiple span annotations

interface LogSpanAnnotationsParams {
    client?: {
        config: ClientOptions;
        DELETE: ClientMethod<paths, "delete", `${string}/${string}`>;
        GET: ClientMethod<paths, "get", `${string}/${string}`>;
        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}`>;
        TRACE: ClientMethod<paths, "trace", `${string}/${string}`>;
        eject(...middleware: Middleware[]): void;
        use(...middleware: Middleware[]): void;
    };
    spanAnnotations: SpanAnnotation[];
    sync?: boolean;
}

Hierarchy (View Summary)

Properties

client? spanAnnotations sync?

Properties

Optionalclient

client?: {
    config: ClientOptions;
    DELETE: ClientMethod<paths, "delete", `${string}/${string}`>;
    GET: ClientMethod<paths, "get", `${string}/${string}`>;
    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}`>;
    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

  • 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

  • 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

spanAnnotations

spanAnnotations: SpanAnnotation[]

The span annotations to log

Optionalsync

sync?: boolean

If true, the request will be fulfilled synchronously and return the annotation IDs. If false, the request will be processed asynchronously and return null.

Default

false

Settings

Member Visibility

On This Page

Properties