Package io.envoyproxy.envoy.extensions.access_loggers.open_telemetry.v3

Class OpenTelemetryAccessLogConfig.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, OpenTelemetryAccessLogConfigOrBuilder, Cloneable
    Enclosing class:
    OpenTelemetryAccessLogConfig
    public static final class OpenTelemetryAccessLogConfig.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<OpenTelemetryAccessLogConfig.Builder>
implements OpenTelemetryAccessLogConfigOrBuilder
     Configuration for the built-in ``envoy.access_loggers.open_telemetry``
 :ref:`AccessLog <envoy_v3_api_msg_config.accesslog.v3.AccessLog>`. This configuration will
 populate `opentelemetry.proto.collector.v1.logs.ExportLogsServiceRequest.resource_logs <https://github.com/open-telemetry/opentelemetry-proto/blob/main/opentelemetry/proto/collector/logs/v1/logs_service.proto>`_.
 In addition, the request start time is set in the dedicated field.
 [#extension: envoy.access_loggers.open_telemetry]
    Protobuf type envoy.extensions.access_loggers.open_telemetry.v3.OpenTelemetryAccessLogConfig

    • Method Detail

      • 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.Builder<OpenTelemetryAccessLogConfig.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<OpenTelemetryAccessLogConfig.Builder>

      • getDefaultInstanceForType

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

      • build

        public OpenTelemetryAccessLogConfig build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public OpenTelemetryAccessLogConfig buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • isInitialized

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

      • mergeFrom

        public OpenTelemetryAccessLogConfig.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<OpenTelemetryAccessLogConfig.Builder>
        Throws:
        IOException

      • hasCommonConfig

        public boolean hasCommonConfig()
         [#comment:TODO(itamarkam): add 'filter_state_objects_to_log' to logs.]
        .envoy.extensions.access_loggers.grpc.v3.CommonGrpcAccessLogConfig common_config = 1 [(.validate.rules) = { ... }
        Specified by:
        hasCommonConfig in interface OpenTelemetryAccessLogConfigOrBuilder
        Returns:
        Whether the commonConfig field is set.

      • mergeCommonConfig

        public OpenTelemetryAccessLogConfig.Builder mergeCommonConfig​(CommonGrpcAccessLogConfig value)
         [#comment:TODO(itamarkam): add 'filter_state_objects_to_log' to logs.]
        .envoy.extensions.access_loggers.grpc.v3.CommonGrpcAccessLogConfig common_config = 1 [(.validate.rules) = { ... }

      • clearCommonConfig

        public OpenTelemetryAccessLogConfig.Builder clearCommonConfig()
         [#comment:TODO(itamarkam): add 'filter_state_objects_to_log' to logs.]
        .envoy.extensions.access_loggers.grpc.v3.CommonGrpcAccessLogConfig common_config = 1 [(.validate.rules) = { ... }

      • getCommonConfigBuilder

        public CommonGrpcAccessLogConfig.Builder getCommonConfigBuilder()
         [#comment:TODO(itamarkam): add 'filter_state_objects_to_log' to logs.]
        .envoy.extensions.access_loggers.grpc.v3.CommonGrpcAccessLogConfig common_config = 1 [(.validate.rules) = { ... }

      • hasResourceAttributes

        public boolean hasResourceAttributes()
         OpenTelemetry `Resource <https://github.com/open-telemetry/opentelemetry-proto/blob/main/opentelemetry/proto/logs/v1/logs.proto#L51>`_
 attributes are filled with Envoy node info.
 Example: ``resource_attributes { values { key: "region" value { string_value: "cn-north-7" } } }``.
        .opentelemetry.proto.common.v1.KeyValueList resource_attributes = 4;
        Specified by:
        hasResourceAttributes in interface OpenTelemetryAccessLogConfigOrBuilder
        Returns:
        Whether the resourceAttributes field is set.

      • getResourceAttributes

        public KeyValueList getResourceAttributes()
         OpenTelemetry `Resource <https://github.com/open-telemetry/opentelemetry-proto/blob/main/opentelemetry/proto/logs/v1/logs.proto#L51>`_
 attributes are filled with Envoy node info.
 Example: ``resource_attributes { values { key: "region" value { string_value: "cn-north-7" } } }``.
        .opentelemetry.proto.common.v1.KeyValueList resource_attributes = 4;
        Specified by:
        getResourceAttributes in interface OpenTelemetryAccessLogConfigOrBuilder
        Returns:
        The resourceAttributes.

      • setResourceAttributes

        public OpenTelemetryAccessLogConfig.Builder setResourceAttributes​(KeyValueList value)
         OpenTelemetry `Resource <https://github.com/open-telemetry/opentelemetry-proto/blob/main/opentelemetry/proto/logs/v1/logs.proto#L51>`_
 attributes are filled with Envoy node info.
 Example: ``resource_attributes { values { key: "region" value { string_value: "cn-north-7" } } }``.
        .opentelemetry.proto.common.v1.KeyValueList resource_attributes = 4;

      • setResourceAttributes

        public OpenTelemetryAccessLogConfig.Builder setResourceAttributes​(KeyValueList.Builder builderForValue)
         OpenTelemetry `Resource <https://github.com/open-telemetry/opentelemetry-proto/blob/main/opentelemetry/proto/logs/v1/logs.proto#L51>`_
 attributes are filled with Envoy node info.
 Example: ``resource_attributes { values { key: "region" value { string_value: "cn-north-7" } } }``.
        .opentelemetry.proto.common.v1.KeyValueList resource_attributes = 4;

      • mergeResourceAttributes

        public OpenTelemetryAccessLogConfig.Builder mergeResourceAttributes​(KeyValueList value)
         OpenTelemetry `Resource <https://github.com/open-telemetry/opentelemetry-proto/blob/main/opentelemetry/proto/logs/v1/logs.proto#L51>`_
 attributes are filled with Envoy node info.
 Example: ``resource_attributes { values { key: "region" value { string_value: "cn-north-7" } } }``.
        .opentelemetry.proto.common.v1.KeyValueList resource_attributes = 4;

      • clearResourceAttributes

        public OpenTelemetryAccessLogConfig.Builder clearResourceAttributes()
         OpenTelemetry `Resource <https://github.com/open-telemetry/opentelemetry-proto/blob/main/opentelemetry/proto/logs/v1/logs.proto#L51>`_
 attributes are filled with Envoy node info.
 Example: ``resource_attributes { values { key: "region" value { string_value: "cn-north-7" } } }``.
        .opentelemetry.proto.common.v1.KeyValueList resource_attributes = 4;

      • getResourceAttributesBuilder

        public KeyValueList.Builder getResourceAttributesBuilder()
         OpenTelemetry `Resource <https://github.com/open-telemetry/opentelemetry-proto/blob/main/opentelemetry/proto/logs/v1/logs.proto#L51>`_
 attributes are filled with Envoy node info.
 Example: ``resource_attributes { values { key: "region" value { string_value: "cn-north-7" } } }``.
        .opentelemetry.proto.common.v1.KeyValueList resource_attributes = 4;

      • getResourceAttributesOrBuilder

        public KeyValueListOrBuilder getResourceAttributesOrBuilder()
         OpenTelemetry `Resource <https://github.com/open-telemetry/opentelemetry-proto/blob/main/opentelemetry/proto/logs/v1/logs.proto#L51>`_
 attributes are filled with Envoy node info.
 Example: ``resource_attributes { values { key: "region" value { string_value: "cn-north-7" } } }``.
        .opentelemetry.proto.common.v1.KeyValueList resource_attributes = 4;
        Specified by:
        getResourceAttributesOrBuilder in interface OpenTelemetryAccessLogConfigOrBuilder

      • hasBody

        public boolean hasBody()
         OpenTelemetry `LogResource <https://github.com/open-telemetry/opentelemetry-proto/blob/main/opentelemetry/proto/logs/v1/logs.proto>`_
 fields, following `Envoy access logging formatting <https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage>`_.
 See 'body' in the LogResource proto for more details.
 Example: ``body { string_value: "%PROTOCOL%" }``.
        .opentelemetry.proto.common.v1.AnyValue body = 2;
        Specified by:
        hasBody in interface OpenTelemetryAccessLogConfigOrBuilder
        Returns:
        Whether the body field is set.

      • getBody

        public AnyValue getBody()
         OpenTelemetry `LogResource <https://github.com/open-telemetry/opentelemetry-proto/blob/main/opentelemetry/proto/logs/v1/logs.proto>`_
 fields, following `Envoy access logging formatting <https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage>`_.
 See 'body' in the LogResource proto for more details.
 Example: ``body { string_value: "%PROTOCOL%" }``.
        .opentelemetry.proto.common.v1.AnyValue body = 2;
        Specified by:
        getBody in interface OpenTelemetryAccessLogConfigOrBuilder
        Returns:
        The body.

      • setBody

        public OpenTelemetryAccessLogConfig.Builder setBody​(AnyValue value)
         OpenTelemetry `LogResource <https://github.com/open-telemetry/opentelemetry-proto/blob/main/opentelemetry/proto/logs/v1/logs.proto>`_
 fields, following `Envoy access logging formatting <https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage>`_.
 See 'body' in the LogResource proto for more details.
 Example: ``body { string_value: "%PROTOCOL%" }``.
        .opentelemetry.proto.common.v1.AnyValue body = 2;

      • setBody

        public OpenTelemetryAccessLogConfig.Builder setBody​(AnyValue.Builder builderForValue)
         OpenTelemetry `LogResource <https://github.com/open-telemetry/opentelemetry-proto/blob/main/opentelemetry/proto/logs/v1/logs.proto>`_
 fields, following `Envoy access logging formatting <https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage>`_.
 See 'body' in the LogResource proto for more details.
 Example: ``body { string_value: "%PROTOCOL%" }``.
        .opentelemetry.proto.common.v1.AnyValue body = 2;

      • mergeBody

        public OpenTelemetryAccessLogConfig.Builder mergeBody​(AnyValue value)
         OpenTelemetry `LogResource <https://github.com/open-telemetry/opentelemetry-proto/blob/main/opentelemetry/proto/logs/v1/logs.proto>`_
 fields, following `Envoy access logging formatting <https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage>`_.
 See 'body' in the LogResource proto for more details.
 Example: ``body { string_value: "%PROTOCOL%" }``.
        .opentelemetry.proto.common.v1.AnyValue body = 2;

      • clearBody

        public OpenTelemetryAccessLogConfig.Builder clearBody()
         OpenTelemetry `LogResource <https://github.com/open-telemetry/opentelemetry-proto/blob/main/opentelemetry/proto/logs/v1/logs.proto>`_
 fields, following `Envoy access logging formatting <https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage>`_.
 See 'body' in the LogResource proto for more details.
 Example: ``body { string_value: "%PROTOCOL%" }``.
        .opentelemetry.proto.common.v1.AnyValue body = 2;

      • getBodyBuilder

        public AnyValue.Builder getBodyBuilder()
         OpenTelemetry `LogResource <https://github.com/open-telemetry/opentelemetry-proto/blob/main/opentelemetry/proto/logs/v1/logs.proto>`_
 fields, following `Envoy access logging formatting <https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage>`_.
 See 'body' in the LogResource proto for more details.
 Example: ``body { string_value: "%PROTOCOL%" }``.
        .opentelemetry.proto.common.v1.AnyValue body = 2;

      • getBodyOrBuilder

        public AnyValueOrBuilder getBodyOrBuilder()
         OpenTelemetry `LogResource <https://github.com/open-telemetry/opentelemetry-proto/blob/main/opentelemetry/proto/logs/v1/logs.proto>`_
 fields, following `Envoy access logging formatting <https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage>`_.
 See 'body' in the LogResource proto for more details.
 Example: ``body { string_value: "%PROTOCOL%" }``.
        .opentelemetry.proto.common.v1.AnyValue body = 2;
        Specified by:
        getBodyOrBuilder in interface OpenTelemetryAccessLogConfigOrBuilder

      • hasAttributes

        public boolean hasAttributes()
         See 'attributes' in the LogResource proto for more details.
 Example: ``attributes { values { key: "user_agent" value { string_value: "%REQ(USER-AGENT)%" } } }``.
        .opentelemetry.proto.common.v1.KeyValueList attributes = 3;
        Specified by:
        hasAttributes in interface OpenTelemetryAccessLogConfigOrBuilder
        Returns:
        Whether the attributes field is set.

      • getAttributes

        public KeyValueList getAttributes()
         See 'attributes' in the LogResource proto for more details.
 Example: ``attributes { values { key: "user_agent" value { string_value: "%REQ(USER-AGENT)%" } } }``.
        .opentelemetry.proto.common.v1.KeyValueList attributes = 3;
        Specified by:
        getAttributes in interface OpenTelemetryAccessLogConfigOrBuilder
        Returns:
        The attributes.

      • setAttributes

        public OpenTelemetryAccessLogConfig.Builder setAttributes​(KeyValueList value)
         See 'attributes' in the LogResource proto for more details.
 Example: ``attributes { values { key: "user_agent" value { string_value: "%REQ(USER-AGENT)%" } } }``.
        .opentelemetry.proto.common.v1.KeyValueList attributes = 3;

      • setAttributes

        public OpenTelemetryAccessLogConfig.Builder setAttributes​(KeyValueList.Builder builderForValue)
         See 'attributes' in the LogResource proto for more details.
 Example: ``attributes { values { key: "user_agent" value { string_value: "%REQ(USER-AGENT)%" } } }``.
        .opentelemetry.proto.common.v1.KeyValueList attributes = 3;

      • mergeAttributes

        public OpenTelemetryAccessLogConfig.Builder mergeAttributes​(KeyValueList value)
         See 'attributes' in the LogResource proto for more details.
 Example: ``attributes { values { key: "user_agent" value { string_value: "%REQ(USER-AGENT)%" } } }``.
        .opentelemetry.proto.common.v1.KeyValueList attributes = 3;

      • clearAttributes

        public OpenTelemetryAccessLogConfig.Builder clearAttributes()
         See 'attributes' in the LogResource proto for more details.
 Example: ``attributes { values { key: "user_agent" value { string_value: "%REQ(USER-AGENT)%" } } }``.
        .opentelemetry.proto.common.v1.KeyValueList attributes = 3;

      • getAttributesBuilder

        public KeyValueList.Builder getAttributesBuilder()
         See 'attributes' in the LogResource proto for more details.
 Example: ``attributes { values { key: "user_agent" value { string_value: "%REQ(USER-AGENT)%" } } }``.
        .opentelemetry.proto.common.v1.KeyValueList attributes = 3;