Package com.github.loki4j.logback.extractor

Class MetadataExtractor<E,T extends java.util.Collection<E>>

java.lang.Object

com.github.loki4j.logback.extractor.MetadataExtractor<E,T>

Type Parameters:

E - Type of key-value entry served by this provider.

T - Type of key-value collection served by this provider.

All Implemented Interfaces:

Extractor

Direct Known Subclasses:

MetadataExtractor.KvpBulkPatternExtractor, MetadataExtractor.MdcBulkPatternExtractor

public abstract class MetadataExtractor<E,T extends java.util.Collection<E>>
extends java.lang.Object
implements Extractor

A component for extracting multiple key-value pairs from Logback event's metadata (mdc, kvp). Used for effective label/metadata extraction.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetadataExtractor.KvpBulkPatternExtractor
static class	MetadataExtractor.MdcBulkPatternExtractor

Method Summary

Modifier and Type	Method	Description
void	extract(ch.qos.logback.classic.spi.ILoggingEvent event, java.util.Map<java.lang.String,java.lang.String> result)	Extracts key-value pairs from the Logback event provided.
protected abstract T	extractEntries(ch.qos.logback.classic.spi.ILoggingEvent event)	Extract the collection of entries (i.e.
protected abstract java.lang.String	extractKey(E entry)	Extract the key (i.e.
protected abstract java.lang.String	extractValue(E entry)	Extract the value (i.e.
static MetadataExtractor.KvpBulkPatternExtractor	kvp(java.lang.String prefix, java.util.Set<java.lang.String> excludeKeys, java.util.Set<java.lang.String> includeKeys)	Extractor for KVP.
static MetadataExtractor.MdcBulkPatternExtractor	mdc(java.lang.String prefix, java.util.Set<java.lang.String> excludeKeys, java.util.Set<java.lang.String> includeKeys)	Extractor for MDC.

Methods inherited from class java.lang.Object

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

Method Detail

extract

public void extract(ch.qos.logback.classic.spi.ILoggingEvent event,
                    java.util.Map<java.lang.String,java.lang.String> result)

Extracts key-value pairs from the Logback event provided.

Specified by:

extract in interface Extractor

mdc

public static MetadataExtractor.MdcBulkPatternExtractor mdc(java.lang.String prefix,
                                                            java.util.Set<java.lang.String> excludeKeys,
                                                            java.util.Set<java.lang.String> includeKeys)

Extractor for MDC.

kvp

public static MetadataExtractor.KvpBulkPatternExtractor kvp(java.lang.String prefix,
                                                            java.util.Set<java.lang.String> excludeKeys,
                                                            java.util.Set<java.lang.String> includeKeys)

Extractor for KVP.

extractEntries

protected abstract T extractEntries(ch.qos.logback.classic.spi.ILoggingEvent event)

Extract the collection of entries (i.e. fields) from the logging event.

Parameters:

event - Current logback event.

extractKey

protected abstract java.lang.String extractKey(E entry)

Extract the key (i.e. field name) from the collection entry.

extractValue

protected abstract java.lang.String extractValue(E entry)

Extract the value (i.e. field value) from the collection entry.