#include <userver/server/handlers/log_level.hpp>

Detailed Description

Handler that controls logging levels of all the loggers.

The component has no service configuration except the common handler options.

Static configuration example:

# yaml
    handler-log-level:
        path: /service/log-level/{level}
        method: GET,PUT
        task_processor: monitor-task-processor

Scheme

For the GET and PUT requests this handler returns the following JSON:

{
  "init-log-level": <log level on service start>,
  "current-log-level": <current log level>
}

Particular logger name could be specified by an optional logger query argument. Default logger is used, if no logger was provided.

PUT request changes the logger level to the value specified in the level query argument. Set it to the reset value, to reset the logger level to the initial values.

See also: Changing the log level at runtime

Definition at line 49 of file log_level.hpp.

Inheritance diagram for server::handlers::LogLevel:

Collaboration diagram for server::handlers::LogLevel:

Public Member Functions
	LogLevel (const components::ComponentConfig &config, const components::ComponentContext &component_context)

std::string	HandleRequestThrow (const http::HttpRequest &request, request::RequestContext &) const override

Public Member Functions inherited from server::handlers::HttpHandlerBase
	HttpHandlerBase (const components::ComponentConfig &config, const components::ComponentContext &component_context, bool is_monitor=false)

void	HandleRequest (request::RequestBase &request, request::RequestContext &context) const override

void	ReportMalformedRequest (request::RequestBase &request) const final

virtual const std::string &	HandlerName () const

const std::vector< http::HttpMethod > &	GetAllowedMethods () const

virtual logging::Level	GetLogLevelForResponseStatus (http::HttpStatus status) const

virtual FormattedErrorData	GetFormattedExternalErrorBody (const CustomHandlerException &exc) const

std::string	GetResponseDataForLoggingChecked (const http::HttpRequest &request, request::RequestContext &context, const std::string &response_data) const

void	HandleCustomHandlerException (const http::HttpRequest &request, const CustomHandlerException &ex) const

void	HandleUnknownException (const http::HttpRequest &request, const std::exception &ex) const

void	LogUnknownException (const std::exception &ex) const
	Helper function to log an unknown exception.

const std::optional< logging::Level > &	GetLogLevel () const
	Returns the default log level for the handler.

Public Member Functions inherited from server::handlers::HandlerBase
	HandlerBase (const components::ComponentConfig &config, const components::ComponentContext &component_context, bool is_monitor=false)

bool	IsMonitor () const
	Returns whether this is a monitoring handler.

const HandlerConfig &	GetConfig () const
	Returns handler config.

Public Member Functions inherited from components::LoggableComponentBase
	LoggableComponentBase (const ComponentConfig &, const ComponentContext &)

	LoggableComponentBase (LoggableComponentBase &&)=delete

	LoggableComponentBase (const LoggableComponentBase &)=delete

	~LoggableComponentBase () override=default

ComponentHealth	GetComponentHealth () const override

void	OnLoadingCancelled () override

void	OnAllComponentsLoaded () override

void	OnAllComponentsAreStopping () override

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

Static Public Member Functions inherited from server::handlers::HttpHandlerBase
static yaml_config::Schema	GetStaticConfigSchema ()

Static Public Member Functions inherited from server::handlers::HandlerBase
static yaml_config::Schema	GetStaticConfigSchema ()

Static Public Member Functions inherited from components::LoggableComponentBase
static yaml_config::Schema	GetStaticConfigSchema ()

Static Public Attributes
static constexpr std::string_view	kName = "handler-log-level"
	The default name of server::handlers::LogLevel.

Additional Inherited Members
Protected Types inherited from server::handlers::HandlerBase
using	HandlerErrorCode = handlers::HandlerErrorCode

using	InternalMessage = handlers::InternalMessage

using	ExternalBody = handlers::ExternalBody

using	ClientError = handlers::ClientError

using	InternalServerError = handlers::InternalServerError

Protected Member Functions inherited from server::handlers::HttpHandlerBase
void	ThrowUnsupportedHttpMethod (const http::HttpRequest &request) const

virtual void	OnRequestCompleteThrow (const http::HttpRequest &, request::RequestContext &) const

virtual void	HandleStreamRequest (const server::http::HttpRequest &, server::request::RequestContext &, server::http::ResponseBodyStream &) const

virtual bool	IsStreamed () const

virtual bool	IsMethodStatisticIncluded () const

virtual bool	NeedCheckAuth () const

virtual std::string	GetRequestBodyForLogging (const http::HttpRequest &request, request::RequestContext &context, const std::string &request_body) const
	Override it if you need a custom request body logging.

virtual std::string	GetResponseDataForLogging (const http::HttpRequest &request, request::RequestContext &context, const std::string &response_data) const
	Override it if you need a custom response data logging.

virtual void	ParseRequestData (const http::HttpRequest &, request::RequestContext &) const

virtual std::string	GetMetaType (const http::HttpRequest &) const

Member Function Documentation

◆ HandleRequestThrow()

std::string server::handlers::LogLevel::HandleRequestThrow	(	const http::HttpRequest &	request,
		request::RequestContext &	context ) const

overridevirtual

The core method for HTTP request handling. request arg contains HTTP headers, full body, etc. The method should return response body.

Note: It is used only if IsStreamed() returned false.

Reimplemented from server::handlers::HttpHandlerBase.

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

userver/server/handlers/log_level.hpp

Detailed Description

Static configuration example:

Scheme

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Member Function Documentation

◆ HandleRequestThrow()