Package org.zalando.logbook.autoconfigure

Class LogbookAutoConfiguration

java.lang.Object

org.zalando.logbook.autoconfigure.LogbookAutoConfiguration

@API(status=STABLE)
@Configuration(proxyBeanMethods=false)
@ConditionalOnClass(org.zalando.logbook.Logbook.class)
@EnableConfigurationProperties(LogbookProperties.class)
@AutoConfigureAfter(value=org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration.class,
                    name={"org.springframework.boot.autoconfigure.web.WebMvcAutoConfiguration","org.springframework.boot.autoconfigure.web.servlet.WebMvcAutoConfiguration"})
public class LogbookAutoConfiguration
extends Object

Constructor Summary

Constructors

Constructor	Description
LogbookAutoConfiguration(LogbookProperties properties)

Method Summary

Modifier and Type	Method	Description
BodyFilter	bodyFilter()
Strategy	bodyOnlyIfStatusAtLeastStrategy(int status)
Sink	chunkingSink(Sink sink)
CorrelationId	correlationId()
HttpLogFormatter	curlFormatter()
HeaderFilter	headerFilter()
HttpLogFormatter	httpFormatter()
HttpLogFormatter	jsonFormatter(com.fasterxml.jackson.databind.ObjectMapper mapper)
Logbook	logbook(Predicate<HttpRequest> condition, CorrelationId correlationId, List<HeaderFilter> headerFilters, List<PathFilter> pathFilters, List<QueryFilter> queryFilters, List<BodyFilter> bodyFilters, List<RequestFilter> requestFilters, List<ResponseFilter> responseFilters, Strategy strategy, Sink sink)
PathFilter	pathFilter()
QueryFilter	queryFilter()
Predicate<HttpRequest>	requestCondition()
RequestFilter	requestFilter()
ResponseFilter	responseFilter()
Sink	sink(HttpLogFormatter formatter, HttpLogWriter writer)
HttpLogFormatter	splunkHttpLogFormatter()
Strategy	statusAtLeastStrategy(int status)
Strategy	strategy()
Strategy	withoutBody()
HttpLogWriter	writer()

Methods inherited from class java.lang.Object

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

Constructor Detail

LogbookAutoConfiguration

@API(status=INTERNAL)
@Autowired
public LogbookAutoConfiguration(LogbookProperties properties)

Method Detail

logbook

@API(status=INTERNAL)
@Bean
@ConditionalOnMissingBean(org.zalando.logbook.Logbook.class)
public Logbook logbook(Predicate<HttpRequest> condition,
                       CorrelationId correlationId,
                       List<HeaderFilter> headerFilters,
                       List<PathFilter> pathFilters,
                       List<QueryFilter> queryFilters,
                       List<BodyFilter> bodyFilters,
                       List<RequestFilter> requestFilters,
                       List<ResponseFilter> responseFilters,
                       Strategy strategy,
                       Sink sink)

requestCondition

@API(status=INTERNAL)
@Bean
@ConditionalOnMissingBean(name="requestCondition")
public Predicate<HttpRequest> requestCondition()

correlationId

@API(status=INTERNAL)
@Bean
@ConditionalOnMissingBean(org.zalando.logbook.CorrelationId.class)
public CorrelationId correlationId()

queryFilter

@API(status=INTERNAL)
@Bean
@ConditionalOnMissingBean(org.zalando.logbook.QueryFilter.class)
public QueryFilter queryFilter()

headerFilter

@API(status=INTERNAL)
@Bean
@ConditionalOnMissingBean(org.zalando.logbook.HeaderFilter.class)
public HeaderFilter headerFilter()

pathFilter

@API(status=INTERNAL)
@Bean
@ConditionalOnMissingBean(org.zalando.logbook.PathFilter.class)
public PathFilter pathFilter()

bodyFilter

@API(status=INTERNAL)
@Bean
@ConditionalOnMissingBean(org.zalando.logbook.BodyFilter.class)
public BodyFilter bodyFilter()

requestFilter

@API(status=INTERNAL)
@Bean
@ConditionalOnMissingBean(org.zalando.logbook.RequestFilter.class)
public RequestFilter requestFilter()

responseFilter

@API(status=INTERNAL)
@Bean
@ConditionalOnMissingBean(org.zalando.logbook.ResponseFilter.class)
public ResponseFilter responseFilter()

strategy

@API(status=INTERNAL)
@Bean
@ConditionalOnMissingBean(org.zalando.logbook.Strategy.class)
@ConditionalOnProperty(name="logbook.strategy",
                       havingValue="default",
                       matchIfMissing=true)
public Strategy strategy()

statusAtLeastStrategy

@API(status=INTERNAL)
@Bean
@ConditionalOnMissingBean(org.zalando.logbook.Strategy.class)
@ConditionalOnProperty(name="logbook.strategy",
                       havingValue="status-at-least")
public Strategy statusAtLeastStrategy(@Value("${logbook.minimum-status:400}")
                                      int status)

bodyOnlyIfStatusAtLeastStrategy

@API(status=INTERNAL)
@Bean
@ConditionalOnMissingBean(org.zalando.logbook.Strategy.class)
@ConditionalOnProperty(name="logbook.strategy",
                       havingValue="body-only-if-status-at-least")
public Strategy bodyOnlyIfStatusAtLeastStrategy(@Value("${logbook.minimum-status:400}")
                                                int status)

withoutBody

@API(status=INTERNAL)
@Bean
@ConditionalOnMissingBean(org.zalando.logbook.Strategy.class)
@ConditionalOnProperty(name="logbook.strategy",
                       havingValue="without-body")
public Strategy withoutBody()

sink

@API(status=INTERNAL)
@Bean
@ConditionalOnMissingBean(org.zalando.logbook.Sink.class)
public Sink sink(HttpLogFormatter formatter,
                 HttpLogWriter writer)

chunkingSink

@API(status=INTERNAL)
@Bean
@Primary
@ConditionalOnBean(org.zalando.logbook.Sink.class)
@ConditionalOnProperty("logbook.write.chunk-size")
public Sink chunkingSink(Sink sink)

httpFormatter

@API(status=INTERNAL)
@Bean
@ConditionalOnMissingBean(org.zalando.logbook.HttpLogFormatter.class)
@ConditionalOnProperty(name="logbook.format.style",
                       havingValue="http")
public HttpLogFormatter httpFormatter()

curlFormatter

@API(status=INTERNAL)
@Bean
@ConditionalOnMissingBean(org.zalando.logbook.HttpLogFormatter.class)
@ConditionalOnProperty(name="logbook.format.style",
                       havingValue="curl")
public HttpLogFormatter curlFormatter()

splunkHttpLogFormatter

@API(status=INTERNAL)
@Bean
@ConditionalOnMissingBean(org.zalando.logbook.HttpLogFormatter.class)
@ConditionalOnProperty(name="logbook.format.style",
                       havingValue="splunk")
public HttpLogFormatter splunkHttpLogFormatter()

jsonFormatter

@API(status=INTERNAL)
@Bean
@ConditionalOnBean(com.fasterxml.jackson.databind.ObjectMapper.class)
@ConditionalOnMissingBean(org.zalando.logbook.HttpLogFormatter.class)
public HttpLogFormatter jsonFormatter(com.fasterxml.jackson.databind.ObjectMapper mapper)

writer

@API(status=INTERNAL)
@Bean
@ConditionalOnMissingBean(org.zalando.logbook.HttpLogWriter.class)
public HttpLogWriter writer()