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

Interface OpenTelemetryAccessLogConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
OpenTelemetryAccessLogConfig, OpenTelemetryAccessLogConfig.Builder
public interface OpenTelemetryAccessLogConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    KeyValueList
    getAttributes()
    See 'attributes' in the LogResource proto for more details.
    KeyValueListOrBuilder
    getAttributesOrBuilder()
    See 'attributes' in the LogResource proto for more details.
    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>`_.
    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>`_.
    CommonGrpcAccessLogConfig
    getCommonConfig()
    [#comment:TODO(itamarkam): add 'filter_state_objects_to_log' to logs.]
    CommonGrpcAccessLogConfigOrBuilder
    getCommonConfigOrBuilder()
    [#comment:TODO(itamarkam): add 'filter_state_objects_to_log' to logs.]
    boolean
    getDisableBuiltinLabels()
    If specified, Envoy will not generate built-in resource labels like ``log_name``, ``zone_name``, ``cluster_name``, ``node_name``.
    TypedExtensionConfig
    getFormatters(int index)
    Specifies a collection of Formatter plugins that can be called from the access log configuration.
    int
    getFormattersCount()
    Specifies a collection of Formatter plugins that can be called from the access log configuration.
    List<TypedExtensionConfig>
    getFormattersList()
    Specifies a collection of Formatter plugins that can be called from the access log configuration.
    TypedExtensionConfigOrBuilder
    getFormattersOrBuilder(int index)
    Specifies a collection of Formatter plugins that can be called from the access log configuration.
    List<? extends TypedExtensionConfigOrBuilder>
    getFormattersOrBuilderList()
    Specifies a collection of Formatter plugins that can be called from the access log configuration.
    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.
    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.
    String
    getStatPrefix()
    Optional.
    com.google.protobuf.ByteString
    getStatPrefixBytes()
    Optional.
    boolean
    hasAttributes()
    See 'attributes' in the LogResource proto for more details.
    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>`_.
    boolean
    hasCommonConfig()
    [#comment:TODO(itamarkam): add 'filter_state_objects_to_log' to logs.]
    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.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • hasCommonConfig

      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) = { ... }
      Returns:
      Whether the commonConfig field is set.

    • getCommonConfig

      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) = { ... }
      Returns:
      The commonConfig.

    • getCommonConfigOrBuilder

      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) = { ... }

    • getDisableBuiltinLabels

      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;
      Returns:
      The disableBuiltinLabels.

    • hasResourceAttributes

      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;
      Returns:
      Whether the resourceAttributes field is set.

    • getResourceAttributes

      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;
      Returns:
      The resourceAttributes.

    • getResourceAttributesOrBuilder

      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;

    • hasBody

      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;
      Returns:
      Whether the body field is set.

    • getBody

      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;
      Returns:
      The body.

    • getBodyOrBuilder

      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;

    • hasAttributes

      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;
      Returns:
      Whether the attributes field is set.

    • getAttributes

      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;
      Returns:
      The attributes.

    • getAttributesOrBuilder

      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;

    • getStatPrefix

      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;
      Returns:
      The statPrefix.

    • getStatPrefixBytes

      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;
      Returns:
      The bytes for statPrefix.

    • getFormattersList

      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;

    • getFormatters

      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;

    • getFormattersCount

      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;

    • getFormattersOrBuilderList

      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;

    • getFormattersOrBuilder

      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;