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

Class OpenTelemetryAccessLogConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.access_loggers.open_telemetry.v3.OpenTelemetryAccessLogConfig
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, OpenTelemetryAccessLogConfigOrBuilder, Serializable
public final class OpenTelemetryAccessLogConfig extends com.google.protobuf.GeneratedMessageV3 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]
 [#next-free-field: 8]
Protobuf type envoy.extensions.access_loggers.open_telemetry.v3.OpenTelemetryAccessLogConfig
See Also:

  • Field Details

    • COMMON_CONFIG_FIELD_NUMBER

      public static final int COMMON_CONFIG_FIELD_NUMBER
      See Also:

    • DISABLE_BUILTIN_LABELS_FIELD_NUMBER

      public static final int DISABLE_BUILTIN_LABELS_FIELD_NUMBER
      See Also:

    • RESOURCE_ATTRIBUTES_FIELD_NUMBER

      public static final int RESOURCE_ATTRIBUTES_FIELD_NUMBER
      See Also:

    • BODY_FIELD_NUMBER

      public static final int BODY_FIELD_NUMBER
      See Also:

    • ATTRIBUTES_FIELD_NUMBER

      public static final int ATTRIBUTES_FIELD_NUMBER
      See Also:

    • STAT_PREFIX_FIELD_NUMBER

      public static final int STAT_PREFIX_FIELD_NUMBER
      See Also:

    • FORMATTERS_FIELD_NUMBER

      public static final int FORMATTERS_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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

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

    • getCommonConfig

      public CommonGrpcAccessLogConfig getCommonConfig()
       [#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:
      getCommonConfig in interface OpenTelemetryAccessLogConfigOrBuilder
      Returns:
      The commonConfig.

    • getCommonConfigOrBuilder

      public CommonGrpcAccessLogConfigOrBuilder getCommonConfigOrBuilder()
       [#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:
      getCommonConfigOrBuilder in interface OpenTelemetryAccessLogConfigOrBuilder

    • getDisableBuiltinLabels

      public boolean getDisableBuiltinLabels()
       If specified, Envoy will not generate built-in resource labels
 like ``log_name``, ``zone_name``, ``cluster_name``, ``node_name``.
      bool disable_builtin_labels = 5;
      Specified by:
      getDisableBuiltinLabels in interface OpenTelemetryAccessLogConfigOrBuilder
      Returns:
      The disableBuiltinLabels.

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

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

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

    • getAttributesOrBuilder

      public KeyValueListOrBuilder getAttributesOrBuilder()
       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:
      getAttributesOrBuilder in interface OpenTelemetryAccessLogConfigOrBuilder

    • getStatPrefix

      public String getStatPrefix()
       Optional. Additional prefix to use on OpenTelemetry access logger stats. If empty, the stats will be rooted at
 ``access_logs.open_telemetry_access_log.``. If non-empty, stats will be rooted at
 ``access_logs.open_telemetry_access_log.<stat_prefix>.``.
      string stat_prefix = 6;
      Specified by:
      getStatPrefix in interface OpenTelemetryAccessLogConfigOrBuilder
      Returns:
      The statPrefix.

    • getStatPrefixBytes

      public com.google.protobuf.ByteString getStatPrefixBytes()
       Optional. Additional prefix to use on OpenTelemetry access logger stats. If empty, the stats will be rooted at
 ``access_logs.open_telemetry_access_log.``. If non-empty, stats will be rooted at
 ``access_logs.open_telemetry_access_log.<stat_prefix>.``.
      string stat_prefix = 6;
      Specified by:
      getStatPrefixBytes in interface OpenTelemetryAccessLogConfigOrBuilder
      Returns:
      The bytes for statPrefix.

    • getFormattersList

      public List<TypedExtensionConfig> getFormattersList()
       Specifies a collection of Formatter plugins that can be called from the access log configuration.
 See the formatters extensions documentation for details.
 [#extension-category: envoy.formatter]
      repeated .envoy.config.core.v3.TypedExtensionConfig formatters = 7;
      Specified by:
      getFormattersList in interface OpenTelemetryAccessLogConfigOrBuilder

    • getFormattersOrBuilderList

      public List<? extends TypedExtensionConfigOrBuilder> getFormattersOrBuilderList()
       Specifies a collection of Formatter plugins that can be called from the access log configuration.
 See the formatters extensions documentation for details.
 [#extension-category: envoy.formatter]
      repeated .envoy.config.core.v3.TypedExtensionConfig formatters = 7;
      Specified by:
      getFormattersOrBuilderList in interface OpenTelemetryAccessLogConfigOrBuilder

    • getFormattersCount

      public int getFormattersCount()
       Specifies a collection of Formatter plugins that can be called from the access log configuration.
 See the formatters extensions documentation for details.
 [#extension-category: envoy.formatter]
      repeated .envoy.config.core.v3.TypedExtensionConfig formatters = 7;
      Specified by:
      getFormattersCount in interface OpenTelemetryAccessLogConfigOrBuilder

    • getFormatters

      public TypedExtensionConfig getFormatters(int index)
       Specifies a collection of Formatter plugins that can be called from the access log configuration.
 See the formatters extensions documentation for details.
 [#extension-category: envoy.formatter]
      repeated .envoy.config.core.v3.TypedExtensionConfig formatters = 7;
      Specified by:
      getFormatters in interface OpenTelemetryAccessLogConfigOrBuilder

    • getFormattersOrBuilder

      public TypedExtensionConfigOrBuilder getFormattersOrBuilder(int index)
       Specifies a collection of Formatter plugins that can be called from the access log configuration.
 See the formatters extensions documentation for details.
 [#extension-category: envoy.formatter]
      repeated .envoy.config.core.v3.TypedExtensionConfig formatters = 7;
      Specified by:
      getFormattersOrBuilder in interface OpenTelemetryAccessLogConfigOrBuilder

    • 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 OpenTelemetryAccessLogConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static OpenTelemetryAccessLogConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static OpenTelemetryAccessLogConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static OpenTelemetryAccessLogConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static OpenTelemetryAccessLogConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static OpenTelemetryAccessLogConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static OpenTelemetryAccessLogConfig.Builder newBuilder()

    • newBuilder

      public static OpenTelemetryAccessLogConfig.Builder newBuilder(OpenTelemetryAccessLogConfig prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static OpenTelemetryAccessLogConfig getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<OpenTelemetryAccessLogConfig> parser()

    • getParserForType

      public com.google.protobuf.Parser<OpenTelemetryAccessLogConfig> 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 OpenTelemetryAccessLogConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder