Module io.helidon.telemetry.otelconfig
Package io.helidon.telemetry.otelconfig

Interface HelidonOpenTelemetry

All Superinterfaces:
RuntimeType.Api<OpenTelemetryConfig>
public interface HelidonOpenTelemetry extends RuntimeType.Api<OpenTelemetryConfig>
Public access to OpenTelemetry as managed via Helidon config and builders.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    CONFIG_KEY
    Top-level config key for telemetry settings.

  • Method Summary

    Modifier and Type
    Method
    Description
    static OpenTelemetryConfig.Builder
    builder()
    Creates a new builder for HelidonOpenTelemetry.
    static HelidonOpenTelemetry
    create(OpenTelemetryConfig config)
    Creates a new HelidonOpenTelemetry from config.
    static HelidonOpenTelemetry
    create(Consumer<OpenTelemetryConfig.Builder> consumer)
    Builds a new HelidonOpenTelemetry instance by revising and then building the supplied builder.
    static void
    global(io.opentelemetry.api.OpenTelemetry openTelemetry, String serviceName, Map<String,String> tags)
    Initializes the specified OpenTelemetry instance as global: Sets it as the global OpenTelemetry instance. Creates a new Helidon Tracer using the OpenTelemetry instance. Makes the Helidon Tracer the global tracer. Registers the OpenTelemetry instance in the Helidon service registry.
    io.opentelemetry.api.OpenTelemetry
    openTelemetry()
    Returns the OpenTelemetry instance managed by Helidon.

    Methods inherited from interface io.helidon.builder.api.RuntimeType.Api

    prototype

  • Field Details

  • Method Details

    • builder

      static OpenTelemetryConfig.Builder builder()
      Creates a new builder for HelidonOpenTelemetry.
      Returns:
      new builder

    • create

      static HelidonOpenTelemetry create(OpenTelemetryConfig config)
      Creates a new HelidonOpenTelemetry from config.
      Parameters:
      config - the config node to use in building the result
      Returns:
      new HelidonOpenTelemetry based on the supplied config

    • create

      static HelidonOpenTelemetry create(Consumer<OpenTelemetryConfig.Builder> consumer)
      Builds a new HelidonOpenTelemetry instance by revising and then building the supplied builder.
      Parameters:
      consumer - consumer of a builder for HelidonOpenTelemetry
      Returns:
      new instance

    • global

      static void global(io.opentelemetry.api.OpenTelemetry openTelemetry, String serviceName, Map<String,String> tags) throws IllegalStateException
      Initializes the specified OpenTelemetry instance as global:
      1. Sets it as the global OpenTelemetry instance.
      2. Creates a new Helidon Tracer using the OpenTelemetry instance.
      3. Makes the Helidon Tracer the global tracer.
      4. Registers the OpenTelemetry instance in the Helidon service registry.
      Parameters:
      openTelemetry - the OpenTelemetry instance to make global
      serviceName - service name with which to create the new global tracer
      tags - tags to be applied to every span
      Throws:
      IllegalStateException - if other code has already established the OpenTelemetry global instance

    • openTelemetry

      io.opentelemetry.api.OpenTelemetry openTelemetry()
      Returns the OpenTelemetry instance managed by Helidon.
      Returns:
      the OpenTelemetry instance