Package io.opentelemetry.exporter.otlp.trace

Class OtlpGrpcSpanExporter

java.lang.Object
io.opentelemetry.exporter.otlp.trace.OtlpGrpcSpanExporter
All Implemented Interfaces:
io.opentelemetry.sdk.trace.export.SpanExporter, Closeable, AutoCloseable
@ThreadSafe public final class OtlpGrpcSpanExporter extends Object implements io.opentelemetry.sdk.trace.export.SpanExporter
Exports spans using OTLP via gRPC, using OpenTelemetry's protobuf model.

  • Method Summary

    Modifier and Type
    Method
    Description
    static OtlpGrpcSpanExporterBuilder
    builder()
    Returns a new builder instance for this exporter.
    io.opentelemetry.sdk.common.CompletableResultCode
    export(Collection<io.opentelemetry.sdk.trace.data.SpanData> spans)
    Submits all the given spans in a single batch to the OpenTelemetry collector.
    io.opentelemetry.sdk.common.CompletableResultCode
    flush()
    The OTLP exporter does not batch spans, so this method will immediately return with success.
    static OtlpGrpcSpanExporter
    getDefault()
    Returns a new OtlpGrpcSpanExporter using the default values.
    io.opentelemetry.sdk.common.CompletableResultCode
    shutdown()
    Initiates an orderly shutdown in which preexisting calls continue but new calls are immediately cancelled.
    OtlpGrpcSpanExporterBuilder
    toBuilder()
    Returns a builder with configuration values equal to those for this exporter.
    String
    toString()
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface io.opentelemetry.sdk.trace.export.SpanExporter

    close

  • Method Details

    • getDefault

      public static OtlpGrpcSpanExporter getDefault()
      Returns a new OtlpGrpcSpanExporter using the default values.

      To load configuration values from environment variables and system properties, use opentelemetry-sdk-extension-autoconfigure.

      Returns:
      a new OtlpGrpcSpanExporter instance.

    • builder

      public static OtlpGrpcSpanExporterBuilder builder()
      Returns a new builder instance for this exporter.
      Returns:
      a new builder instance for this exporter.

    • toBuilder

      public OtlpGrpcSpanExporterBuilder toBuilder()
      Returns a builder with configuration values equal to those for this exporter.

      IMPORTANT: Be sure to shutdown() this instance if it will no longer be used.

      Since:
      1.29.0

    • export

      public io.opentelemetry.sdk.common.CompletableResultCode export(Collection<io.opentelemetry.sdk.trace.data.SpanData> spans)
      Submits all the given spans in a single batch to the OpenTelemetry collector.
      Specified by:
      export in interface io.opentelemetry.sdk.trace.export.SpanExporter
      Parameters:
      spans - the list of sampled Spans to be exported.
      Returns:
      the result of the operation

    • flush

      public io.opentelemetry.sdk.common.CompletableResultCode flush()
      The OTLP exporter does not batch spans, so this method will immediately return with success.
      Specified by:
      flush in interface io.opentelemetry.sdk.trace.export.SpanExporter
      Returns:
      always Success

    • shutdown

      public io.opentelemetry.sdk.common.CompletableResultCode shutdown()
      Initiates an orderly shutdown in which preexisting calls continue but new calls are immediately cancelled.
      Specified by:
      shutdown in interface io.opentelemetry.sdk.trace.export.SpanExporter

    • toString

      public String toString()
      Overrides:
      toString in class Object