org.hawaiiframework.logging.config

Class HawaiiLoggingConfiguration

java.lang.Object

org.hawaiiframework.logging.config.HawaiiLoggingConfiguration

@Configuration
 @EnableConfigurationProperties(value=HawaiiLoggingConfigurationProperties.class)
public class HawaiiLoggingConfiguration
extends java.lang.Object

Configures the logging based on the application properties. This class creates filter beans for the enabled filters.

Since:

2.0.0

Author:

Wouter Eerdekens, Paul Klos, Rutger Lubbers

Constructor Summary

Constructors

Constructor and Description
HawaiiLoggingConfiguration(HawaiiLoggingConfigurationProperties hawaiiLoggingConfigurationProperties) Autowired constructor.

Method Summary

Modifier and Type	Method and Description
HttpRequestResponseLogUtil	httpRequestResponseLogUtil() Create a HttpRequestResponseLogUtil bean.
KibanaLogCleanupFilter	kibanaLogCleanupFilter() Create the KibanaLogCleanupFilter bean.
org.springframework.boot.web.servlet.FilterRegistrationBean	kibanaLogCleanupFilterRegistration(KibanaLogCleanupFilter kibanaLogCleanupFilter) Register the kibanaLogCleanupFilter() bean.
KibanaLogFilter	kibanaLogFilter() Create the KibanaLogFilter bean.
org.springframework.boot.web.servlet.FilterRegistrationBean	kibanaLogFilterRegistration(KibanaLogFilter kibanaLogFilter) Register the kibanaLogFilter() bean.
RequestDurationFilter	requestDurationFilter() Create the RequestDurationFilter bean.
org.springframework.boot.web.servlet.FilterRegistrationBean	requestDurationFilterRegistration(RequestDurationFilter requestDurationFilter) Register the requestDurationFilter() bean.
RequestIdFilter	requestIdFilter() Create the RequestIdFilter bean.
org.springframework.boot.web.servlet.FilterRegistrationBean	requestIdFilterRegistration(RequestIdFilter requestIdFilter) Register the RequestIdFilter bean.
RequestResponseLogFilter	requestResponseLogFilter(HttpRequestResponseLogUtil httpRequestResponseLogUtil) Create the request/response logging filter bean.
org.springframework.boot.web.servlet.FilterRegistrationBean	requestResponseLogFilterRegistration(RequestResponseLogFilter requestResponseLogFilter) Create and register the RequestResponseLogFilter bean.
TransactionIdFilter	transactionIdFilter() Create the TransactionIdFilter bean.
org.springframework.boot.web.servlet.FilterRegistrationBean	transactionIdFilterRegistration(TransactionIdFilter transactionIdFilter) Register the transactionIdFilter() bean.
UserDetailsFilter	userDetailsFilter() Create the UserDetailsFilter bean.
org.springframework.boot.web.servlet.FilterRegistrationBean	userDetailsFilterRegistration(UserDetailsFilter userDetailsFilter) Register the userDetailsFilter() bean.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HawaiiLoggingConfiguration

public HawaiiLoggingConfiguration(HawaiiLoggingConfigurationProperties hawaiiLoggingConfigurationProperties)

Autowired constructor.

Parameters:

hawaiiLoggingConfigurationProperties - the logging configuration properties

Method Detail

kibanaLogFilter

@Bean
 @ConditionalOnProperty(prefix="hawaii.logging.filters.kibana-log",
                       name="enabled")
public KibanaLogFilter kibanaLogFilter()

Create the KibanaLogFilter bean.

Returns:

the KibanaLogFilter bean

kibanaLogFilterRegistration

@Bean
 @ConditionalOnProperty(prefix="hawaii.logging.filters.kibana-log",
                       name="enabled")
public org.springframework.boot.web.servlet.FilterRegistrationBean kibanaLogFilterRegistration(KibanaLogFilter kibanaLogFilter)

Register the kibanaLogFilter() bean.

Parameters:

kibanaLogFilter - the Kibana log filter

Returns:

the KibanaLogFilter bean, wrapped in a FilterRegistrationBean

kibanaLogCleanupFilter

@Bean
 @ConditionalOnProperty(prefix="hawaii.logging.filters.kibana-log-cleanup",
                       name="enabled")
public KibanaLogCleanupFilter kibanaLogCleanupFilter()

Create the KibanaLogCleanupFilter bean.

Returns:

the KibanaLogCleanupFilter bean

kibanaLogCleanupFilterRegistration

@Bean
 @ConditionalOnProperty(prefix="hawaii.logging.filters.kibana-log-cleanup",
                       name="enabled")
