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 Details

    • hasCommonConfig

      @Deprecated boolean hasCommonConfig()
      Deprecated.
      envoy.extensions.access_loggers.open_telemetry.v3.OpenTelemetryAccessLogConfig.common_config is deprecated. See envoy/extensions/access_loggers/open_telemetry/v3/logs_service.proto;l=35
       [#comment:TODO(itamarkam): add 'filter_state_objects_to_log' to logs.]
 Deprecated. Use ``grpc_service`` or ``http_service`` instead.
      .envoy.extensions.access_loggers.grpc.v3.CommonGrpcAccessLogConfig common_config = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Returns:
      Whether the commonConfig field is set.

    • getCommonConfig

      @Deprecated CommonGrpcAccessLogConfig getCommonConfig()
      Deprecated.
      envoy.extensions.access_loggers.open_telemetry.v3.OpenTelemetryAccessLogConfig.common_config is deprecated. See envoy/extensions/access_loggers/open_telemetry/v3/logs_service.proto;l=35
       [#comment:TODO(itamarkam): add 'filter_state_objects_to_log' to logs.]
 Deprecated. Use ``grpc_service`` or ``http_service`` instead.
      .envoy.extensions.access_loggers.grpc.v3.CommonGrpcAccessLogConfig common_config = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Returns:
      The commonConfig.

    • getCommonConfigOrBuilder

      @Deprecated CommonGrpcAccessLogConfigOrBuilder getCommonConfigOrBuilder()
      Deprecated.
       [#comment:TODO(itamarkam): add 'filter_state_objects_to_log' to logs.]
 Deprecated. Use ``grpc_service`` or ``http_service`` instead.
      .envoy.extensions.access_loggers.grpc.v3.CommonGrpcAccessLogConfig common_config = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];

    • hasHttpService

      boolean hasHttpService()
       The upstream HTTP cluster that will receive OTLP logs via
 `OTLP/HTTP <https://opentelemetry.io/docs/specs/otlp/#otlphttp>`_.
 Note: Only one of ``common_config``, ``grpc_service``, or ``http_service`` may be used.

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

    • getHttpService

      HttpService getHttpService()
       The upstream HTTP cluster that will receive OTLP logs via
 `OTLP/HTTP <https://opentelemetry.io/docs/specs/otlp/#otlphttp>`_.
 Note: Only one of ``common_config``, ``grpc_service``, or ``http_service`` may be used.

 .. 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 = 8;
      Returns:
      The httpService.

    • getHttpServiceOrBuilder

      HttpServiceOrBuilder getHttpServiceOrBuilder()
       The upstream HTTP cluster that will receive OTLP logs via
 `OTLP/HTTP <https://opentelemetry.io/docs/specs/otlp/#otlphttp>`_.
 Note: Only one of ``common_config``, ``grpc_service``, or ``http_service`` may be used.

 .. 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 = 8;

    • hasGrpcService

      boolean hasGrpcService()
       The upstream gRPC cluster that will receive OTLP logs.
 Note: Only one of ``common_config``, ``grpc_service``, or ``http_service`` may be used.
 This field is preferred over ``common_config.grpc_service``.
      .envoy.config.core.v3.GrpcService grpc_service = 9;
      Returns:
      Whether the grpcService field is set.

    • getGrpcService

      GrpcService getGrpcService()
       The upstream gRPC cluster that will receive OTLP logs.
 Note: Only one of ``common_config``, ``grpc_service``, or ``http_service`` may be used.
 This field is preferred over ``common_config.grpc_service``.
      .envoy.config.core.v3.GrpcService grpc_service = 9;
      Returns:
      The grpcService.

    • getGrpcServiceOrBuilder

      GrpcServiceOrBuilder getGrpcServiceOrBuilder()
       The upstream gRPC cluster that will receive OTLP logs.
 Note: Only one of ``common_config``, ``grpc_service``, or ``http_service`` may be used.
 This field is preferred over ``common_config.grpc_service``.
      .envoy.config.core.v3.GrpcService grpc_service = 9;

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

    • getLogName

      String getLogName()
      string log_name = 10;
      Returns:
      The logName.

    • getLogNameBytes

      com.google.protobuf.ByteString getLogNameBytes()
      string log_name = 10;
      Returns:
      The bytes for logName.

    • hasBufferFlushInterval

      boolean hasBufferFlushInterval()
       The interval for flushing access logs to the transport. Default: 1 second.
      .google.protobuf.Duration buffer_flush_interval = 11;
      Returns:
      Whether the bufferFlushInterval field is set.

    • getBufferFlushInterval

      com.google.protobuf.Duration getBufferFlushInterval()
       The interval for flushing access logs to the transport. Default: 1 second.
      .google.protobuf.Duration buffer_flush_interval = 11;
      Returns:
      The bufferFlushInterval.

    • getBufferFlushIntervalOrBuilder

      com.google.protobuf.DurationOrBuilder getBufferFlushIntervalOrBuilder()
       The interval for flushing access logs to the transport. Default: 1 second.
      .google.protobuf.Duration buffer_flush_interval = 11;

    • hasBufferSizeBytes

      boolean hasBufferSizeBytes()
       Soft size limit in bytes for the access log buffer. When the buffer exceeds
 this limit, logs will be flushed. Default: 16KB.
      .google.protobuf.UInt32Value buffer_size_bytes = 12;
      Returns:
      Whether the bufferSizeBytes field is set.

    • getBufferSizeBytes

      com.google.protobuf.UInt32Value getBufferSizeBytes()
       Soft size limit in bytes for the access log buffer. When the buffer exceeds
 this limit, logs will be flushed. Default: 16KB.
      .google.protobuf.UInt32Value buffer_size_bytes = 12;
      Returns:
      The bufferSizeBytes.

    • getBufferSizeBytesOrBuilder

      com.google.protobuf.UInt32ValueOrBuilder getBufferSizeBytesOrBuilder()
       Soft size limit in bytes for the access log buffer. When the buffer exceeds
 this limit, logs will be flushed. Default: 16KB.
      .google.protobuf.UInt32Value buffer_size_bytes = 12;

    • getFilterStateObjectsToLogList

      List<String> getFilterStateObjectsToLogList()
       Additional filter state objects to log as attributes.
      repeated string filter_state_objects_to_log = 13;
      Returns:
      A list containing the filterStateObjectsToLog.

    • getFilterStateObjectsToLogCount

      int getFilterStateObjectsToLogCount()
       Additional filter state objects to log as attributes.
      repeated string filter_state_objects_to_log = 13;
      Returns:
      The count of filterStateObjectsToLog.

    • getFilterStateObjectsToLog

      String getFilterStateObjectsToLog(int index)
       Additional filter state objects to log as attributes.
      repeated string filter_state_objects_to_log = 13;
      Parameters:
      index - The index of the element to return.
      Returns:
      The filterStateObjectsToLog at the given index.

    • getFilterStateObjectsToLogBytes

      com.google.protobuf.ByteString getFilterStateObjectsToLogBytes(int index)
       Additional filter state objects to log as attributes.
      repeated string filter_state_objects_to_log = 13;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the filterStateObjectsToLog at the given index.

    • getCustomTagsList

      List<CustomTag> getCustomTagsList()
       Custom tags to include as log attributes.
      repeated .envoy.type.tracing.v3.CustomTag custom_tags = 14;

    • getCustomTags

      CustomTag getCustomTags(int index)
       Custom tags to include as log attributes.
      repeated .envoy.type.tracing.v3.CustomTag custom_tags = 14;

    • getCustomTagsCount

      int getCustomTagsCount()
       Custom tags to include as log attributes.
      repeated .envoy.type.tracing.v3.CustomTag custom_tags = 14;

    • getCustomTagsOrBuilderList

      List<? extends CustomTagOrBuilder> getCustomTagsOrBuilderList()
       Custom tags to include as log attributes.
      repeated .envoy.type.tracing.v3.CustomTag custom_tags = 14;

    • getCustomTagsOrBuilder

      CustomTagOrBuilder getCustomTagsOrBuilder(int index)
       Custom tags to include as log attributes.
      repeated .envoy.type.tracing.v3.CustomTag custom_tags = 14;