Skip navigation links
A C D E F G H I L M P S T V W 

A

audit(LoggingEvent) - Method in class com.github.structlogging.kafka.EventTypeAwareKafkaCallback
 
audit(LoggingEvent) - Method in interface com.github.structlogging.LoggingCallback
logging of audit related events
audit(LoggingEvent) - Method in class com.github.structlogging.slf4j.Slf4jLoggingCallback
This implementation uses INFO level of slf4j and marks these logged messages with AUDIT marker
audit(String) - Method in class com.github.structlogging.StructLogger
log event on audit level, beginning point of fluent API logging
auditEvent(LoggingEvent) - Method in class com.github.structlogging.StructLogger
log audit event

C

close() - Method in class com.github.structlogging.kafka.LoggingEventJsonSerializer
 
com.github.structlogging - package com.github.structlogging
 
com.github.structlogging.annotation - package com.github.structlogging.annotation
 
com.github.structlogging.kafka - package com.github.structlogging.kafka
 
com.github.structlogging.processor - package com.github.structlogging.processor
 
com.github.structlogging.processor.exception - package com.github.structlogging.processor.exception
 
com.github.structlogging.processor.service - package com.github.structlogging.processor.service
 
com.github.structlogging.processor.utils - package com.github.structlogging.processor.utils
 
com.github.structlogging.slf4j - package com.github.structlogging.slf4j
 
com.github.structlogging.utils - package com.github.structlogging.utils
 
compareTo(VariableAndValue) - Method in class com.github.structlogging.processor.utils.VariableAndValue
 
configure(Map<String, ?>, boolean) - Method in class com.github.structlogging.kafka.LoggingEventJsonSerializer
 
createPojo(String, JCTree.JCLiteral, List<VariableAndValue>) - Method in class com.github.structlogging.processor.service.POJOService
Create JavaFile representing POJO based on String literal and usedVariables of log statement

D

debug(LoggingEvent) - Method in class com.github.structlogging.kafka.EventTypeAwareKafkaCallback
 
debug(LoggingEvent) - Method in interface com.github.structlogging.LoggingCallback
corresponds to DEBUG level of logging
debug(LoggingEvent) - Method in class com.github.structlogging.slf4j.Slf4jLoggingCallback
 
debug(String) - Method in class com.github.structlogging.StructLogger
log event on debug level, beginning point of fluent API logging
debugEvent(LoggingEvent) - Method in class com.github.structlogging.StructLogger
log event on debug level
DefaultContext - Interface in com.github.structlogging
Default VariableContext containing basic variables

E

equals(Object) - Method in class com.github.structlogging.processor.utils.GeneratedClassInfo
 
equals(Object) - Method in class com.github.structlogging.processor.utils.Variable
 
equals(Object) - Method in class com.github.structlogging.processor.utils.VariableAndValue
 
error(LoggingEvent) - Method in class com.github.structlogging.kafka.EventTypeAwareKafkaCallback
 
error(LoggingEvent) - Method in interface com.github.structlogging.LoggingCallback
corresponds to ERROR level of logging
error(LoggingEvent) - Method in class com.github.structlogging.slf4j.Slf4jLoggingCallback
 
error(String) - Method in class com.github.structlogging.StructLogger
log event on error level, beginning point of fluent API logging
errorEvent(LoggingEvent) - Method in class com.github.structlogging.StructLogger
log event on error level
EventTypeAwareKafkaCallback - Class in com.github.structlogging.kafka
Callback, which sends logging events to topics based on event types
EventTypeAwareKafkaCallback(Producer<Long, LoggingEvent>) - Constructor for class com.github.structlogging.kafka.EventTypeAwareKafkaCallback
Constructors kafka logging callback, which sends events to topics same as event types
EventTypeAwareKafkaCallback(Producer<Long, LoggingEvent>, Function<String, String>) - Constructor for class com.github.structlogging.kafka.EventTypeAwareKafkaCallback
Constructs kafka logging callback, which sends events to topics according to eventTypeToTopicMapping

F

finished(TaskEvent) - Method in class com.github.structlogging.processor.SchemaGenerator
 
format(String, Object...) - Static method in class com.github.structlogging.utils.MessageFormatterUtils
based on String pattern, which contains placeholder {}, inserts params into the pattern and returns resulting String

G

GeneratedClassInfo - Class in com.github.structlogging.processor.utils
Class containing info about generated POJO for structured log event
GeneratedClassInfo(String, String, String, List<VariableAndValue>, String) - Constructor for class com.github.structlogging.processor.utils.GeneratedClassInfo
 
getCompilationUnitTree() - Method in class com.github.structlogging.processor.utils.ScannerParams
 
getContextProvider() - Method in class com.github.structlogging.processor.utils.StructLoggerFieldContext
 
getDescription() - Method in class com.github.structlogging.processor.utils.GeneratedClassInfo
 
getLevelMethodName() - Method in enum com.github.structlogging.processor.LogLevel
 
getLevelName() - Method in enum com.github.structlogging.processor.LogLevel
 
getLineNumber() - Method in class com.github.structlogging.LoggingEvent
 
getLineNumber() - Method in class com.github.structlogging.processor.utils.StatementInfo
 
getLogEventMethodName() - Method in enum com.github.structlogging.processor.LogLevel
 
getLogLevel() - Method in class com.github.structlogging.LoggingEvent
 
getMessage() - Method in class com.github.structlogging.LoggingEvent
 
getMethodName() - Method in class com.github.structlogging.processor.utils.MethodAndParameter
 
getName() - Method in class com.github.structlogging.processor.utils.Variable
 
getPackageName() - Method in class com.github.structlogging.processor.utils.GeneratedClassInfo
 
getParameter() - Method in class com.github.structlogging.processor.utils.MethodAndParameter
 
getQualifiedName() - Method in class com.github.structlogging.processor.utils.GeneratedClassInfo
 
getSid() - Method in class com.github.structlogging.LoggingEvent
 
getSimpleName() - Method in class com.github.structlogging.processor.utils.GeneratedClassInfo
 
getSourceFile() - Method in class com.github.structlogging.LoggingEvent
 
getSourceFileName() - Method in class com.github.structlogging.processor.utils.StatementInfo
 
getStatement() - Method in class com.github.structlogging.processor.utils.StatementInfo
 
getType() - Method in class com.github.structlogging.LoggingEvent
 
getType() - Method in class com.github.structlogging.processor.utils.Variable
 
getTypeElement() - Method in class com.github.structlogging.processor.utils.ScannerParams
 
getTypeMirror() - Method in class com.github.structlogging.processor.utils.VariableContextProvider
 
getUsedVariables() - Method in class com.github.structlogging.processor.utils.GeneratedClassInfo
 
getValue() - Method in class com.github.structlogging.processor.utils.VariableAndValue
 
getVariable() - Method in class com.github.structlogging.processor.utils.VariableAndValue
 
getVariables() - Method in class com.github.structlogging.processor.utils.VariableContextProvider
 

H

hashCode() - Method in class com.github.structlogging.processor.utils.GeneratedClassInfo
 
hashCode() - Method in class com.github.structlogging.processor.utils.Variable
 
hashCode() - Method in class com.github.structlogging.processor.utils.VariableAndValue
 

I

incrementAndGet() - Static method in class com.github.structlogging.utils.SidCounter
increment and get new value of SID
info(LoggingEvent) - Method in class com.github.structlogging.kafka.EventTypeAwareKafkaCallback
 
info(LoggingEvent) - Method in interface com.github.structlogging.LoggingCallback
corresponds to INFO level of logging
info(LoggingEvent) - Method in class com.github.structlogging.slf4j.Slf4jLoggingCallback
 
info(String) - Method in class com.github.structlogging.StructLogger
log event on info level, beginning point of fluent API logging
infoEvent(LoggingEvent) - Method in class com.github.structlogging.StructLogger
log event on info level
init(ProcessingEnvironment) - Method in class com.github.structlogging.processor.LogInvocationProcessor
 

L

log() - Method in interface com.github.structlogging.VariableContext
 
log(String) - Method in interface com.github.structlogging.VariableContext
 
LoggerContext - Annotation Type in com.github.structlogging.annotation
Annotation to specify StructLogger fields and specifying used VariableContext and name of logger (underlying slf4j logger) Typical usage: public class Example { @VarContext(context = DefaultContext.class) private static StructLogger<DefaultContext> defaultLog = StructLogger.instance(); }
LoggingCallback - Interface in com.github.structlogging
Logging callback API
LoggingEvent - Class in com.github.structlogging
All generated logging events should extend this class All changes made to this class should be reflected in LogInvocationScanner and POJOService or you risk incorrect behaviour of processor
LoggingEvent(String, String, Long, String, Long, String) - Constructor for class com.github.structlogging.LoggingEvent
 
LoggingEventJsonSerializer - Class in com.github.structlogging.kafka
Logging Event serializer to json for kafka
LoggingEventJsonSerializer() - Constructor for class com.github.structlogging.kafka.LoggingEventJsonSerializer
 
LogInvocationProcessor - Class in com.github.structlogging.processor
Main annotation processor of structlogger, takes care of locating VarContextProvider annotated classes, LoggerContext annotated StructLogger fields and takes care of replacing all valid structured log statements with generated structured log events invocations of slf4j logging API
LogInvocationProcessor() - Constructor for class com.github.structlogging.processor.LogInvocationProcessor
 
LogInvocationScanner - Class in com.github.structlogging.processor
TreePathScanner which takes care of structured log statements replacement
LogInvocationScanner(HashMap<TypeMirror, VariableContextProvider>, Map<Name, StructLoggerFieldContext>, ProcessingEnvironment, Set<GeneratedClassInfo>) - Constructor for class com.github.structlogging.processor.LogInvocationScanner
 
LogLevel - Enum in com.github.structlogging.processor
supported log levels and their corresponding names and method names

M

MessageFormatterUtils - Class in com.github.structlogging.utils
 
MethodAndParameter - Class in com.github.structlogging.processor.utils
Class representing method of MethodInvocationTree
MethodAndParameter(Name, ExpressionTree) - Constructor for class com.github.structlogging.processor.utils.MethodAndParameter
 

P

PackageNameException - Exception in com.github.structlogging.processor.exception
Exception thrown when package name is not valid
PackageNameException(String) - Constructor for exception com.github.structlogging.processor.exception.PackageNameException
 
POJOService - Class in com.github.structlogging.processor.service
Service for creating POJO and generating them during annotation processing
POJOService(Filer, String) - Constructor for class com.github.structlogging.processor.service.POJOService
 
process(Set<? extends TypeElement>, RoundEnvironment) - Method in class com.github.structlogging.processor.LogInvocationProcessor
 

S

ScannerParams - Class in com.github.structlogging.processor.utils
Class representing parameters passed to LogInvocationScanner
ScannerParams(TypeElement, CompilationUnitTree) - Constructor for class com.github.structlogging.processor.utils.ScannerParams
 
SchemaGenerator - Class in com.github.structlogging.processor
TaskListener, which takes care of generating json schemas for logging events, after GENERATE phase of compilation
SchemaGenerator(Set<GeneratedClassInfo>, String) - Constructor for class com.github.structlogging.processor.SchemaGenerator
 
serialize(String, LoggingEvent) - Method in class com.github.structlogging.kafka.LoggingEventJsonSerializer
 
shouldParametrize() - Method in class com.github.structlogging.processor.utils.VariableContextProvider
 
SidCounter - Class in com.github.structlogging.utils
Sequence ID counter
SidCounter() - Constructor for class com.github.structlogging.utils.SidCounter
 
Slf4jLoggingCallback - Class in com.github.structlogging.slf4j
Logging callback which serializes events as string and pass them to SLF4j inside log message
Slf4jLoggingCallback(Logger) - Constructor for class com.github.structlogging.slf4j.Slf4jLoggingCallback
 
started(TaskEvent) - Method in class com.github.structlogging.processor.SchemaGenerator
 
StatementInfo - Class in com.github.structlogging.processor.utils
Class representing info about statement
StatementInfo(long, String, JCTree.JCExpressionStatement) - Constructor for class com.github.structlogging.processor.utils.StatementInfo
 
