Index
All Classes and Interfaces|All Packages
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
- callerIdentity() - Method in record class com.fayupable.logged.core.model.MethodInvocationEvent
-
Returns the value of the
callerIdentityrecord component. - className() - Method in record class com.fayupable.logged.core.model.MethodInvocationEvent
-
Returns the value of the
classNamerecord component. - 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.metrics - package com.fayupable.logged.spring.metrics
- com.fayupable.logged.spring.security - package com.fayupable.logged.spring.security
D
- 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. - durationNanos() - Method in record class com.fayupable.logged.core.model.MethodInvocationEvent
-
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.Slf4jInvocationEventEmitter
- 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.
- exceptionType() - Method in record class com.fayupable.logged.core.model.MethodInvocationEvent
-
Returns the value of the
exceptionTyperecord component.
F
- 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.
G
- getClientInfo() - 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.
- 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
I
- IClientInfoPort - Interface in com.fayupable.logged.core.port
-
Output port responsible for resolving who triggered the current method invocation.
- 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.Metrics
- isTrustForwardedHeaders() - Method in class com.fayupable.logged.spring.config.LoggedProperties.ClientInfo
L
- 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) - 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
- 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
- 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.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 on a class that should never carry observability instrumentation: a JPA entity, a Spring Data repository interface implementation, or a class annotated with@Repository. - 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
- 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, 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. - 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
- 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.
- 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
- 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.
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).
- 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.
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.
- 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.
All Classes and Interfaces|All Packages