public org.springframework.boot.web.servlet.FilterRegistrationBean kibanaLogCleanupFilterRegistration(KibanaLogCleanupFilter kibanaLogCleanupFilter)

Register the kibanaLogCleanupFilter() bean.

Parameters:

kibanaLogCleanupFilter - the Kibana log cleanup filter

Returns:

the kibanaLogCleanupFilter() bean, wrapped in a FilterRegistrationBean

requestDurationFilter

@Bean
 @ConditionalOnProperty(prefix="hawaii.logging.filters.request-duration",
                       name="enabled")
public RequestDurationFilter requestDurationFilter()

Create the RequestDurationFilter bean.

Returns:

the RequestDurationFilter bean

requestDurationFilterRegistration

@Bean
 @ConditionalOnProperty(prefix="hawaii.logging.filters.request-duration",
                       name="enabled")
public org.springframework.boot.web.servlet.FilterRegistrationBean requestDurationFilterRegistration(RequestDurationFilter requestDurationFilter)

Register the requestDurationFilter() bean.

Parameters:

requestDurationFilter - the request duration filter

Returns:

the requestDurationFilter() bean, wrapped in a FilterRegistrationBean

requestIdFilter

@Bean
 @ConditionalOnProperty(prefix="hawaii.logging.filters.request-id",
                       name="enabled")
public RequestIdFilter requestIdFilter()

Create the RequestIdFilter bean.

Returns:

the RequestIdFilter bean

requestIdFilterRegistration

@Bean
 @ConditionalOnProperty(prefix="hawaii.logging.filters.request-id",
                       name="enabled")
public org.springframework.boot.web.servlet.FilterRegistrationBean requestIdFilterRegistration(RequestIdFilter requestIdFilter)

Register the RequestIdFilter bean.

Returns:

the requestIdFilter() bean, wrapped in a FilterRegistrationBean

requestResponseLogFilter

@Bean
 @ConditionalOnProperty(prefix="hawaii.logging.filters.request-response",
                       name="enabled")
public RequestResponseLogFilter requestResponseLogFilter(HttpRequestResponseLogUtil httpRequestResponseLogUtil)

Create the request/response logging filter bean.

Returns:

the RequestResponseLogFilter bean

requestResponseLogFilterRegistration

@Bean
 @ConditionalOnProperty(prefix="hawaii.logging.filters.request-response",
                       name="enabled")
public org.springframework.boot.web.servlet.FilterRegistrationBean requestResponseLogFilterRegistration(RequestResponseLogFilter requestResponseLogFilter)

Create and register the RequestResponseLogFilter bean.

Returns:

the requestResponseLogFilter(HttpRequestResponseLogUtil) bean, wrapped in a FilterRegistrationBean

transactionIdFilter

@Bean
 @ConditionalOnProperty(prefix="hawaii.logging.filters.transaction-id",
                       name="enabled")
public TransactionIdFilter transactionIdFilter()

Create the TransactionIdFilter bean.

Returns:

the TransactionIdFilter bean

transactionIdFilterRegistration

@Bean
 @ConditionalOnProperty(prefix="hawaii.logging.filters.transaction-id",
                       name="enabled")
public org.springframework.boot.web.servlet.FilterRegistrationBean transactionIdFilterRegistration(TransactionIdFilter transactionIdFilter)

Register the transactionIdFilter() bean.

Parameters:

transactionIdFilter - the transaction id filter

Returns:

the transactionIdFilter() bean, wrapped in a FilterRegistrationBean

userDetailsFilter

@Bean
 @ConditionalOnProperty(prefix="hawaii.logging.filters.user-details",
                       name="enabled")
public UserDetailsFilter userDetailsFilter()

Create the UserDetailsFilter bean.

Returns:

the UserDetailsFilter bean

userDetailsFilterRegistration

@Bean
 @ConditionalOnProperty(prefix="hawaii.logging.filters.user-details",
                       name="enabled")
public org.springframework.boot.web.servlet.FilterRegistrationBean userDetailsFilterRegistration(UserDetailsFilter userDetailsFilter)

Register the userDetailsFilter() bean.

Parameters:

userDetailsFilter - the user details filter

Returns:

the userDetailsFilter() bean, wrapped in a FilterRegistrationBean

httpRequestResponseLogUtil

@Bean
 @ConditionalOnProperty(prefix="hawaii.logging.filters.request-response",
                       name="enabled")
public HttpRequestResponseLogUtil httpRequestResponseLogUtil()

Create a HttpRequestResponseLogUtil bean. This is required for the RequestResponseLogFilter, see requestResponseLogFilter(HttpRequestResponseLogUtil).

Returns:

the bean