xk6-client-prometheus-remote
    Preparing search index...

    Interface ClientConfig

    Configuration options for the Remote Write client.

    const config = {
        url: "https://user:pass@prometheus.example.com/api/v1/write",
        user_agent: "my-k6-test",
        tenant_name: "team-a",
        timeout: "30s",
        headers: {
            "X-Custom-Header": "value"
        }
    };
    interface ClientConfig {
        headers?: Record<string, string>;
        tenant_name?: string;
        timeout?: string;
        url: string;
        user_agent?: string;
    }
    Index

    Properties

    headers? tenant_name? timeout? url user_agent?

    Properties

    headers?: Record<string, string>

    Optional custom headers to send with requests.

    tenant_name?: string

    Optional tenant name for multi-tenant environments. Typically sent as X-Scope-OrgID header.

    timeout?: string

    Optional request timeout (e.g., "20s", "5m"). Default is "10s".

    url: string

    The URL of the Prometheus remote write endpoint. Can include basic auth credentials: https://user:password@host/path

    user_agent?: string

    Optional custom User-Agent header value. Default is "k6-remote-write/0.0.2".

    Settings

    On This Page

    Properties