metadatav3

Documentation

Index

• Variables
• type Metadata
  • func (*Metadata) ProtoMessage()
  • func (x *Metadata) ProtoReflect() protoreflect.Message
  • func (x *Metadata) Reset()
  • func (x *Metadata) String() string
• type Metadata_builder
  • func (b0 Metadata_builder) Build() *Metadata

Variables

var File_envoy_extensions_formatter_metadata_v3_metadata_proto protoreflect.FileDescriptor

Types

type Metadata

type Metadata struct {
	// contains filtered or unexported fields
}

%METADATA(TYPE:NAMESPACE:KEY):Z%

  :ref:`Metadata <envoy_v3_api_msg_config.core.v3.Metadata>` info,
  where TYPE is type of metadata (see above for supported types),
  NAMESPACE is the filter namespace used when setting the metadata, KEY is an optional
  lookup key in the namespace with the option of specifying nested keys separated by ':',
  and Z is an optional parameter denoting string truncation up to Z characters long.
  The data will be logged as a JSON string. For example, for the following ROUTE metadata:

  ``com.test.my_filter: {"test_key": "foo", "test_object": {"inner_key": "bar"}}``

  * %METADATA(ROUTE:com.test.my_filter)% will log: ``{"test_key": "foo", "test_object": {"inner_key": "bar"}}``
  * %METADATA(ROUTE:com.test.my_filter:test_key)% will log: ``foo``
  * %METADATA(ROUTE:com.test.my_filter:test_object)% will log: ``{"inner_key": "bar"}``
  * %METADATA(ROUTE:com.test.my_filter:test_object:inner_key)% will log: ``bar``
  * %METADATA(ROUTE:com.unknown_filter)% will log: ``-``
  * %METADATA(ROUTE:com.test.my_filter:unknown_key)% will log: ``-``
  * %METADATA(ROUTE:com.test.my_filter):25% will log (truncation at 25 characters): ``{"test_key": "foo", "test``

.. note::

  For typed JSON logs, this operator renders a single value with string, numeric, or boolean type
  when the referenced key is a simple value. If the referenced key is a struct or list value, a
  JSON struct or list is rendered. Structs and lists may be nested. In any event, the maximum
  length is ignored.

.. note::

  METADATA(DYNAMIC:NAMESPACE:KEY):Z is equivalent to :ref:`DYNAMIC_METADATA(NAMESPACE:KEY):Z<config_access_log_format_dynamic_metadata>`
  METADATA(CLUSTER:NAMESPACE:KEY):Z is equivalent to :ref:`CLUSTER_METADATA(NAMESPACE:KEY):Z<config_access_log_format_cluster_metadata>`
  METADATA(UPSTREAM_HOST:NAMESPACE:KEY):Z is equivalent to :ref:`UPSTREAM_METADATA(NAMESPACE:KEY):Z<config_access_log_format_upstream_host_metadata>`

.. warning::

This extension is treated as built-in extension and will be enabled by default now.
It is unnecessary to configure this extension.

func (*Metadata) ProtoMessage

func (*Metadata) ProtoMessage()

func (*Metadata) ProtoReflect

func (x *Metadata) ProtoReflect() protoreflect.Message

func (*Metadata) Reset

func (x *Metadata) Reset()

func (*Metadata) String

func (x *Metadata) String() string

type Metadata_builder

type Metadata_builder struct {
	// contains filtered or unexported fields
}

func (Metadata_builder) Build

func (b0 Metadata_builder) Build() *Metadata