StructLogger<T extends VariableContext> - Class in com.github.structlogging
Main class providing structured logging, parametrized by interface extending VariableContext class
StructLogger(LoggingCallback) - Constructor for class com.github.structlogging.StructLogger
 
StructLoggerFieldContext - Class in com.github.structlogging.processor.utils
Holder for context provider type specified by LoggerContext annotation on StructLogger field
StructLoggerFieldContext(TypeMirror) - Constructor for class com.github.structlogging.processor.utils.StructLoggerFieldContext
 

T

toString() - Method in class com.github.structlogging.processor.utils.Variable
 
toString() - Method in class com.github.structlogging.processor.utils.VariableAndValue
 
toString() - Method in class com.github.structlogging.processor.utils.VariableContextProvider
 
trace(LoggingEvent) - Method in class com.github.structlogging.kafka.EventTypeAwareKafkaCallback
 
trace(LoggingEvent) - Method in interface com.github.structlogging.LoggingCallback
corresponds to TRACE level of logging
trace(LoggingEvent) - Method in class com.github.structlogging.slf4j.Slf4jLoggingCallback
 
trace(String) - Method in class com.github.structlogging.StructLogger
log event on trace level, beginning point of fluent API logging
traceEvent(LoggingEvent) - Method in class com.github.structlogging.StructLogger
log event on trace level

V

valueOf(String) - Static method in enum com.github.structlogging.processor.LogLevel
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.github.structlogging.processor.LogLevel
Returns an array containing the constants of this enum type, in the order they are declared.
Var - Annotation Type in com.github.structlogging.annotation
Annotation for specifying variables in VariableContext interfaces
varBoolean(boolean) - Method in interface com.github.structlogging.DefaultContext
 
VarContextProvider - Annotation Type in com.github.structlogging.annotation
Annotation for specifying interfaces providing Var annotated methods
varDouble(double) - Method in interface com.github.structlogging.DefaultContext
 
Variable - Class in com.github.structlogging.processor.utils
Class representing variable in log invocation statement or declared in VarContextProvider
Variable(Name, TypeMirror) - Constructor for class com.github.structlogging.processor.utils.Variable
 
VariableAndValue - Class in com.github.structlogging.processor.utils
Class representing Variable in log invocation statement together with passed expression parameter
VariableAndValue(Variable, ExpressionTree) - Constructor for class com.github.structlogging.processor.utils.VariableAndValue
 
VariableContext - Interface in com.github.structlogging
Interface to be extended by concrete variable context interface providing concrete logging variables
VariableContextProvider - Class in com.github.structlogging.processor.utils
Class representing class annotated with VarContextProvider
VariableContextProvider(TypeMirror, List<Variable>, boolean) - Constructor for class com.github.structlogging.processor.utils.VariableContextProvider
 
varInt(int) - Method in interface com.github.structlogging.DefaultContext
 
varLong(long) - Method in interface com.github.structlogging.DefaultContext
 
varString(String) - Method in interface com.github.structlogging.DefaultContext
 
visitExpressionStatement(ExpressionStatementTree, ScannerParams) - Method in class com.github.structlogging.processor.LogInvocationScanner
Checks expressions, if expression is method call on StructLogger field, it is considered structured log statement and is expression is transformed in such way, that method chain is replaced with one call to corresponding infoEvent, errorEvent,...

W

warn(LoggingEvent) - Method in class com.github.structlogging.kafka.EventTypeAwareKafkaCallback
 
warn(LoggingEvent) - Method in interface com.github.structlogging.LoggingCallback
corresponds to WARN level of logging
warn(LoggingEvent) - Method in class com.github.structlogging.slf4j.Slf4jLoggingCallback
 
warn(String) - Method in class com.github.structlogging.StructLogger
log event on warn level, beginning point of fluent API logging
warnEvent(LoggingEvent) - Method in class com.github.structlogging.StructLogger
log event on warn level
writeJavaFile(JavaFile) - Method in class com.github.structlogging.processor.service.POJOService
writes JavaFile using filer (generates POJO class in generated sources)
A C D E F G H I L M P S T V W 
Skip navigation links

Copyright © 2018. All rights reserved.