Class BackendServiceLogConfig (1.15.0)

BackendServiceLogConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The available logging options for the load balancer traffic served by this backend service.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

NameDescription
enable bool
Denotes whether to enable logging for the load balancer traffic served by this backend service. The default value is false. This field is a member of oneof_ _enable.
optional_fields MutableSequence[str]
This field can only be specified if logging is enabled for this backend service and "logConfig.optionalMode" was set to CUSTOM. Contains a list of optional fields you want to include in the logs. For example: serverInstance, serverGkeDetails.cluster, serverGkeDetails.pod.podNamespace
optional_mode str
This field can only be specified if logging is enabled for this backend service. Configures whether all, none or a subset of optional fields should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL. Check the OptionalMode enum for the list of possible values. This field is a member of oneof_ _optional_mode.
sample_rate float
This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0. This field is a member of oneof_ _sample_rate.

Classes

OptionalMode

OptionalMode(value)

This field can only be specified if logging is enabled for this backend service. Configures whether all, none or a subset of optional fields should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.

Values: UNDEFINED_OPTIONAL_MODE (0): A value indicating that the enum field is not set. CUSTOM (388595569): A subset of optional fields. EXCLUDE_ALL_OPTIONAL (168636099): None optional fields. INCLUDE_ALL_OPTIONAL (535606965): All optional fields.