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: 15]Protobuf type
envoy.extensions.access_loggers.open_telemetry.v3.OpenTelemetryAccessLogConfig- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classConfiguration for the built-in ``envoy.access_loggers.open_telemetry`` :ref:`AccessLog <envoy_v3_api_msg_config.accesslog.v3.AccessLog>`.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanSee 'attributes' in the LogResource proto for more details.See 'attributes' in the LogResource proto for more details.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>`_.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>`_.com.google.protobuf.DurationThe interval for flushing access logs to the transport.com.google.protobuf.DurationOrBuilderThe interval for flushing access logs to the transport.com.google.protobuf.UInt32ValueSoft size limit in bytes for the access log buffer.com.google.protobuf.UInt32ValueOrBuilderSoft size limit in bytes for the access log buffer.Deprecated.envoy.extensions.access_loggers.open_telemetry.v3.OpenTelemetryAccessLogConfig.common_config is deprecated.Deprecated.getCustomTags(int index) Custom tags to include as log attributes.intCustom tags to include as log attributes.Custom tags to include as log attributes.getCustomTagsOrBuilder(int index) Custom tags to include as log attributes.List<? extends CustomTagOrBuilder>Custom tags to include as log attributes.static OpenTelemetryAccessLogConfigstatic final com.google.protobuf.Descriptors.DescriptorbooleanIf specified, Envoy will not generate built-in resource labels like ``log_name``, ``zone_name``, ``cluster_name``, ``node_name``.getFilterStateObjectsToLog(int index) Additional filter state objects to log as attributes.com.google.protobuf.ByteStringgetFilterStateObjectsToLogBytes(int index) Additional filter state objects to log as attributes.intAdditional filter state objects to log as attributes.com.google.protobuf.ProtocolStringListAdditional filter state objects to log as attributes.getFormatters(int index) Specifies a collection of Formatter plugins that can be called from the access log configuration.intSpecifies a collection of Formatter plugins that can be called from the access log configuration.Specifies a collection of Formatter plugins that can be called from the access log configuration.getFormattersOrBuilder(int index) Specifies a collection of Formatter plugins that can be called from the access log configuration.List<? extends TypedExtensionConfigOrBuilder>Specifies a collection of Formatter plugins that can be called from the access log configuration.The upstream gRPC cluster that will receive OTLP logs.The upstream gRPC cluster that will receive OTLP logs.The upstream HTTP cluster that will receive OTLP logs via `OTLP/HTTP <https://opentelemetry.io/docs/specs/otlp/#otlphttp>`_.The upstream HTTP cluster that will receive OTLP logs via `OTLP/HTTP <https://opentelemetry.io/docs/specs/otlp/#otlphttp>`_.string log_name = 10;com.google.protobuf.ByteStringstring log_name = 10;com.google.protobuf.Parser<OpenTelemetryAccessLogConfig>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.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.intOptional.com.google.protobuf.ByteStringOptional.booleanSee 'attributes' in the LogResource proto for more details.booleanhasBody()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>`_.booleanThe interval for flushing access logs to the transport.booleanSoft size limit in bytes for the access log buffer.booleanDeprecated.envoy.extensions.access_loggers.open_telemetry.v3.OpenTelemetryAccessLogConfig.common_config is deprecated.booleanThe upstream gRPC cluster that will receive OTLP logs.inthashCode()booleanThe upstream HTTP cluster that will receive OTLP logs via `OTLP/HTTP <https://opentelemetry.io/docs/specs/otlp/#otlphttp>`_.booleanOpenTelemetry `Resource <https://github.com/open-telemetry/opentelemetry-proto/blob/main/opentelemetry/proto/logs/v1/logs.proto#L51>`_ attributes are filled with Envoy node info.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleannewBuilder(OpenTelemetryAccessLogConfig prototype) protected OpenTelemetryAccessLogConfig.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static OpenTelemetryAccessLogConfigparseDelimitedFrom(InputStream input) static OpenTelemetryAccessLogConfigparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static OpenTelemetryAccessLogConfigparseFrom(byte[] data) static OpenTelemetryAccessLogConfigparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static OpenTelemetryAccessLogConfigparseFrom(com.google.protobuf.ByteString data) static OpenTelemetryAccessLogConfigparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static OpenTelemetryAccessLogConfigparseFrom(com.google.protobuf.CodedInputStream input) static OpenTelemetryAccessLogConfigparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static OpenTelemetryAccessLogConfigparseFrom(InputStream input) static OpenTelemetryAccessLogConfigparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static OpenTelemetryAccessLogConfigparseFrom(ByteBuffer data) static OpenTelemetryAccessLogConfigparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<OpenTelemetryAccessLogConfig>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
COMMON_CONFIG_FIELD_NUMBER
public static final int COMMON_CONFIG_FIELD_NUMBER- See Also:
-
HTTP_SERVICE_FIELD_NUMBER
public static final int HTTP_SERVICE_FIELD_NUMBER- See Also:
-
GRPC_SERVICE_FIELD_NUMBER
public static final int GRPC_SERVICE_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:
-
LOG_NAME_FIELD_NUMBER
public static final int LOG_NAME_FIELD_NUMBER- See Also:
-
BUFFER_FLUSH_INTERVAL_FIELD_NUMBER
public static final int BUFFER_FLUSH_INTERVAL_FIELD_NUMBER- See Also:
-
BUFFER_SIZE_BYTES_FIELD_NUMBER
public static final int BUFFER_SIZE_BYTES_FIELD_NUMBER- See Also:
-
FILTER_STATE_OBJECTS_TO_LOG_FIELD_NUMBER
public static final int FILTER_STATE_OBJECTS_TO_LOG_FIELD_NUMBER- See Also:
-
CUSTOM_TAGS_FIELD_NUMBER
public static final int CUSTOM_TAGS_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
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"];- Specified by:
hasCommonConfigin interfaceOpenTelemetryAccessLogConfigOrBuilder- Returns:
- Whether the commonConfig field is set.
-
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"];- Specified by:
getCommonConfigin interfaceOpenTelemetryAccessLogConfigOrBuilder- Returns:
- The commonConfig.
-
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"];- Specified by:
getCommonConfigOrBuilderin interfaceOpenTelemetryAccessLogConfigOrBuilder
-
hasHttpService
public 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;- Specified by:
hasHttpServicein interfaceOpenTelemetryAccessLogConfigOrBuilder- Returns:
- Whether the httpService field is set.
-
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;- Specified by:
getHttpServicein interfaceOpenTelemetryAccessLogConfigOrBuilder- Returns:
- The httpService.
-
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;- Specified by:
getHttpServiceOrBuilderin interfaceOpenTelemetryAccessLogConfigOrBuilder
-
hasGrpcService
public 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;- Specified by:
hasGrpcServicein interfaceOpenTelemetryAccessLogConfigOrBuilder- Returns:
- Whether the grpcService field is set.
-
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;- Specified by:
getGrpcServicein interfaceOpenTelemetryAccessLogConfigOrBuilder- Returns:
- The grpcService.
-
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;- Specified by:
getGrpcServiceOrBuilderin interfaceOpenTelemetryAccessLogConfigOrBuilder
-
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:
getDisableBuiltinLabelsin interfaceOpenTelemetryAccessLogConfigOrBuilder- 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:
hasResourceAttributesin interfaceOpenTelemetryAccessLogConfigOrBuilder- Returns:
- Whether the resourceAttributes field is set.
-
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:
getResourceAttributesin interfaceOpenTelemetryAccessLogConfigOrBuilder- Returns:
- The resourceAttributes.
-
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:
getResourceAttributesOrBuilderin interfaceOpenTelemetryAccessLogConfigOrBuilder
-
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:
hasBodyin interfaceOpenTelemetryAccessLogConfigOrBuilder- Returns:
- Whether the body field is set.
-
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:
getBodyin interfaceOpenTelemetryAccessLogConfigOrBuilder- Returns:
- The body.
-
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:
getBodyOrBuilderin interfaceOpenTelemetryAccessLogConfigOrBuilder
-
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:
hasAttributesin interfaceOpenTelemetryAccessLogConfigOrBuilder- Returns:
- Whether the attributes field is set.
-
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:
getAttributesin interfaceOpenTelemetryAccessLogConfigOrBuilder- Returns:
- The attributes.
-
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:
getAttributesOrBuilderin interfaceOpenTelemetryAccessLogConfigOrBuilder
-
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:
getStatPrefixin interfaceOpenTelemetryAccessLogConfigOrBuilder- 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:
getStatPrefixBytesin interfaceOpenTelemetryAccessLogConfigOrBuilder- Returns:
- The bytes for statPrefix.
-
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:
getFormattersListin interfaceOpenTelemetryAccessLogConfigOrBuilder
-
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:
getFormattersOrBuilderListin interfaceOpenTelemetryAccessLogConfigOrBuilder
-
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:
getFormattersCountin interfaceOpenTelemetryAccessLogConfigOrBuilder
-
getFormatters
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:
getFormattersin interfaceOpenTelemetryAccessLogConfigOrBuilder
-
getFormattersOrBuilder
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:
getFormattersOrBuilderin interfaceOpenTelemetryAccessLogConfigOrBuilder
-
getLogName
string log_name = 10;- Specified by:
getLogNamein interfaceOpenTelemetryAccessLogConfigOrBuilder- Returns:
- The logName.
-
getLogNameBytes
public com.google.protobuf.ByteString getLogNameBytes()string log_name = 10;- Specified by:
getLogNameBytesin interfaceOpenTelemetryAccessLogConfigOrBuilder- Returns:
- The bytes for logName.
-
hasBufferFlushInterval
public boolean hasBufferFlushInterval()The interval for flushing access logs to the transport. Default: 1 second.
.google.protobuf.Duration buffer_flush_interval = 11;- Specified by:
hasBufferFlushIntervalin interfaceOpenTelemetryAccessLogConfigOrBuilder- Returns:
- Whether the bufferFlushInterval field is set.
-
getBufferFlushInterval
public com.google.protobuf.Duration getBufferFlushInterval()The interval for flushing access logs to the transport. Default: 1 second.
.google.protobuf.Duration buffer_flush_interval = 11;- Specified by:
getBufferFlushIntervalin interfaceOpenTelemetryAccessLogConfigOrBuilder- Returns:
- The bufferFlushInterval.
-
getBufferFlushIntervalOrBuilder
public com.google.protobuf.DurationOrBuilder getBufferFlushIntervalOrBuilder()The interval for flushing access logs to the transport. Default: 1 second.
.google.protobuf.Duration buffer_flush_interval = 11;- Specified by:
getBufferFlushIntervalOrBuilderin interfaceOpenTelemetryAccessLogConfigOrBuilder
-
hasBufferSizeBytes
public 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;- Specified by:
hasBufferSizeBytesin interfaceOpenTelemetryAccessLogConfigOrBuilder- Returns:
- Whether the bufferSizeBytes field is set.
-
getBufferSizeBytes
public 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;- Specified by:
getBufferSizeBytesin interfaceOpenTelemetryAccessLogConfigOrBuilder- Returns:
- The bufferSizeBytes.
-
getBufferSizeBytesOrBuilder
public 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;- Specified by:
getBufferSizeBytesOrBuilderin interfaceOpenTelemetryAccessLogConfigOrBuilder
-
getFilterStateObjectsToLogList
public com.google.protobuf.ProtocolStringList getFilterStateObjectsToLogList()Additional filter state objects to log as attributes.
repeated string filter_state_objects_to_log = 13;- Specified by:
getFilterStateObjectsToLogListin interfaceOpenTelemetryAccessLogConfigOrBuilder- Returns:
- A list containing the filterStateObjectsToLog.
-
getFilterStateObjectsToLogCount
public int getFilterStateObjectsToLogCount()Additional filter state objects to log as attributes.
repeated string filter_state_objects_to_log = 13;- Specified by:
getFilterStateObjectsToLogCountin interfaceOpenTelemetryAccessLogConfigOrBuilder- Returns:
- The count of filterStateObjectsToLog.
-
getFilterStateObjectsToLog
Additional filter state objects to log as attributes.
repeated string filter_state_objects_to_log = 13;- Specified by:
getFilterStateObjectsToLogin interfaceOpenTelemetryAccessLogConfigOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The filterStateObjectsToLog at the given index.
-
getFilterStateObjectsToLogBytes
public com.google.protobuf.ByteString getFilterStateObjectsToLogBytes(int index) Additional filter state objects to log as attributes.
repeated string filter_state_objects_to_log = 13;- Specified by:
getFilterStateObjectsToLogBytesin interfaceOpenTelemetryAccessLogConfigOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the filterStateObjectsToLog at the given index.
-
getCustomTagsList
Custom tags to include as log attributes.
repeated .envoy.type.tracing.v3.CustomTag custom_tags = 14;- Specified by:
getCustomTagsListin interfaceOpenTelemetryAccessLogConfigOrBuilder
-
getCustomTagsOrBuilderList
Custom tags to include as log attributes.
repeated .envoy.type.tracing.v3.CustomTag custom_tags = 14;- Specified by:
getCustomTagsOrBuilderListin interfaceOpenTelemetryAccessLogConfigOrBuilder
-
getCustomTagsCount
public int getCustomTagsCount()Custom tags to include as log attributes.
repeated .envoy.type.tracing.v3.CustomTag custom_tags = 14;- Specified by:
getCustomTagsCountin interfaceOpenTelemetryAccessLogConfigOrBuilder
-
getCustomTags
Custom tags to include as log attributes.
repeated .envoy.type.tracing.v3.CustomTag custom_tags = 14;- Specified by:
getCustomTagsin interfaceOpenTelemetryAccessLogConfigOrBuilder
-
getCustomTagsOrBuilder
Custom tags to include as log attributes.
repeated .envoy.type.tracing.v3.CustomTag custom_tags = 14;- Specified by:
getCustomTagsOrBuilderin interfaceOpenTelemetryAccessLogConfigOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.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
- Throws:
IOException
-
parseFrom
public static OpenTelemetryAccessLogConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- 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
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
public static OpenTelemetryAccessLogConfig.Builder newBuilder(OpenTelemetryAccessLogConfig prototype) -
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected OpenTelemetryAccessLogConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-