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

Interface DynamicModuleAccessLogOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    DynamicModuleConfig
    getDynamicModuleConfig()
    Specifies the shared-object level configuration.
    DynamicModuleConfigOrBuilder
    getDynamicModuleConfigOrBuilder()
    Specifies the shared-object level configuration.
    com.google.protobuf.Any
    getLoggerConfig()
    The configuration for the logger chosen by ``logger_name``.
    com.google.protobuf.AnyOrBuilder
    getLoggerConfigOrBuilder()
    The configuration for the logger chosen by ``logger_name``.
    String
    getLoggerName()
    The name for this logger configuration.
    com.google.protobuf.ByteString
    getLoggerNameBytes()
    The name for this logger configuration.
    boolean
    hasDynamicModuleConfig()
    Specifies the shared-object level configuration.
    boolean
    hasLoggerConfig()
    The configuration for the logger chosen by ``logger_name``.

    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

    • hasDynamicModuleConfig

      boolean hasDynamicModuleConfig()
       Specifies the shared-object level configuration. This field is required.
      .envoy.extensions.dynamic_modules.v3.DynamicModuleConfig dynamic_module_config = 1 [(.validate.rules) = { ... }
      Returns:
      Whether the dynamicModuleConfig field is set.

    • getDynamicModuleConfig

      DynamicModuleConfig getDynamicModuleConfig()
       Specifies the shared-object level configuration. This field is required.
      .envoy.extensions.dynamic_modules.v3.DynamicModuleConfig dynamic_module_config = 1 [(.validate.rules) = { ... }
      Returns:
      The dynamicModuleConfig.

    • getDynamicModuleConfigOrBuilder

      DynamicModuleConfigOrBuilder getDynamicModuleConfigOrBuilder()
       Specifies the shared-object level configuration. This field is required.
      .envoy.extensions.dynamic_modules.v3.DynamicModuleConfig dynamic_module_config = 1 [(.validate.rules) = { ... }

    • getLoggerName

      String getLoggerName()
       The name for this logger configuration. If not specified, defaults to an empty string.

 This can be used to distinguish between different logger implementations inside a dynamic
 module. For example, a module can have completely different logger implementations (e.g.,
 file logger, gRPC logger, metrics logger). When Envoy receives this configuration, it passes
 the ``logger_name`` to the dynamic module's access logger config init function together with
 the ``logger_config``. That way a module can decide which in-module logger implementation to
 use based on the name at load time.
      string logger_name = 2;
      Returns:
      The loggerName.

    • getLoggerNameBytes

      com.google.protobuf.ByteString getLoggerNameBytes()
       The name for this logger configuration. If not specified, defaults to an empty string.

 This can be used to distinguish between different logger implementations inside a dynamic
 module. For example, a module can have completely different logger implementations (e.g.,
 file logger, gRPC logger, metrics logger). When Envoy receives this configuration, it passes
 the ``logger_name`` to the dynamic module's access logger config init function together with
 the ``logger_config``. That way a module can decide which in-module logger implementation to
 use based on the name at load time.
      string logger_name = 2;
      Returns:
      The bytes for loggerName.

    • hasLoggerConfig

      boolean hasLoggerConfig()
       The configuration for the logger chosen by ``logger_name``. If not specified, an empty
 configuration is passed to the module.

 This is passed to the module's access logger initialization function. Together with the
 ``logger_name``, the module can decide which in-module logger implementation to use and
 fine-tune the behavior of the logger.

 For example, if a module has two logger implementations, one for file output and one for
 sending to an external service, ``logger_name`` is used to choose either file or external.
 The ``logger_config`` can be used to configure file paths, service endpoints, batching
 parameters, format strings, etc.

 ``google.protobuf.Struct`` is serialized as JSON before passing it to the module.
 ``google.protobuf.BytesValue`` and ``google.protobuf.StringValue`` are passed directly
 without the wrapper.

 .. code-block:: yaml

  # Passing a JSON struct configuration
  logger_config:
    "@type": "type.googleapis.com/google.protobuf.Struct"
    value:
      output_path: "/var/log/envoy/access.log"
      format: "json"
      buffer_size: 1000

  # Passing a simple string configuration
  logger_config:
    "@type": "type.googleapis.com/google.protobuf.StringValue"
    value: "/var/log/envoy/access.log"
      .google.protobuf.Any logger_config = 3;
      Returns:
      Whether the loggerConfig field is set.

    • getLoggerConfig

      com.google.protobuf.Any getLoggerConfig()
       The configuration for the logger chosen by ``logger_name``. If not specified, an empty
 configuration is passed to the module.

 This is passed to the module's access logger initialization function. Together with the
 ``logger_name``, the module can decide which in-module logger implementation to use and
 fine-tune the behavior of the logger.

 For example, if a module has two logger implementations, one for file output and one for
 sending to an external service, ``logger_name`` is used to choose either file or external.
 The ``logger_config`` can be used to configure file paths, service endpoints, batching
 parameters, format strings, etc.

 ``google.protobuf.Struct`` is serialized as JSON before passing it to the module.
 ``google.protobuf.BytesValue`` and ``google.protobuf.StringValue`` are passed directly
 without the wrapper.

 .. code-block:: yaml

  # Passing a JSON struct configuration
  logger_config:
    "@type": "type.googleapis.com/google.protobuf.Struct"
    value:
      output_path: "/var/log/envoy/access.log"
      format: "json"
      buffer_size: 1000

  # Passing a simple string configuration
  logger_config:
    "@type": "type.googleapis.com/google.protobuf.StringValue"
    value: "/var/log/envoy/access.log"
      .google.protobuf.Any logger_config = 3;
      Returns:
      The loggerConfig.

    • getLoggerConfigOrBuilder

      com.google.protobuf.AnyOrBuilder getLoggerConfigOrBuilder()
       The configuration for the logger chosen by ``logger_name``. If not specified, an empty
 configuration is passed to the module.

 This is passed to the module's access logger initialization function. Together with the
 ``logger_name``, the module can decide which in-module logger implementation to use and
 fine-tune the behavior of the logger.

 For example, if a module has two logger implementations, one for file output and one for
 sending to an external service, ``logger_name`` is used to choose either file or external.
 The ``logger_config`` can be used to configure file paths, service endpoints, batching
 parameters, format strings, etc.

 ``google.protobuf.Struct`` is serialized as JSON before passing it to the module.
 ``google.protobuf.BytesValue`` and ``google.protobuf.StringValue`` are passed directly
 without the wrapper.

 .. code-block:: yaml

  # Passing a JSON struct configuration
  logger_config:
    "@type": "type.googleapis.com/google.protobuf.Struct"
    value:
      output_path: "/var/log/envoy/access.log"
      format: "json"
      buffer_size: 1000

  # Passing a simple string configuration
  logger_config:
    "@type": "type.googleapis.com/google.protobuf.StringValue"
    value: "/var/log/envoy/access.log"
      .google.protobuf.Any logger_config = 3;