Package io.envoyproxy.envoy.config.trace.v3

Class OpenTelemetryConfig

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, OpenTelemetryConfigOrBuilder, Serializable
    public final class OpenTelemetryConfig
extends com.google.protobuf.GeneratedMessageV3
implements OpenTelemetryConfigOrBuilder
     Configuration for the OpenTelemetry tracer.
  [#extension: envoy.tracers.opentelemetry]
    Protobuf type envoy.config.trace.v3.OpenTelemetryConfig
    See Also:
    Serialized Form

    • Field Detail

      • GRPC_SERVICE_FIELD_NUMBER

        public static final int GRPC_SERVICE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • HTTP_SERVICE_FIELD_NUMBER

        public static final int HTTP_SERVICE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SERVICE_NAME_FIELD_NUMBER

        public static final int SERVICE_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • hasGrpcService

        public boolean hasGrpcService()
         The upstream gRPC cluster that will receive OTLP traces.
 Note that the tracer drops traces if the server does not read data fast enough.
 This field can be left empty to disable reporting traces to the gRPC service.
 Only one of ``grpc_service``, ``http_service`` may be used.
        .envoy.config.core.v3.GrpcService grpc_service = 1 [(.udpa.annotations.field_migrate) = { ... }
        Specified by:
        hasGrpcService in interface OpenTelemetryConfigOrBuilder
        Returns:
        Whether the grpcService field is set.

      • getGrpcService

        public GrpcService getGrpcService()
         The upstream gRPC cluster that will receive OTLP traces.
 Note that the tracer drops traces if the server does not read data fast enough.
 This field can be left empty to disable reporting traces to the gRPC service.
 Only one of ``grpc_service``, ``http_service`` may be used.
        .envoy.config.core.v3.GrpcService grpc_service = 1 [(.udpa.annotations.field_migrate) = { ... }
        Specified by:
        getGrpcService in interface OpenTelemetryConfigOrBuilder
        Returns:
        The grpcService.

      • getGrpcServiceOrBuilder

        public GrpcServiceOrBuilder getGrpcServiceOrBuilder()
         The upstream gRPC cluster that will receive OTLP traces.
 Note that the tracer drops traces if the server does not read data fast enough.
 This field can be left empty to disable reporting traces to the gRPC service.
 Only one of ``grpc_service``, ``http_service`` may be used.
        .envoy.config.core.v3.GrpcService grpc_service = 1 [(.udpa.annotations.field_migrate) = { ... }
        Specified by:
        getGrpcServiceOrBuilder in interface OpenTelemetryConfigOrBuilder

      • hasHttpService

        public boolean hasHttpService()
         The upstream HTTP cluster that will receive OTLP traces.
 This field can be left empty to disable reporting traces to the HTTP service.
 Only one of ``grpc_service``, ``http_service`` may be used.
 .. note::
   Note: The ``request_headers_to_add`` property in the OTLP HTTP exporter service
   does not support the :ref:`format specifier <config_access_log_format>` as used for
   :ref:`HTTP access logging <config_access_log>`.
   The values configured are added as HTTP headers on the OTLP export request
   without any formatting applied.
        .envoy.config.core.v3.HttpService http_service = 3 [(.udpa.annotations.field_migrate) = { ... }
        Specified by:
        hasHttpService in interface OpenTelemetryConfigOrBuilder
        Returns:
        Whether the httpService field is set.

      • getHttpService

        public HttpService getHttpService()
         The upstream HTTP cluster that will receive OTLP traces.
 This field can be left empty to disable reporting traces to the HTTP service.
 Only one of ``grpc_service``, ``http_service`` may be used.
 .. note::
   Note: The ``request_headers_to_add`` property in the OTLP HTTP exporter service
   does not support the :ref:`format specifier <config_access_log_format>` as used for
   :ref:`HTTP access logging <config_access_log>`.
   The values configured are added as HTTP headers on the OTLP export request
   without any formatting applied.
        .envoy.config.core.v3.HttpService http_service = 3 [(.udpa.annotations.field_migrate) = { ... }
        Specified by:
        getHttpService in interface OpenTelemetryConfigOrBuilder
        Returns:
        The httpService.

      • getHttpServiceOrBuilder

        public HttpServiceOrBuilder getHttpServiceOrBuilder()
         The upstream HTTP cluster that will receive OTLP traces.
 This field can be left empty to disable reporting traces to the HTTP service.
 Only one of ``grpc_service``, ``http_service`` may be used.
 .. note::
   Note: The ``request_headers_to_add`` property in the OTLP HTTP exporter service
   does not support the :ref:`format specifier <config_access_log_format>` as used for
   :ref:`HTTP access logging <config_access_log>`.
   The values configured are added as HTTP headers on the OTLP export request
   without any formatting applied.
        .envoy.config.core.v3.HttpService http_service = 3 [(.udpa.annotations.field_migrate) = { ... }
        Specified by:
        getHttpServiceOrBuilder in interface OpenTelemetryConfigOrBuilder

      • getServiceName

        public String getServiceName()
         The name for the service. This will be populated in the ResourceSpan Resource attributes.
 If it is not provided, it will default to "unknown_service:envoy".
        string service_name = 2;
        Specified by:
        getServiceName in interface OpenTelemetryConfigOrBuilder
        Returns:
        The serviceName.

      • getServiceNameBytes

        public com.google.protobuf.ByteString getServiceNameBytes()
         The name for the service. This will be populated in the ResourceSpan Resource attributes.
 If it is not provided, it will default to "unknown_service:envoy".
        string service_name = 2;
        Specified by:
        getServiceNameBytes in interface OpenTelemetryConfigOrBuilder
        Returns:
        The bytes for serviceName.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static OpenTelemetryConfig parseFrom​(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static OpenTelemetryConfig parseFrom​(ByteBuffer data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static OpenTelemetryConfig parseFrom​(com.google.protobuf.ByteString data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static OpenTelemetryConfig parseFrom​(com.google.protobuf.ByteString data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static OpenTelemetryConfig parseFrom​(byte[] data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static OpenTelemetryConfig parseFrom​(byte[] data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static OpenTelemetryConfig parseFrom​(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException
        Throws:
        IOException

      • newBuilderForType

        public OpenTelemetryConfig.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public OpenTelemetryConfig.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected OpenTelemetryConfig.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<OpenTelemetryConfig> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public OpenTelemetryConfig getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder