Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- adopt(FlowContext) - Static method in class com.fayupable.logged.spring.aspect.FlowContextCarrier
-
Makes
contextthe activeFlowContexton the calling thread and returns aRunnablethat undoes this, restoring whatever context was active before this call. - apply(RequestTemplate) - Method in class com.fayupable.logged.spring.http.FeignTraceRequestInterceptor
-
Writes the current call chain's trace headers onto
template.
B
- baseline() - Method in class com.fayupable.logged.benchmarks.LoggedAspectBenchmark
- baseline_AverageTime(InfraControl, ThreadParams) - Method in class com.fayupable.logged.benchmarks.jmh_generated.LoggedAspectBenchmark_baseline_jmhTest
- baseline_avgt_jmhStub(InfraControl, RawResults, BenchmarkParams, IterationParams, ThreadParams, Blackhole, Control, int, LoggedAspectBenchmark_jmhType) - Static method in class com.fayupable.logged.benchmarks.jmh_generated.LoggedAspectBenchmark_baseline_jmhTest
- baseline_sample_jmhStub(InfraControl, RawResults, BenchmarkParams, IterationParams, ThreadParams, Blackhole, Control, int, SampleBuffer, int, long, int, LoggedAspectBenchmark_jmhType) - Static method in class com.fayupable.logged.benchmarks.jmh_generated.LoggedAspectBenchmark_baseline_jmhTest
- baseline_SampleTime(InfraControl, ThreadParams) - Method in class com.fayupable.logged.benchmarks.jmh_generated.LoggedAspectBenchmark_baseline_jmhTest
- baseline_SingleShotTime(InfraControl, ThreadParams) - Method in class com.fayupable.logged.benchmarks.jmh_generated.LoggedAspectBenchmark_baseline_jmhTest
- baseline_ss_jmhStub(InfraControl, RawResults, BenchmarkParams, IterationParams, ThreadParams, Blackhole, Control, int, int, LoggedAspectBenchmark_jmhType) - Static method in class com.fayupable.logged.benchmarks.jmh_generated.LoggedAspectBenchmark_baseline_jmhTest
- baseline_Throughput(InfraControl, ThreadParams) - Method in class com.fayupable.logged.benchmarks.jmh_generated.LoggedAspectBenchmark_baseline_jmhTest
- baseline_thrpt_jmhStub(InfraControl, RawResults, BenchmarkParams, IterationParams, ThreadParams, Blackhole, Control, int, LoggedAspectBenchmark_jmhType) - Static method in class com.fayupable.logged.benchmarks.jmh_generated.LoggedAspectBenchmark_baseline_jmhTest
C
- CALLER_IP - Static variable in class com.fayupable.logged.spring.aspect.LoggedMdcKeys
-
The caller's IP address, the same value reported as
MethodInvocationEvent.callerIp(). - callerIdentity() - Method in record class com.fayupable.logged.core.model.MethodInvocationEvent
-
Returns the value of the
callerIdentityrecord component. - callerIp() - Method in record class com.fayupable.logged.core.model.MethodInvocationEvent
-
Returns the value of the
callerIprecord component. - capture() - Static method in class com.fayupable.logged.spring.aspect.FlowContextCarrier
-
Returns the
FlowContextcurrently active on this thread, ornullif no@Loggedcall is in progress on this thread. - CLASS_NAME - Static variable in class com.fayupable.logged.spring.aspect.LoggedMdcKeys
-
The class name resolved for the currently executing invocation, the same value reported as
MethodInvocationEvent.className(). - className() - Method in record class com.fayupable.logged.core.model.MethodInvocationEvent
-
Returns the value of the
classNamerecord component. - className() - Method in record class com.fayupable.logged.test.RecordedMetric
-
Returns the value of the
classNamerecord component. - clear() - Method in class com.fayupable.logged.test.InMemoryInvocationEventEmitter
-
Discards every event recorded so far, so this instance can be reused across test methods without leaking state between them.
- clear() - Method in class com.fayupable.logged.test.InMemoryMetricsRecorder
-
Discards every metric recorded so far, so this instance can be reused across test methods without leaking state between them.
- ClientInfo() - Constructor for class com.fayupable.logged.spring.config.LoggedProperties.ClientInfo
- com.fayupable.logged.benchmarks - package com.fayupable.logged.benchmarks
- com.fayupable.logged.benchmarks.jmh_generated - package com.fayupable.logged.benchmarks.jmh_generated
- com.fayupable.logged.core.annotation - package com.fayupable.logged.core.annotation
- com.fayupable.logged.core.model - package com.fayupable.logged.core.model
- com.fayupable.logged.core.port - package com.fayupable.logged.core.port
- com.fayupable.logged.spring.aspect - package com.fayupable.logged.spring.aspect
- com.fayupable.logged.spring.config - package com.fayupable.logged.spring.config
- com.fayupable.logged.spring.emitter - package com.fayupable.logged.spring.emitter
- com.fayupable.logged.spring.guard - package com.fayupable.logged.spring.guard
- com.fayupable.logged.spring.http - package com.fayupable.logged.spring.http
- com.fayupable.logged.spring.kafka - package com.fayupable.logged.spring.kafka
- com.fayupable.logged.spring.metrics - package com.fayupable.logged.spring.metrics
- com.fayupable.logged.spring.rabbitmq - package com.fayupable.logged.spring.rabbitmq
- com.fayupable.logged.spring.security - package com.fayupable.logged.spring.security
- com.fayupable.logged.test - package com.fayupable.logged.test
- count() - Method in class com.fayupable.logged.test.InMemoryInvocationEventEmitter
-
Returns the number of events recorded so far.
- count() - Method in class com.fayupable.logged.test.InMemoryMetricsRecorder
-
Returns the number of metrics recorded so far.
D
- decorate(Runnable) - Method in class com.fayupable.logged.spring.aspect.FlowContextTaskDecorator
-
Captures the calling thread's current
FlowContextand MDC context map, and returns a wrapped task that restores both before runningrunnableand restores the executor thread's own previous state again afterward, regardless of whetherrunnablecompletes normally or throws. - decorate(Runnable) - Method in class com.fayupable.logged.spring.security.RequestAttributesTaskDecorator
-
Captures the calling thread's current
RequestAttributesand returns a wrapped task that restores them before runningrunnableand restores the executor thread's own previous request attributes again afterward, regardless of whetherrunnablecompletes normally or throws. - decorate(Runnable) - Method in class com.fayupable.logged.spring.security.SecurityContextTaskDecorator
-
Captures the calling thread's current
SecurityContextand returns a wrapped task that restores it before runningrunnableand restores the executor thread's own previous security context again afterward, regardless of whetherrunnablecompletes normally or throws. - depth() - Method in record class com.fayupable.logged.core.model.FlowContext
-
Returns the value of the
depthrecord component. - depth() - Method in record class com.fayupable.logged.core.model.MethodInvocationEvent
-
Returns the value of the
depthrecord component. - DEPTH - Static variable in class com.fayupable.logged.spring.aspect.LoggedMdcKeys
-
The
FlowContext.depth()of the currently executing call within its chain, as a string. - DEPTH_HEADER - Static variable in class com.fayupable.logged.spring.http.HttpTraceHeaderCarrier
- doFilterInternal(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class com.fayupable.logged.spring.http.HttpTraceServletFilter
-
Reads the incoming request's trace headers, if present, and runs the rest of the filter chain with them adopted as the active call chain for this thread, restoring this thread's previous context again afterward, regardless of whether the chain completes normally or throws.
- durationNanos() - Method in record class com.fayupable.logged.core.model.MethodInvocationEvent
-
Returns the value of the
durationNanosrecord component. - durationNanos() - Method in record class com.fayupable.logged.test.RecordedMetric
-
Returns the value of the
durationNanosrecord component.
E
- emit(MethodInvocationEvent) - Method in interface com.fayupable.logged.core.port.InvocationEventEmitter
-
Publishes the given invocation event to whatever sink this implementation targets.
- emit(MethodInvocationEvent) - Method in class com.fayupable.logged.core.port.NoOpInvocationEventEmitter
- emit(MethodInvocationEvent) - Method in class com.fayupable.logged.spring.emitter.JsonInvocationEventEmitter
- emit(MethodInvocationEvent) - Method in class com.fayupable.logged.spring.emitter.Slf4jInvocationEventEmitter
- emit(MethodInvocationEvent) - Method in class com.fayupable.logged.test.InMemoryInvocationEventEmitter
- equals(Object) - Method in record class com.fayupable.logged.core.model.FlowContext
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.fayupable.logged.core.model.MethodInvocationEvent
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.fayupable.logged.test.RecordedMetric
-
Indicates whether some other object is "equal to" this one.
- events() - Method in class com.fayupable.logged.test.InMemoryInvocationEventEmitter
-
Returns every event recorded so far, in emission order.
- exceptionType() - Method in record class com.fayupable.logged.core.model.MethodInvocationEvent
-
Returns the value of the
exceptionTyperecord component. - exceptionType() - Method in record class com.fayupable.logged.test.RecordedMetric
-
Returns the value of the
exceptionTyperecord component. - execute(Runnable) - Method in class com.fayupable.logged.spring.aspect.FlowContextPropagatingExecutor
-
Captures the calling thread's current
FlowContextand MDC context map, and submits a wrapped task to the delegate executor that restores both before runningcommandand restores the executor thread's own previous state again afterward, regardless of whethercommandcompletes normally or throws. - execute(Runnable) - Method in class com.fayupable.logged.spring.security.RequestAttributesPropagatingExecutor
-
Captures the calling thread's current
RequestAttributesand submits a wrapped task to the delegate executor that restores them before runningcommandand restores the executor thread's own previous request attributes again afterward, regardless of whethercommandcompletes normally or throws. - execute(Runnable) - Method in class com.fayupable.logged.spring.security.SecurityContextPropagatingExecutor
-
Captures the calling thread's current
SecurityContextand submits a wrapped task to the delegate executor that restores it before runningcommandand restores the executor thread's own previous security context again afterward, regardless of whethercommandcompletes normally or throws.
F
- FeignTraceRequestInterceptor - Class in com.fayupable.logged.spring.http
-
Feign
RequestInterceptorthat writes the current@Loggedcall chain's trace id and depth into an outgoing Feign client request's headers, viaHttpTraceHeaderCarrier. - FeignTraceRequestInterceptor() - Constructor for class com.fayupable.logged.spring.http.FeignTraceRequestInterceptor
- filter(ClientRequest, ExchangeFunction) - Method in class com.fayupable.logged.spring.http.HttpTraceExchangeFilterFunction
-
Writes the current call chain's trace headers onto a copy of
requestbefore delegating tonext. - FlowContext - Record Class in com.fayupable.logged.core.model
-
Tracks the position of the current method invocation within a chain of nested
@Loggedcalls on the same thread. - FlowContext(String, int) - Constructor for record class com.fayupable.logged.core.model.FlowContext
-
Creates an instance of a
FlowContextrecord class. - FlowContextCarrier - Class in com.fayupable.logged.spring.aspect
-
The sanctioned public entry point for reading and writing this thread's active
FlowContextfrom outside theaspectpackage. - FlowContextPropagatingExecutor - Class in com.fayupable.logged.spring.aspect
-
Executordecorator that carries the submitting thread'sFlowContextandMDCcontext over to whatever thread actually runs the submitted task. - FlowContextPropagatingExecutor(Executor) - Constructor for class com.fayupable.logged.spring.aspect.FlowContextPropagatingExecutor
-
Wraps
delegateso that every task submitted through this executor carries the submitting thread'sFlowContextinto whichever threaddelegateactually runs it on. - FlowContextTaskDecorator - Class in com.fayupable.logged.spring.aspect
-
TaskDecoratorthat carries the submitting thread'sFlowContextandMDCcontext into whatever thread Spring's@Asyncinfrastructure actually runs the task on. - FlowContextTaskDecorator() - Constructor for class com.fayupable.logged.spring.aspect.FlowContextTaskDecorator
G
- getClientInfo() - Method in class com.fayupable.logged.spring.config.LoggedProperties
- getMdc() - Method in class com.fayupable.logged.spring.config.LoggedProperties
- getMetrics() - Method in class com.fayupable.logged.spring.config.LoggedProperties
H
- hashCode() - Method in record class com.fayupable.logged.core.model.FlowContext
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.fayupable.logged.core.model.MethodInvocationEvent
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.fayupable.logged.test.RecordedMetric
-
Returns a hash code value for this object.
- httpRequestClientInfoAdapter(LoggedProperties) - Method in class com.fayupable.logged.spring.config.LoggedAutoConfiguration
- HttpRequestClientInfoAdapter - Class in com.fayupable.logged.spring.security
-
IClientInfoPortimplementation that resolves the caller purely from the current HTTP request's client IP address, viaRequestClientIpResolver. - HttpRequestClientInfoAdapter(boolean) - Constructor for class com.fayupable.logged.spring.security.HttpRequestClientInfoAdapter
- HttpTraceClientHttpRequestInterceptor - Class in com.fayupable.logged.spring.http
-
ClientHttpRequestInterceptorthat writes the current@Loggedcall chain's trace id and depth into an outgoingRestTemplaterequest's headers, viaHttpTraceHeaderCarrier. - HttpTraceClientHttpRequestInterceptor() - Constructor for class com.fayupable.logged.spring.http.HttpTraceClientHttpRequestInterceptor
- HttpTraceExchangeFilterFunction - Class in com.fayupable.logged.spring.http
-
ExchangeFilterFunctionthat writes the current@Loggedcall chain's trace id and depth into an outgoingWebClientrequest's headers, viaHttpTraceHeaderCarrier. - HttpTraceExchangeFilterFunction() - Constructor for class com.fayupable.logged.spring.http.HttpTraceExchangeFilterFunction
- HttpTraceHeaderCarrier - Class in com.fayupable.logged.spring.http
-
Carries a
@Loggedcall chain'sFlowContextacross a synchronous HTTP call, by writing it into the outgoing request's headers and reading it back from the incoming request's headers. - HttpTraceServletFilter - Class in com.fayupable.logged.spring.http
-
Servlet
Filterthat reads the incoming HTTP request's trace headers, if present, and adopts them as the active@Loggedcall chain for the duration of the request, viaHttpTraceHeaderCarrier. - HttpTraceServletFilter() - Constructor for class com.fayupable.logged.spring.http.HttpTraceServletFilter
I
- IClientInfoPort - Interface in com.fayupable.logged.core.port
-
Output port responsible for resolving who triggered the current method invocation.
- includeIp() - Element in annotation interface com.fayupable.logged.core.annotation.Logged
-
Whether the caller's IP address should be resolved and recorded alongside whatever else the caller-identity resolver produces, instead of only as a fallback used when no identity is available.
- InMemoryClientInfoPort - Class in com.fayupable.logged.test
-
An
IClientInfoPortthat always returns a fixed, test-controlled caller identity, instead of resolving one from Spring Security or the current HTTP request. - InMemoryClientInfoPort() - Constructor for class com.fayupable.logged.test.InMemoryClientInfoPort
-
Creates an instance that reports the caller identity as
"unknown"untilInMemoryClientInfoPort.setCallerIdentity(String)is called. - InMemoryClientInfoPort(String) - Constructor for class com.fayupable.logged.test.InMemoryClientInfoPort
-
Creates an instance that reports the given caller identity.
- InMemoryInvocationEventEmitter - Class in com.fayupable.logged.test
-
An
InvocationEventEmitterthat records every event it receives in memory instead of publishing it anywhere, so a test can assert on what@Loggedactually observed about a call. - InMemoryInvocationEventEmitter() - Constructor for class com.fayupable.logged.test.InMemoryInvocationEventEmitter
- InMemoryMetricsRecorder - Class in com.fayupable.logged.test
-
A
MetricsRecorderthat records every call it is asked to record in memory as aRecordedMetric, instead of forwarding it to a real metrics backend such as Micrometer. - InMemoryMetricsRecorder() - Constructor for class com.fayupable.logged.test.InMemoryMetricsRecorder
- intercept(HttpRequest, byte[], ClientHttpRequestExecution) - Method in class com.fayupable.logged.spring.http.HttpTraceClientHttpRequestInterceptor
-
Writes the current call chain's trace headers onto
requestbefore delegating toexecution. - invocationEventEmitter() - Method in class com.fayupable.logged.spring.config.LoggedAutoConfiguration
- InvocationEventEmitter - Interface in com.fayupable.logged.core.port
-
Output port responsible for delivering a
MethodInvocationEventto wherever it needs to go: an SLF4J logger, a metrics backend, a message queue, or any other sink. - isEnabled() - Method in class com.fayupable.logged.spring.config.LoggedProperties
- isEnabled() - Method in class com.fayupable.logged.spring.config.LoggedProperties.Mdc
- isEnabled() - Method in class com.fayupable.logged.spring.config.LoggedProperties.Metrics
- isTrustForwardedHeaders() - Method in class com.fayupable.logged.spring.config.LoggedProperties.ClientInfo
J
- JsonInvocationEventEmitter - Class in com.fayupable.logged.spring.emitter
-
InvocationEventEmitterthat writes each event as a single line of structured JSON through SLF4J, instead of the human-readable line produced bySlf4jInvocationEventEmitter. - JsonInvocationEventEmitter() - Constructor for class com.fayupable.logged.spring.emitter.JsonInvocationEventEmitter
K
- KafkaTraceHeaderCarrier - Class in com.fayupable.logged.spring.kafka
-
Carries a
@Loggedcall chain'sFlowContextacross a Kafka message, by writing it into the message's headers when producing and reading it back when consuming.
L
- lastEvent() - Method in class com.fayupable.logged.test.InMemoryInvocationEventEmitter
-
Returns the most recently recorded event.
- lastMetric() - Method in class com.fayupable.logged.test.InMemoryMetricsRecorder
-
Returns the most recently recorded metric.
- LazyMetricsRecorder - Class in com.fayupable.logged.spring.metrics
-
MetricsRecorderthat defers the choice between a real Micrometer-backed recorder and a no-op fallback to the first actual invocation, instead of to Spring Boot auto-configuration ordering. - LazyMetricsRecorder(ObjectProvider<MeterRegistry>) - Constructor for class com.fayupable.logged.spring.metrics.LazyMetricsRecorder
- logged() - Method in class com.fayupable.logged.benchmarks.LoggedAspectBenchmark
- Logged - Annotation Interface in com.fayupable.logged.core.annotation
-
Marks a method for automatic observability: invocation logging and metrics collection through an AOP-based interceptor provided by an adapter module (for example logged-spring).
- logged_AverageTime(InfraControl, ThreadParams) - Method in class com.fayupable.logged.benchmarks.jmh_generated.LoggedAspectBenchmark_logged_jmhTest
- logged_avgt_jmhStub(InfraControl, RawResults, BenchmarkParams, IterationParams, ThreadParams, Blackhole, Control, int, LoggedAspectBenchmark_jmhType) - Static method in class com.fayupable.logged.benchmarks.jmh_generated.LoggedAspectBenchmark_logged_jmhTest
- logged_sample_jmhStub(InfraControl, RawResults, BenchmarkParams, IterationParams, ThreadParams, Blackhole, Control, int, SampleBuffer, int, long, int, LoggedAspectBenchmark_jmhType) - Static method in class com.fayupable.logged.benchmarks.jmh_generated.LoggedAspectBenchmark_logged_jmhTest
- logged_SampleTime(InfraControl, ThreadParams) - Method in class com.fayupable.logged.benchmarks.jmh_generated.LoggedAspectBenchmark_logged_jmhTest
- logged_SingleShotTime(InfraControl, ThreadParams) - Method in class com.fayupable.logged.benchmarks.jmh_generated.LoggedAspectBenchmark_logged_jmhTest
- logged_ss_jmhStub(InfraControl, RawResults, BenchmarkParams, IterationParams, ThreadParams, Blackhole, Control, int, int, LoggedAspectBenchmark_jmhType) - Static method in class com.fayupable.logged.benchmarks.jmh_generated.LoggedAspectBenchmark_logged_jmhTest
- logged_Throughput(InfraControl, ThreadParams) - Method in class com.fayupable.logged.benchmarks.jmh_generated.LoggedAspectBenchmark_logged_jmhTest
- logged_thrpt_jmhStub(InfraControl, RawResults, BenchmarkParams, IterationParams, ThreadParams, Blackhole, Control, int, LoggedAspectBenchmark_jmhType) - Static method in class com.fayupable.logged.benchmarks.jmh_generated.LoggedAspectBenchmark_logged_jmhTest
- loggedAspect(InvocationEventEmitter, MetricsRecorder, IClientInfoPort, LoggedProperties) - Method in class com.fayupable.logged.spring.config.LoggedAutoConfiguration
- LoggedAspect - Class in com.fayupable.logged.spring.aspect
-
Spring AOP interceptor that implements the behavior described by
Logged. - LoggedAspect(InvocationEventEmitter, MetricsRecorder, IClientInfoPort) - Constructor for class com.fayupable.logged.spring.aspect.LoggedAspect
-
Creates an aspect with MDC propagation enabled, the default for any consumer that does not need to disable it explicitly.
- LoggedAspect(InvocationEventEmitter, MetricsRecorder, IClientInfoPort, boolean) - Constructor for class com.fayupable.logged.spring.aspect.LoggedAspect
-
Creates an aspect with explicit control over MDC propagation.
- LoggedAspectBenchmark - Class in com.fayupable.logged.benchmarks
-
Measures the overhead
LoggedAspectadds to a method call, compared to calling the same logic directly with no interception at all. - LoggedAspectBenchmark() - Constructor for class com.fayupable.logged.benchmarks.LoggedAspectBenchmark
- LoggedAspectBenchmark_baseline_jmhTest - Class in com.fayupable.logged.benchmarks.jmh_generated
- LoggedAspectBenchmark_baseline_jmhTest() - Constructor for class com.fayupable.logged.benchmarks.jmh_generated.LoggedAspectBenchmark_baseline_jmhTest
- LoggedAspectBenchmark_jmhType - Class in com.fayupable.logged.benchmarks.jmh_generated
- LoggedAspectBenchmark_jmhType() - Constructor for class com.fayupable.logged.benchmarks.jmh_generated.LoggedAspectBenchmark_jmhType
- LoggedAspectBenchmark_jmhType_B1 - Class in com.fayupable.logged.benchmarks.jmh_generated
- LoggedAspectBenchmark_jmhType_B1() - Constructor for class com.fayupable.logged.benchmarks.jmh_generated.LoggedAspectBenchmark_jmhType_B1
- LoggedAspectBenchmark_jmhType_B2 - Class in com.fayupable.logged.benchmarks.jmh_generated
- LoggedAspectBenchmark_jmhType_B2() - Constructor for class com.fayupable.logged.benchmarks.jmh_generated.LoggedAspectBenchmark_jmhType_B2
- LoggedAspectBenchmark_jmhType_B3 - Class in com.fayupable.logged.benchmarks.jmh_generated
- LoggedAspectBenchmark_jmhType_B3() - Constructor for class com.fayupable.logged.benchmarks.jmh_generated.LoggedAspectBenchmark_jmhType_B3
- LoggedAspectBenchmark_logged_jmhTest - Class in com.fayupable.logged.benchmarks.jmh_generated
- LoggedAspectBenchmark_logged_jmhTest() - Constructor for class com.fayupable.logged.benchmarks.jmh_generated.LoggedAspectBenchmark_logged_jmhTest
- LoggedAutoConfiguration - Class in com.fayupable.logged.spring.config
-
Auto-configuration that wires the default port implementations and
LoggedAspectinto a Spring Boot application, so that adding this module as a dependency is enough for@Loggedto work without any further setup. - LoggedAutoConfiguration() - Constructor for class com.fayupable.logged.spring.config.LoggedAutoConfiguration
- LoggedMdcKeys - Class in com.fayupable.logged.spring.aspect
-
The
MDCkey names this library writes to while a@Loggedmethod is executing. - LoggedProperties - Class in com.fayupable.logged.spring.config
-
Configuration properties for this library, bound under the
loggedprefix in an application's own configuration (for exampleapplication.yml). - LoggedProperties() - Constructor for class com.fayupable.logged.spring.config.LoggedProperties
- LoggedProperties.ClientInfo - Class in com.fayupable.logged.spring.config
-
Properties controlling how the caller's identity is resolved.
- LoggedProperties.Mdc - Class in com.fayupable.logged.spring.config
-
Properties controlling MDC propagation.
- LoggedProperties.Metrics - Class in com.fayupable.logged.spring.config
-
Properties controlling metrics recording.
- loggedTargetGuardBeanPostProcessor() - Static method in class com.fayupable.logged.spring.config.LoggedAutoConfiguration
-
Registered as a
staticbean method, per Spring's own guidance forBeanPostProcessorbeans: this ensures the processor is created early enough to inspect every other bean in this context, without triggering premature instantiation of this configuration class itself. - LoggedTargetGuardBeanPostProcessor - Class in com.fayupable.logged.spring.guard
-
Fails application startup when
Loggedis applied to a method that cannot be correctly instrumented: a method on a JPA entity, a Spring Data repository interface implementation, a class annotated with@Repository, or a method returning a reactiveorg.reactivestreams.Publisher(Reactor'sMono/Flux, or an RxJava adapter that implements the same interface). - LoggedTargetGuardBeanPostProcessor() - Constructor for class com.fayupable.logged.spring.guard.LoggedTargetGuardBeanPostProcessor
- logInvocation(ProceedingJoinPoint, Logged) - Method in class com.fayupable.logged.spring.aspect.LoggedAspect
-
Intercepts a
Logged-annotated method call, measuring its duration and outcome, and delegating the emission decision and call-chain tracking to their respective collaborators.
M
- Mdc() - Constructor for class com.fayupable.logged.spring.config.LoggedProperties.Mdc
- METHOD_NAME - Static variable in class com.fayupable.logged.spring.aspect.LoggedMdcKeys
-
The method name resolved for the currently executing invocation, the same value reported as
MethodInvocationEvent.methodName(). - MethodInvocationEvent - Record Class in com.fayupable.logged.core.model
-
Immutable record describing a single method invocation captured by a
Loggedinterceptor. - MethodInvocationEvent(String, String, Instant, long, boolean, String, String, String, String, String, int) - Constructor for record class com.fayupable.logged.core.model.MethodInvocationEvent
-
Creates an instance of a
MethodInvocationEventrecord class. - methodName() - Method in record class com.fayupable.logged.core.model.MethodInvocationEvent
-
Returns the value of the
methodNamerecord component. - methodName() - Method in record class com.fayupable.logged.test.RecordedMetric
-
Returns the value of the
methodNamerecord component. - metrics() - Method in class com.fayupable.logged.test.InMemoryMetricsRecorder
-
Returns every metric recorded so far, in recording order.
- Metrics() - Constructor for class com.fayupable.logged.spring.config.LoggedProperties.Metrics
- metricsRecorder(ObjectProvider<MeterRegistry>) - Method in class com.fayupable.logged.spring.config.LoggedAutoConfiguration
- MetricsRecorder - Interface in com.fayupable.logged.core.port
-
Output port responsible for recording invocation metrics: how many times a method was called, how long calls took, and how many of them failed.
- MicrometerMetricsRecorder - Class in com.fayupable.logged.spring.metrics
-
MetricsRecorderimplementation backed by Micrometer. - MicrometerMetricsRecorder(MeterRegistry) - Constructor for class com.fayupable.logged.spring.metrics.MicrometerMetricsRecorder
N
- next() - Method in record class com.fayupable.logged.core.model.FlowContext
-
Creates the context for a nested call one level deeper than this one, keeping the same
FlowContext.traceId()so it remains part of the same chain. - noOpClientInfoPort() - Method in class com.fayupable.logged.spring.config.LoggedAutoConfiguration
- NoOpClientInfoPort - Class in com.fayupable.logged.core.port
-
A no-op
IClientInfoPortthat always reports the caller as unknown. - NoOpClientInfoPort() - Constructor for class com.fayupable.logged.core.port.NoOpClientInfoPort
- NoOpInvocationEventEmitter - Class in com.fayupable.logged.core.port
-
A no-op
InvocationEventEmitterthat discards every event it receives. - NoOpInvocationEventEmitter() - Constructor for class com.fayupable.logged.core.port.NoOpInvocationEventEmitter
- noOpMetricsRecorder() - Method in class com.fayupable.logged.spring.config.LoggedAutoConfiguration
- NoOpMetricsRecorder - Class in com.fayupable.logged.core.port
-
A no-op
MetricsRecorderthat discards every invocation it is asked to record. - NoOpMetricsRecorder() - Constructor for class com.fayupable.logged.core.port.NoOpMetricsRecorder
P
- postProcessBeforeInitialization(Object, String) - Method in class com.fayupable.logged.spring.guard.LoggedTargetGuardBeanPostProcessor
R
- RabbitTraceHeaderCarrier - Class in com.fayupable.logged.spring.rabbitmq
-
Carries a
@Loggedcall chain'sFlowContextacross a RabbitMQ message, by writing it into the message's properties when publishing and reading it back when consuming. - readAndAdopt(Function<String, String>, Runnable) - Static method in class com.fayupable.logged.spring.http.HttpTraceHeaderCarrier
-
Reads a
FlowContextthroughheaderReader, if present, adopts it as the active context on this thread for the duration ofwork, and restores this thread's previous context again afterward, regardless of whetherworkcompletes normally or throws. - readAndAdopt(Headers, Runnable) - Static method in class com.fayupable.logged.spring.kafka.KafkaTraceHeaderCarrier
-
Reads a
FlowContextfromheaders, if present, adopts it as the active context on this thread for the duration ofwork, and restores this thread's previous context again afterward, regardless of whetherworkcompletes normally or throws. - readAndAdopt(MessageProperties, Runnable) - Static method in class com.fayupable.logged.spring.rabbitmq.RabbitTraceHeaderCarrier
-
Reads a
FlowContextfromproperties, if present, adopts it as the active context on this thread for the duration ofwork, and restores this thread's previous context again afterward, regardless of whetherworkcompletes normally or throws. - record(String, String, long, boolean, String) - Method in interface com.fayupable.logged.core.port.MetricsRecorder
-
Records the outcome and duration of a single method invocation.
- record(String, String, long, boolean, String) - Method in class com.fayupable.logged.core.port.NoOpMetricsRecorder
- record(String, String, long, boolean, String) - Method in class com.fayupable.logged.spring.metrics.LazyMetricsRecorder
- record(String, String, long, boolean, String) - Method in class com.fayupable.logged.spring.metrics.MicrometerMetricsRecorder
-
Records the given invocation against the invocation counter, the duration timer, and, if the call failed, the error counter.
- record(String, String, long, boolean, String) - Method in class com.fayupable.logged.test.InMemoryMetricsRecorder
- RecordedMetric - Record Class in com.fayupable.logged.test
-
A single call recorded by
InMemoryMetricsRecorder, mirroring the parameters ofMetricsRecorder.record(java.lang.String, java.lang.String, long, boolean, java.lang.String)so a test can assert on exactly what was reported. - RecordedMetric(String, String, long, boolean, String) - Constructor for record class com.fayupable.logged.test.RecordedMetric
-
Creates an instance of a
RecordedMetricrecord class. - RequestAttributesPropagatingExecutor - Class in com.fayupable.logged.spring.security
-
Executordecorator that carries the submitting thread's Spring WebRequestAttributesover to whatever thread actually runs the submitted task. - RequestAttributesPropagatingExecutor(Executor) - Constructor for class com.fayupable.logged.spring.security.RequestAttributesPropagatingExecutor
-
Wraps
delegateso that every task submitted through this executor carries the submitting thread'sRequestAttributesinto whichever threaddelegateactually runs it on. - RequestAttributesTaskDecorator - Class in com.fayupable.logged.spring.security
-
TaskDecoratorthat carries the submitting thread's Spring WebRequestAttributesinto whatever thread Spring's@Asyncinfrastructure actually runs the task on. - RequestAttributesTaskDecorator() - Constructor for class com.fayupable.logged.spring.security.RequestAttributesTaskDecorator
- resolveCallerIdentity() - Method in interface com.fayupable.logged.core.port.IClientInfoPort
-
Resolves an identifier describing who triggered the current invocation.
- resolveCallerIdentity() - Method in class com.fayupable.logged.core.port.NoOpClientInfoPort
- resolveCallerIdentity() - Method in class com.fayupable.logged.spring.security.HttpRequestClientInfoAdapter
- resolveCallerIdentity() - Method in class com.fayupable.logged.spring.security.SpringSecurityClientInfoAdapter
- resolveCallerIdentity() - Method in class com.fayupable.logged.test.InMemoryClientInfoPort
- resolveCallerIp() - Method in interface com.fayupable.logged.core.port.IClientInfoPort
-
Resolves the IP address of the caller that triggered the current invocation, independent of whatever
IClientInfoPort.resolveCallerIdentity()itself resolves to. - resolveCallerIp() - Method in class com.fayupable.logged.spring.security.HttpRequestClientInfoAdapter
- resolveCallerIp() - Method in class com.fayupable.logged.spring.security.SpringSecurityClientInfoAdapter
-
Resolves the caller's IP address independent of
SpringSecurityClientInfoAdapter.resolveCallerIdentity()'s outcome, unlike that method's authenticated-principal-first fallback chain. - resolveCallerIp() - Method in class com.fayupable.logged.test.InMemoryClientInfoPort
- root() - Static method in record class com.fayupable.logged.core.model.FlowContext
-
Creates the root context for a new call chain, deriving the trace id from a single 64-bit random value.
- rootCauseType() - Method in record class com.fayupable.logged.core.model.MethodInvocationEvent
-
Returns the value of the
rootCauseTyperecord component.
S
- sampleRate() - Element in annotation interface com.fayupable.logged.core.annotation.Logged
-
The fraction of invocations that should actually be logged, expressed as a value between 0.0 (never log) and 1.0 (always log).
- SecurityContextPropagatingExecutor - Class in com.fayupable.logged.spring.security
-
Executordecorator that carries the submitting thread's Spring SecuritySecurityContextover to whatever thread actually runs the submitted task. - SecurityContextPropagatingExecutor(Executor) - Constructor for class com.fayupable.logged.spring.security.SecurityContextPropagatingExecutor
-
Wraps
delegateso that every task submitted through this executor carries the submitting thread'sSecurityContextinto whichever threaddelegateactually runs it on. - SecurityContextTaskDecorator - Class in com.fayupable.logged.spring.security
-
TaskDecoratorthat carries the submitting thread's Spring SecuritySecurityContextinto whatever thread Spring's@Asyncinfrastructure actually runs the task on. - SecurityContextTaskDecorator() - Constructor for class com.fayupable.logged.spring.security.SecurityContextTaskDecorator
- setCallerIdentity(String) - Method in class com.fayupable.logged.test.InMemoryClientInfoPort
-
Changes the caller identity reported by subsequent calls to
InMemoryClientInfoPort.resolveCallerIdentity(). - setCallerIp(String) - Method in class com.fayupable.logged.test.InMemoryClientInfoPort
-
Changes the IP address reported by subsequent calls to
InMemoryClientInfoPort.resolveCallerIp(), for testing a@Logged(includeIp = true)method'sMethodInvocationEvent.callerIp()without wiring a real HTTP request. - setEnabled(boolean) - Method in class com.fayupable.logged.spring.config.LoggedProperties.Mdc
- setEnabled(boolean) - Method in class com.fayupable.logged.spring.config.LoggedProperties.Metrics
- setEnabled(boolean) - Method in class com.fayupable.logged.spring.config.LoggedProperties
- setTrustForwardedHeaders(boolean) - Method in class com.fayupable.logged.spring.config.LoggedProperties.ClientInfo
- setUp() - Method in class com.fayupable.logged.benchmarks.LoggedAspectBenchmark
- setupInvocationMutex - Variable in class com.fayupable.logged.benchmarks.jmh_generated.LoggedAspectBenchmark_jmhType_B2
- setupInvocationMutexUpdater - Static variable in class com.fayupable.logged.benchmarks.jmh_generated.LoggedAspectBenchmark_jmhType_B2
- setupIterationMutex - Variable in class com.fayupable.logged.benchmarks.jmh_generated.LoggedAspectBenchmark_jmhType_B2
- setupIterationMutexUpdater - Static variable in class com.fayupable.logged.benchmarks.jmh_generated.LoggedAspectBenchmark_jmhType_B2
- setupTrialMutex - Variable in class com.fayupable.logged.benchmarks.jmh_generated.LoggedAspectBenchmark_jmhType_B2
- setupTrialMutexUpdater - Static variable in class com.fayupable.logged.benchmarks.jmh_generated.LoggedAspectBenchmark_jmhType_B2
- Slf4jInvocationEventEmitter - Class in com.fayupable.logged.spring.emitter
-
Default
InvocationEventEmitterthat writes each event as a single, human-readable line through SLF4J. - Slf4jInvocationEventEmitter() - Constructor for class com.fayupable.logged.spring.emitter.Slf4jInvocationEventEmitter
- slowThresholdMs() - Element in annotation interface com.fayupable.logged.core.annotation.Logged
-
The duration, in milliseconds, above which an invocation is considered slow.
- springSecurityClientInfoAdapter(LoggedProperties) - Method in class com.fayupable.logged.spring.config.LoggedAutoConfiguration
- SpringSecurityClientInfoAdapter - Class in com.fayupable.logged.spring.security
-
IClientInfoPortimplementation that resolves the caller as the authenticated Spring Security principal when one is present, falling back toRequestClientIpResolverotherwise. - SpringSecurityClientInfoAdapter(boolean) - Constructor for class com.fayupable.logged.spring.security.SpringSecurityClientInfoAdapter
- success() - Method in record class com.fayupable.logged.core.model.MethodInvocationEvent
-
Returns the value of the
successrecord component. - success() - Method in record class com.fayupable.logged.test.RecordedMetric
-
Returns the value of the
successrecord component.
T
- tearInvocationMutex - Variable in class com.fayupable.logged.benchmarks.jmh_generated.LoggedAspectBenchmark_jmhType_B2
- tearInvocationMutexUpdater - Static variable in class com.fayupable.logged.benchmarks.jmh_generated.LoggedAspectBenchmark_jmhType_B2
- tearIterationMutex - Variable in class com.fayupable.logged.benchmarks.jmh_generated.LoggedAspectBenchmark_jmhType_B2
- tearIterationMutexUpdater - Static variable in class com.fayupable.logged.benchmarks.jmh_generated.LoggedAspectBenchmark_jmhType_B2
- tearTrialMutex - Variable in class com.fayupable.logged.benchmarks.jmh_generated.LoggedAspectBenchmark_jmhType_B2
- tearTrialMutexUpdater - Static variable in class com.fayupable.logged.benchmarks.jmh_generated.LoggedAspectBenchmark_jmhType_B2
- timestamp() - Method in record class com.fayupable.logged.core.model.MethodInvocationEvent
-
Returns the value of the
timestamprecord component. - toString() - Method in record class com.fayupable.logged.core.model.FlowContext
-
Returns a string representation of this record class.
- toString() - Method in record class com.fayupable.logged.core.model.MethodInvocationEvent
-
Returns a string representation of this record class.
- toString() - Method in record class com.fayupable.logged.test.RecordedMetric
-
Returns a string representation of this record class.
- TRACE_ID - Static variable in class com.fayupable.logged.spring.aspect.LoggedMdcKeys
-
The
FlowContext.traceId()shared by every call in the same call chain. - TRACE_ID_HEADER - Static variable in class com.fayupable.logged.spring.http.HttpTraceHeaderCarrier
- traceId() - Method in record class com.fayupable.logged.core.model.FlowContext
-
Returns the value of the
traceIdrecord component. - traceId() - Method in record class com.fayupable.logged.core.model.MethodInvocationEvent
-
Returns the value of the
traceIdrecord component.
W
- writeToHeaders(BiConsumer<String, String>) - Static method in class com.fayupable.logged.spring.http.HttpTraceHeaderCarrier
-
Writes the current thread's
FlowContext, if any is active, throughheaderWriterunderHttpTraceHeaderCarrier.TRACE_ID_HEADER/HttpTraceHeaderCarrier.DEPTH_HEADER. - writeToHeaders(Headers) - Static method in class com.fayupable.logged.spring.kafka.KafkaTraceHeaderCarrier
-
Writes the current thread's
FlowContext, if any is active, intoheadersasKafkaTraceHeaderCarrier.TRACE_ID_HEADER/KafkaTraceHeaderCarrier.DEPTH_HEADERentries. - writeToHeaders(MessageProperties) - Static method in class com.fayupable.logged.spring.rabbitmq.RabbitTraceHeaderCarrier
-
Writes the current thread's
FlowContext, if any is active, intopropertiesasRabbitTraceHeaderCarrier.TRACE_ID_HEADER/RabbitTraceHeaderCarrier.DEPTH_HEADERheader entries.
All Classes and Interfaces|All Packages|Constant Field Values