ugrpc::server::middlewares::log::Component Class Reference

#include <userver/ugrpc/server/middlewares/log/component.hpp>

Detailed Description

Component for gRPC server logging.

Warning

Logs are currently written with log level debug by default, which typically means that they are not written in production. See details below.

Static options:

Name	Description	Default value
log-level	log level to use for Span, status code and the facts of sending requests receiving responses arriving	debug
msg-log-level	log level to use for request and response messages themselves	debug
msg-size-log-limit	max message size to log, the rest will be truncated	512
trim-secrets	trim the secrets from logs as marked by the protobuf option	true (*)

Warning

* Trimming secrets causes a segmentation fault for messages that contain optional fields in protobuf versions prior to 3.13. You should set trim-secrets to false if this is the case for you. See https://github.com/protocolbuffers/protobuf/issues/7801

Static configuration example:

        grpc-server-logging:
            log-level: info
            msg-log-level: info
            msg-size-log-limit: 512

In this example, we enable logs for gRPC clients in production.

Definition at line 44 of file component.hpp.

Inheritance diagram for ugrpc::server::middlewares::log::Component:

Public Types
using	MiddlewareBase = MiddlewareBaseType

Public Member Functions
	Component (const components::ComponentConfig &config, const components::ComponentContext &context)
yaml_config::Schema	GetMiddlewareConfigSchema () const override
	This method should return the schema of a middleware configuration. Always write return GetStaticConfigSchema(); in this method.
std::shared_ptr< MiddlewareBase >	CreateMiddleware (const ugrpc::server::ServiceInfo &, const yaml_config::YamlConfig &middleware_config) const override
virtual std::shared_ptr< MiddlewareBase >	CreateMiddleware (const HandlerInfo &info, const yaml_config::YamlConfig &middleware_config) const =0
	Returns a middleware according to the component's settings.
ComponentHealth	GetComponentHealth () const override
void	OnLoadingCancelled () override
void	OnAllComponentsLoaded () override
void	OnAllComponentsAreStopping () override

Static Public Member Functions
static yaml_config::Schema	GetStaticConfigSchema ()

Static Public Attributes
static constexpr std::string_view	kName = "grpc-server-logging"
	The default name of ugrpc::server::middlewares::log::Component.

Protected Types
using	LoggableComponentBase = ComponentBase

Member Typedef Documentation

LoggableComponentBase

using components::ComponentBase::LoggableComponentBase = ComponentBase

protectedinherited

Deprecated

use components::ComponentBase instead.

Definition at line 67 of file component_base.hpp.

MiddlewareBase

template<typename MiddlewareBaseType , typename HandlerInfo >

using middlewares::MiddlewareFactoryComponentBase< MiddlewareBaseType, HandlerInfo >::MiddlewareBase = MiddlewareBaseType

inherited

Definition at line 54 of file runner.hpp.

Member Function Documentation

CreateMiddleware()

template<typename MiddlewareBaseType , typename HandlerInfo >

virtual std::shared_ptr< MiddlewareBase > middlewares::MiddlewareFactoryComponentBase< MiddlewareBaseType, HandlerInfo >::CreateMiddleware ( const HandlerInfo & info, const yaml_config::YamlConfig & middleware_config ) const

pure virtualinherited

Returns a middleware according to the component's settings.

Parameters

info	is a handler info for the middleware.
middleware_config	config for the middleware.

Warning

Don't store info by reference. info object will be dropped after the CreateMiddleware call.

GetComponentHealth()

ComponentHealth components::ComponentBase::GetComponentHealth ( ) const

inlineoverridevirtualinherited

Override this function to inform the world of the state of your component.

Warning

The function is called concurrently from multiple threads.

Reimplemented from components::RawComponentBase.

Reimplemented in server::handlers::Restart.

Definition at line 35 of file component_base.hpp.

GetMiddlewareConfigSchema()

yaml_config::Schema ugrpc::server::middlewares::log::Component::GetMiddlewareConfigSchema ( ) const

overridevirtual

This method should return the schema of a middleware configuration. Always write return GetStaticConfigSchema(); in this method.

Reimplemented from middlewares::MiddlewareFactoryComponentBase< MiddlewareBaseType, HandlerInfo >.

OnAllComponentsAreStopping()

void components::ComponentBase::OnAllComponentsAreStopping ( )

inlineoverridevirtualinherited

Component may use this function to stop doing work before the stop of the components that depend on it.

Base components may override it and make final to do some work before the derived object constructor is called. Don't use it otherwise.

Reimplemented from components::RawComponentBase.

Reimplemented in urabbitmq::ConsumerComponentBase, and components::Server.

Definition at line 58 of file component_base.hpp.

OnAllComponentsLoaded()

void components::ComponentBase::OnAllComponentsLoaded ( )

inlineoverridevirtualinherited

Component may use this function to finalize registration of other components that depend on it (for example, handler components register in server component, and the latter uses OnAllComponentsLoaded() to start processing requests).

Base components may override it and make final to do some work after the derived object constructor is called. Don't use it otherwise.

Reimplemented from components::RawComponentBase.

Reimplemented in urabbitmq::ConsumerComponentBase, components::Server, and server::handlers::Ping.

Definition at line 51 of file component_base.hpp.

OnLoadingCancelled()

void components::ComponentBase::OnLoadingCancelled ( )

inlineoverridevirtualinherited

Called once if the creation of any other component failed. If the current component expects some other component to take any action with the current component, this call is a signal that such action may never happen due to components loading was cancelled. Application components might not want to override it.

Reimplemented from components::RawComponentBase.

Definition at line 42 of file component_base.hpp.

---

The documentation for this class was generated from the following file:

• userver/ugrpc/server/middlewares/log/component.hpp