@grow-codes/apache-skywalking - v0.1.1
    Preparing search index...

    Interface SkyWalkingConfigOptions

    Options accepted by SkyWalkingConfig (all optional).

    interface SkyWalkingConfigOptions {
        authentication?: string | Secret;
        connectTimeoutMs?: number;
        graphqlPath?: string;
        headers?: Record<string, string>;
        hooks?: Hooks;
        logger?: ClientLogger;
        otlpEndpoint?: string;
        otlpHeaders?: Record<string, string>;
        otlpProtocol?: OtlpProtocol;
        proxy?: string;
        requestTimeoutMs?: number;
        retry?: RetryPolicyOptions | RetryPolicy;
        tls?: TlsOptions;
        totalTimeoutMs?: number;
        traceBackend?: TraceBackend;
        url?: string;
        userAgentSuffix?: string;
        zipkinUrl?: string;
    }

    Hierarchy (View Summary)

    Index
    authentication?: string | Secret

    OAP gRPC token (SW_AUTHENTICATION), sent as the authentication metadata on OTLP exports. OAP does not protect GraphQL or /v3/* with it.

    connectTimeoutMs?: number

    Connection setup timeout in ms (default 10 000).

    graphqlPath?: string

    Path of the GraphQL endpoint below url. Default /graphql.

    headers?: Record<string, string>

    Extra request headers.

    hooks?: Hooks

    Request/response hooks.

    logger?: ClientLogger

    Diagnostic logger (silent by default).

    otlpEndpoint?: string

    OTLP endpoint for initTracing (OAP gRPC receiver, port 11800). Default http://<url host>:11800.

    otlpHeaders?: Record<string, string>

    Extra OTLP exporter headers (gRPC metadata), e.g. for a gateway in front of OAP.

    otlpProtocol?: OtlpProtocol

    OTLP protocol. Default grpc (OAP 10.4 has no OTLP/HTTP receiver; use http/protobuf only when otlpEndpoint points at an OpenTelemetry Collector).

    proxy?: string

    Proxy URL. Environment proxies (HTTPS_PROXY, …) are ignored unless set here.

    requestTimeoutMs?: number

    Per-attempt timeout in ms, headers + body (default 30 000).

    Retry policy or its options.

    TLS settings.

    totalTimeoutMs?: number

    Whole-call timeout in ms including retries and backoff (default 120 000).

    traceBackend?: TraceBackend

    Trace store read by client.traces: zipkin (OTLP spans, read via the Zipkin query API), native (SkyWalking agent segments, read via GraphQL) or auto (default: hex ids via Zipkin first, then native; other ids native).

    url?: string

    OAP REST/GraphQL base URL (port 12800). Default http://127.0.0.1:12800. A trailing /graphql is stripped.

    userAgentSuffix?: string

    Appended after the standard User-Agent.

    zipkinUrl?: string

    Zipkin v2 query API base (OAP SW_QUERY_ZIPKIN). Default http://<url host>:9412/zipkin.