Class SkyWalkingConfig.Builder

java.lang.Object
codes.grow.packages.skywalking.SkyWalkingConfig.Builder
Enclosing class:
SkyWalkingConfig

public static final class SkyWalkingConfig.Builder extends Object
Builder of the configuration.

Unset fields take the environment (when fromEnv(EnvReader) is called) or the default.

  • Method Details

    • fromEnv

      public SkyWalkingConfig.Builder fromEnv(EnvReader env)
      Fills every field that was not set explicitly from the environment: url (URL, GROW_SKYWALKING_URL, SW_GRAPHQL_URL without /graphql, SW_OAP_ADDRESS), GRAPHQL_PATH, otlpEndpoint (OTLP_ENDPOINT, OTEL_EXPORTER_OTLP_TRACES_ENDPOINT, OTEL_EXPORTER_OTLP_ENDPOINT, SW_AGENT_COLLECTOR_BACKEND_SERVICES as http://host:port), otlpProtocol, otlpHeaders (OTEL_EXPORTER_OTLP_[TRACES_]HEADERS), authentication (AUTHENTICATION, SW_AUTHENTICATION, SW_AGENT_AUTHENTICATION), zipkinUrl (ZIPKIN_URL, SW_ZIPKIN_ADDRESS plus /zipkin), TRACE_BACKEND and the common timeout, retry, TLS and proxy variables.
      Parameters:
      env - environment reader
      Returns:
      this builder
      Throws:
      ConfigException - when a variable holds an invalid value
    • url

      public SkyWalkingConfig.Builder url(String url)
      Sets the REST/GraphQL base URL (default http://127.0.0.1:12800); a trailing /graphql is stripped.
      Parameters:
      url - http or https URL
      Returns:
      this builder
    • graphqlPath

      public SkyWalkingConfig.Builder graphqlPath(String graphqlPath)
      Sets the GraphQL path (default /graphql).
      Parameters:
      graphqlPath - path starting with /
      Returns:
      this builder
    • otlpEndpoint

      public SkyWalkingConfig.Builder otlpEndpoint(String otlpEndpoint)
      Sets the OTLP endpoint (default http://<url host>:11800). Never point it at port 12800: OAP 10.4 serves OTLP over gRPC only.
      Parameters:
      otlpEndpoint - http or https URL
      Returns:
      this builder
    • otlpProtocol

      public SkyWalkingConfig.Builder otlpProtocol(OtlpProtocol otlpProtocol)
      Sets the OTLP protocol (default OtlpProtocol.GRPC).
      Parameters:
      otlpProtocol - protocol
      Returns:
      this builder
    • otlpHeader

      public SkyWalkingConfig.Builder otlpHeader(String name, String value)
      Adds an OTLP exporter header (gRPC metadata).
      Parameters:
      name - header name (lower-cased)
      value - header value
      Returns:
      this builder
    • otlpHeaders

      public SkyWalkingConfig.Builder otlpHeaders(Map<String,String> otlpHeaders)
      Replaces the OTLP exporter headers.
      Parameters:
      otlpHeaders - headers
      Returns:
      this builder
    • zipkinUrl

      public SkyWalkingConfig.Builder zipkinUrl(String zipkinUrl)
      Sets the Zipkin query API base (default http://<url host>:9412/zipkin).
      Parameters:
      zipkinUrl - http or https URL
      Returns:
      this builder
    • authentication

      public SkyWalkingConfig.Builder authentication(Secret authentication)
      Sets the OAP gRPC token (SW_AUTHENTICATION).
      Parameters:
      authentication - token
      Returns:
      this builder
    • authentication

      public SkyWalkingConfig.Builder authentication(String authentication)
      Sets the OAP gRPC token (SW_AUTHENTICATION).
      Parameters:
      authentication - token
      Returns:
      this builder
    • traceBackend

      public SkyWalkingConfig.Builder traceBackend(TraceBackend traceBackend)
      Sets the trace store read by SkyWalkingClient.traces() (default TraceBackend.AUTO).
      Parameters:
      traceBackend - backend
      Returns:
      this builder
    • connectTimeout

      public SkyWalkingConfig.Builder connectTimeout(Duration d)
      Sets the connect timeout (default 10 s).
      Parameters:
      d - positive duration
      Returns:
      this builder
    • requestTimeout

      public SkyWalkingConfig.Builder requestTimeout(Duration d)
      Sets the per-attempt timeout (default 30 s).
      Parameters:
      d - positive duration
      Returns:
      this builder
    • totalTimeout

      public SkyWalkingConfig.Builder totalTimeout(Duration d)
      Sets the total timeout per call including retries (default 120 s).
      Parameters:
      d - positive duration
      Returns:
      this builder
    • retry

      public SkyWalkingConfig.Builder retry(RetryPolicy retry)
      Sets the retry policy (default RetryPolicy.defaults()).
      Parameters:
      retry - policy
      Returns:
      this builder
    • tls

      Sets the TLS options; environment TLS variables are then ignored.
      Parameters:
      tls - options
      Returns:
      this builder
    • proxy

      public SkyWalkingConfig.Builder proxy(String proxy)
      Sets an explicit proxy URL; environment proxies (HTTPS_PROXY) are never used.
      Parameters:
      proxy - proxy URL
      Returns:
      this builder
    • header

      public SkyWalkingConfig.Builder header(String name, String value)
      Adds a header sent with every HTTP request (for example gateway credentials).
      Parameters:
      name - header name
      value - header value
      Returns:
      this builder
    • userAgentSuffix

      public SkyWalkingConfig.Builder userAgentSuffix(String suffix)
      Sets the text appended to the User-Agent.
      Parameters:
      suffix - suffix
      Returns:
      this builder
    • hooks

      public SkyWalkingConfig.Builder hooks(Hooks hooks)
      Sets request hooks.
      Parameters:
      hooks - hooks
      Returns:
      this builder
    • logger

      public SkyWalkingConfig.Builder logger(Logger logger)
      Sets the logger (default silent).
      Parameters:
      logger - logger
      Returns:
      this builder
    • build

      public SkyWalkingConfig build()
      Builds and validates the configuration.
      Returns:
      the configuration
      Throws:
      ConfigException - when a rule is violated