Index (aop-log-helper 1.0.0 API)

A C D E G H I L M N R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values

A

AlertEvent - Record Class in com.github.catomat0.aoploghelper.alert: Immutable snapshot of a log event captured for asynchronous webhook delivery.
AlertEvent(Instant, String, String, String, String, Map<String, String>, String) - Constructor for record class com.github.catomat0.aoploghelper.alert.AlertEvent: Creates an instance of a AlertEvent record class.
AlertRateLimiter - Class in com.github.catomat0.aoploghelper.alert: Trivial per-minute counter used to keep the webhook from spamming when the app is emitting a burst of errors (e.g.
AlertRateLimiter(int) - Constructor for class com.github.catomat0.aoploghelper.alert.AlertRateLimiter
AlhAlertAutoConfiguration - Class in com.github.catomat0.aoploghelper.alert.autoconfigure
AlhAlertAutoConfiguration() - Constructor for class com.github.catomat0.aoploghelper.alert.autoconfigure.AlhAlertAutoConfiguration
AlhAlertAutoConfiguration.AlhWebhookAppenderRegistrar - Class in com.github.catomat0.aoploghelper.alert.autoconfigure
AlhAlertProperties - Class in com.github.catomat0.aoploghelper.alert: Configuration for the log-based webhook alert appender.
AlhAlertProperties() - Constructor for class com.github.catomat0.aoploghelper.alert.AlhAlertProperties
AlhAlertProperties.Threshold - Enum Class in com.github.catomat0.aoploghelper.alert
AlhAlertProperties.Type - Enum Class in com.github.catomat0.aoploghelper.alert
alhAlertRateLimiter(AlhAlertProperties) - Method in class com.github.catomat0.aoploghelper.alert.autoconfigure.AlhAlertAutoConfiguration
AlhAutoConfiguration - Class in com.github.catomat0.aoploghelper.autoconfigure: Umbrella configuration that pulls in the individual pieces (MDC filter + AOP logging + alerts).
AlhAutoConfiguration() - Constructor for class com.github.catomat0.aoploghelper.autoconfigure.AlhAutoConfiguration
alhLoggingAnnotationAdvisor(AlhLoggingAspect) - Method in class com.github.catomat0.aoploghelper.logging.autoconfigure.AlhLoggingAutoConfiguration: Registers a second advisor triggered by the LogExecution annotation so callers can opt-in per-class/per-method regardless of the global pointcut.
alhLoggingAspect(AlhLoggingProperties, SensitiveMasker) - Method in class com.github.catomat0.aoploghelper.logging.autoconfigure.AlhLoggingAutoConfiguration
AlhLoggingAspect - Class in com.github.catomat0.aoploghelper.logging: Method interceptor that emits a single log line per invocation with class, method, (optionally masked) arguments, elapsed time, and — depending on outcome — the return value or exception message.
AlhLoggingAspect(AlhLoggingProperties, SensitiveMasker) - Constructor for class com.github.catomat0.aoploghelper.logging.AlhLoggingAspect
AlhLoggingAutoConfiguration - Class in com.github.catomat0.aoploghelper.logging.autoconfigure
AlhLoggingAutoConfiguration() - Constructor for class com.github.catomat0.aoploghelper.logging.autoconfigure.AlhLoggingAutoConfiguration
alhLoggingPointcutAdvisor(AlhLoggingProperties, AlhLoggingAspect) - Method in class com.github.catomat0.aoploghelper.logging.autoconfigure.AlhLoggingAutoConfiguration: Registers the configurable pointcut (alh.logging.pointcut) so any bean whose method matches the expression will be logged.
AlhLoggingProperties - Class in com.github.catomat0.aoploghelper.logging: Configuration for the AOP logging aspect.
AlhLoggingProperties() - Constructor for class com.github.catomat0.aoploghelper.logging.AlhLoggingProperties
AlhMdcAutoConfiguration - Class in com.github.catomat0.aoploghelper.mdc.autoconfigure
AlhMdcAutoConfiguration() - Constructor for class com.github.catomat0.aoploghelper.mdc.autoconfigure.AlhMdcAutoConfiguration
alhMdcFilter(AlhMdcProperties, AlhUserIdResolver) - Method in class com.github.catomat0.aoploghelper.mdc.autoconfigure.AlhMdcAutoConfiguration
AlhMdcFilter - Class in com.github.catomat0.aoploghelper.mdc: Populates SLF4J MDC with per-request context so downstream logs can be correlated.
AlhMdcFilter(AlhMdcProperties, AlhUserIdResolver) - Constructor for class com.github.catomat0.aoploghelper.mdc.AlhMdcFilter
alhMdcFilterRegistration(AlhMdcFilter) - Method in class com.github.catomat0.aoploghelper.mdc.autoconfigure.AlhMdcAutoConfiguration
AlhMdcKeys - Class in com.github.catomat0.aoploghelper.mdc: MDC keys populated by AlhMdcFilter.
AlhMdcProperties - Class in com.github.catomat0.aoploghelper.mdc: Configuration for the MDC filter.
AlhMdcProperties() - Constructor for class com.github.catomat0.aoploghelper.mdc.AlhMdcProperties
alhSensitiveMasker(AlhLoggingProperties) - Method in class com.github.catomat0.aoploghelper.logging.autoconfigure.AlhLoggingAutoConfiguration
alhUserIdResolver() - Method in class com.github.catomat0.aoploghelper.mdc.autoconfigure.AlhMdcAutoConfiguration
AlhUserIdResolver - Interface in com.github.catomat0.aoploghelper.mdc: Strategy for extracting the current user id to populate AlhMdcKeys.USER_ID.
AlhWebhookAppender - Class in com.github.catomat0.aoploghelper.alert: Logback appender that forwards qualifying log events to a webhook.
AlhWebhookAppender(AlhAlertProperties, WebhookClient, AlertRateLimiter) - Constructor for class com.github.catomat0.aoploghelper.alert.AlhWebhookAppender
alhWebhookAppenderRegistrar(AlhAlertProperties, WebhookClient, AlertRateLimiter) - Method in class com.github.catomat0.aoploghelper.alert.autoconfigure.AlhAlertAutoConfiguration
AlhWebhookAppenderRegistrar(AlhAlertProperties, WebhookClient, AlertRateLimiter) - Constructor for class com.github.catomat0.aoploghelper.alert.autoconfigure.AlhAlertAutoConfiguration.AlhWebhookAppenderRegistrar
alhWebhookClient(AlhAlertProperties) - Method in class com.github.catomat0.aoploghelper.alert.autoconfigure.AlhAlertAutoConfiguration
append(ILoggingEvent) - Method in class com.github.catomat0.aoploghelper.alert.AlhWebhookAppender
apply(AlertEvent) - Method in class com.github.catomat0.aoploghelper.alert.webhook.DiscordPayloadRenderer
apply(AlertEvent) - Method in class com.github.catomat0.aoploghelper.alert.webhook.SlackPayloadRenderer
attach() - Method in class com.github.catomat0.aoploghelper.alert.autoconfigure.AlhAlertAutoConfiguration.AlhWebhookAppenderRegistrar

C

com.github.catomat0.aoploghelper.alert - package com.github.catomat0.aoploghelper.alert
com.github.catomat0.aoploghelper.alert.autoconfigure - package com.github.catomat0.aoploghelper.alert.autoconfigure
com.github.catomat0.aoploghelper.alert.webhook - package com.github.catomat0.aoploghelper.alert.webhook
com.github.catomat0.aoploghelper.autoconfigure - package com.github.catomat0.aoploghelper.autoconfigure
com.github.catomat0.aoploghelper.logging - package com.github.catomat0.aoploghelper.logging
com.github.catomat0.aoploghelper.logging.annotation - package com.github.catomat0.aoploghelper.logging.annotation
com.github.catomat0.aoploghelper.logging.autoconfigure - package com.github.catomat0.aoploghelper.logging.autoconfigure
com.github.catomat0.aoploghelper.logging.mask - package com.github.catomat0.aoploghelper.logging.mask
com.github.catomat0.aoploghelper.mdc - package com.github.catomat0.aoploghelper.mdc
com.github.catomat0.aoploghelper.mdc.autoconfigure - package com.github.catomat0.aoploghelper.mdc.autoconfigure

D

detach() - Method in class com.github.catomat0.aoploghelper.alert.autoconfigure.AlhAlertAutoConfiguration.AlhWebhookAppenderRegistrar
DISCORD - Enum constant in enum class com.github.catomat0.aoploghelper.alert.AlhAlertProperties.Type
DiscordPayloadRenderer - Class in com.github.catomat0.aoploghelper.alert.webhook: Renders an AlertEvent as a Discord webhook payload using the content field.
DiscordPayloadRenderer() - Constructor for class com.github.catomat0.aoploghelper.alert.webhook.DiscordPayloadRenderer
doFilterInternal(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class com.github.catomat0.aoploghelper.mdc.AlhMdcFilter

E

equals(Object) - Method in record class com.github.catomat0.aoploghelper.alert.AlertEvent: Indicates whether some other object is "equal to" this one.
ERROR - Enum constant in enum class com.github.catomat0.aoploghelper.alert.AlhAlertProperties.Threshold

G

getConnectTimeoutMs() - Method in class com.github.catomat0.aoploghelper.alert.AlhAlertProperties
getHeaderName() - Method in class com.github.catomat0.aoploghelper.mdc.AlhMdcProperties
getIncludeMdcKeys() - Method in class com.github.catomat0.aoploghelper.alert.AlhAlertProperties
getLoggerNamePrefixBlocklist() - Method in class com.github.catomat0.aoploghelper.alert.AlhAlertProperties
getMaskKeywords() - Method in class com.github.catomat0.aoploghelper.logging.AlhLoggingProperties
getMaxStackLines() - Method in class com.github.catomat0.aoploghelper.alert.AlhAlertProperties
getPointcut() - Method in class com.github.catomat0.aoploghelper.logging.AlhLoggingProperties
getRateLimitPerMinute() - Method in class com.github.catomat0.aoploghelper.alert.AlhAlertProperties
getReadTimeoutMs() - Method in class com.github.catomat0.aoploghelper.alert.AlhAlertProperties
getRequestIdLength() - Method in class com.github.catomat0.aoploghelper.mdc.AlhMdcProperties
getSlowThresholdMs() - Method in class com.github.catomat0.aoploghelper.logging.AlhLoggingProperties
getThreshold() - Method in class com.github.catomat0.aoploghelper.alert.AlhAlertProperties
getType() - Method in class com.github.catomat0.aoploghelper.alert.AlhAlertProperties
getWebhookUrl() - Method in class com.github.catomat0.aoploghelper.alert.AlhAlertProperties

H

hashCode() - Method in record class com.github.catomat0.aoploghelper.alert.AlertEvent: Returns a hash code value for this object.
HttpWebhookClient - Class in com.github.catomat0.aoploghelper.alert.webhook: Minimal JDK HttpClient-based webhook client.
HttpWebhookClient(AlhAlertProperties, Function<AlertEvent, String>) - Constructor for class com.github.catomat0.aoploghelper.alert.webhook.HttpWebhookClient

I

invoke(MethodInvocation) - Method in class com.github.catomat0.aoploghelper.logging.AlhLoggingAspect
isEnabled() - Method in class com.github.catomat0.aoploghelper.alert.AlhAlertProperties
isEnabled() - Method in class com.github.catomat0.aoploghelper.logging.AlhLoggingProperties
isEnabled() - Method in class com.github.catomat0.aoploghelper.mdc.AlhMdcProperties
isIncludeStackTrace() - Method in class com.github.catomat0.aoploghelper.alert.AlhAlertProperties
isLogArgs() - Method in class com.github.catomat0.aoploghelper.logging.AlhLoggingProperties
isLogResult() - Method in class com.github.catomat0.aoploghelper.logging.AlhLoggingProperties
isMaskPii() - Method in class com.github.catomat0.aoploghelper.logging.AlhLoggingProperties
isResponseHeader() - Method in class com.github.catomat0.aoploghelper.mdc.AlhMdcProperties

L

level() - Method in record class com.github.catomat0.aoploghelper.alert.AlertEvent: Returns the value of the level record component.
logArgs() - Element in annotation interface com.github.catomat0.aoploghelper.logging.annotation.LogExecution: Log arguments passed to the method.
LogExecution - Annotation Interface in com.github.catomat0.aoploghelper.logging.annotation: Force logging on a specific method/class regardless of the default pointcut.
loggerName() - Method in record class com.github.catomat0.aoploghelper.alert.AlertEvent: Returns the value of the loggerName record component.
logResult() - Element in annotation interface com.github.catomat0.aoploghelper.logging.annotation.LogExecution: Log the return value.
LogSlow - Annotation Interface in com.github.catomat0.aoploghelper.logging.annotation: Override the global slow-call threshold for a specific method/class.

M

mask(Object) - Method in class com.github.catomat0.aoploghelper.logging.mask.SensitiveMasker
maskArgs(Object[]) - Method in class com.github.catomat0.aoploghelper.logging.mask.SensitiveMasker
mdc() - Method in record class com.github.catomat0.aoploghelper.alert.AlertEvent: Returns the value of the mdc record component.
message() - Method in record class com.github.catomat0.aoploghelper.alert.AlertEvent: Returns the value of the message record component.
METHOD - Static variable in class com.github.catomat0.aoploghelper.mdc.AlhMdcKeys: HTTP method (GET, POST, ...).

N

NoLog - Annotation Interface in com.github.catomat0.aoploghelper.logging.annotation: Opt a method or class out of AOP logging even if it matches the configured pointcut.

R

REQUEST_ID - Static variable in class com.github.catomat0.aoploghelper.mdc.AlhMdcKeys: Short random correlation id issued per HTTP request (default 8 hex chars).
resolve(HttpServletRequest) - Method in interface com.github.catomat0.aoploghelper.mdc.AlhUserIdResolver

S

sanitizeForLog(String) - Method in class com.github.catomat0.aoploghelper.logging.mask.SensitiveMasker: Runs full masking and then strips control characters so the result is safe to embed in a single log line.
send(AlertEvent) - Method in class com.github.catomat0.aoploghelper.alert.webhook.HttpWebhookClient
send(AlertEvent) - Method in interface com.github.catomat0.aoploghelper.alert.webhook.WebhookClient
SensitiveMasker - Class in com.github.catomat0.aoploghelper.logging.mask: Best-effort masker used when logging method arguments, return values and exception messages.
SensitiveMasker(Collection<String>) - Constructor for class com.github.catomat0.aoploghelper.logging.mask.SensitiveMasker
SensitiveMasker(Collection<String>, boolean) - Constructor for class com.github.catomat0.aoploghelper.logging.mask.SensitiveMasker
setConnectTimeoutMs(int) - Method in class com.github.catomat0.aoploghelper.alert.AlhAlertProperties
setEnabled(boolean) - Method in class com.github.catomat0.aoploghelper.alert.AlhAlertProperties
setEnabled(boolean) - Method in class com.github.catomat0.aoploghelper.logging.AlhLoggingProperties
setEnabled(boolean) - Method in class com.github.catomat0.aoploghelper.mdc.AlhMdcProperties
setHeaderName(String) - Method in class com.github.catomat0.aoploghelper.mdc.AlhMdcProperties
setIncludeMdcKeys(List<String>) - Method in class com.github.catomat0.aoploghelper.alert.AlhAlertProperties
setIncludeStackTrace(boolean) - Method in class com.github.catomat0.aoploghelper.alert.AlhAlertProperties
setLogArgs(boolean) - Method in class com.github.catomat0.aoploghelper.logging.AlhLoggingProperties
setLoggerNamePrefixBlocklist(List<String>) - Method in class com.github.catomat0.aoploghelper.alert.AlhAlertProperties
setLogResult(boolean) - Method in class com.github.catomat0.aoploghelper.logging.AlhLoggingProperties
setMaskKeywords(List<String>) - Method in class com.github.catomat0.aoploghelper.logging.AlhLoggingProperties
setMaskPii(boolean) - Method in class com.github.catomat0.aoploghelper.logging.AlhLoggingProperties
setMaxStackLines(int) - Method in class com.github.catomat0.aoploghelper.alert.AlhAlertProperties
setPointcut(String) - Method in class com.github.catomat0.aoploghelper.logging.AlhLoggingProperties
setRateLimitPerMinute(int) - Method in class com.github.catomat0.aoploghelper.alert.AlhAlertProperties
setReadTimeoutMs(int) - Method in class com.github.catomat0.aoploghelper.alert.AlhAlertProperties
setRequestIdLength(int) - Method in class com.github.catomat0.aoploghelper.mdc.AlhMdcProperties
setResponseHeader(boolean) - Method in class com.github.catomat0.aoploghelper.mdc.AlhMdcProperties
setSlowThresholdMs(long) - Method in class com.github.catomat0.aoploghelper.logging.AlhLoggingProperties
setThreshold(AlhAlertProperties.Threshold) - Method in class com.github.catomat0.aoploghelper.alert.AlhAlertProperties
setType(AlhAlertProperties.Type) - Method in class com.github.catomat0.aoploghelper.alert.AlhAlertProperties
setWebhookUrl(String) - Method in class com.github.catomat0.aoploghelper.alert.AlhAlertProperties
SLACK - Enum constant in enum class com.github.catomat0.aoploghelper.alert.AlhAlertProperties.Type
SlackPayloadRenderer - Class in com.github.catomat0.aoploghelper.alert.webhook: Renders an AlertEvent as a Slack webhook payload using the text field.
SlackPayloadRenderer() - Constructor for class com.github.catomat0.aoploghelper.alert.webhook.SlackPayloadRenderer
stackTrace() - Method in record class com.github.catomat0.aoploghelper.alert.AlertEvent: Returns the value of the stackTrace record component.
stop() - Method in class com.github.catomat0.aoploghelper.alert.AlhWebhookAppender

T

threadName() - Method in record class com.github.catomat0.aoploghelper.alert.AlertEvent: Returns the value of the threadName record component.
thresholdMs() - Element in annotation interface com.github.catomat0.aoploghelper.logging.annotation.LogSlow: Threshold in milliseconds.
timestamp() - Method in record class com.github.catomat0.aoploghelper.alert.AlertEvent: Returns the value of the timestamp record component.
toString() - Method in record class com.github.catomat0.aoploghelper.alert.AlertEvent: Returns a string representation of this record class.
tryAcquire() - Method in class com.github.catomat0.aoploghelper.alert.AlertRateLimiter

U

URI - Static variable in class com.github.catomat0.aoploghelper.mdc.AlhMdcKeys: Request URI (path without query string).
USER_ID - Static variable in class com.github.catomat0.aoploghelper.mdc.AlhMdcKeys: Resolved user id (or "anonymous" when no principal is present).

V

valueOf(String) - Static method in enum class com.github.catomat0.aoploghelper.alert.AlhAlertProperties.Threshold: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.github.catomat0.aoploghelper.alert.AlhAlertProperties.Type: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.github.catomat0.aoploghelper.alert.AlhAlertProperties.Threshold: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.github.catomat0.aoploghelper.alert.AlhAlertProperties.Type: Returns an array containing the constants of this enum class, in the order they are declared.

W

WARN - Enum constant in enum class com.github.catomat0.aoploghelper.alert.AlhAlertProperties.Threshold
WebhookClient - Interface in com.github.catomat0.aoploghelper.alert.webhook: Strategy for shipping an AlertEvent to a webhook endpoint.

A C D E G H I L M N R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values