Skip to content

feat(logging): Support functional interface in addition to AspectJ @Logging annotation#2205

Merged
phipag merged 19 commits intomainfrom
phipag/logging-imperative-style
Oct 27, 2025
Merged

feat(logging): Support functional interface in addition to AspectJ @Logging annotation#2205
phipag merged 19 commits intomainfrom
phipag/logging-imperative-style

Conversation

@phipag
Copy link
Contributor

@phipag phipag commented Oct 17, 2025 •
edited
Loading

Summary

This PR introduces an alternative functional interface to the Logging utility that does not depend on the AspectJ @Logging annotation. We re-use PowertoolsLogging as entry point for the Powertools logging experience which exposes two new methods:

  1. initializeLogging() – has some method overloads for convenience
  2. clearState() – can optionally clear the logging context as well

This is also thread-safe now.

We also add a new E2E test asserting that it yields the exact same outputs as the AspectJ aspect based way.

The before and after compared to AspectJ looks like this:

Usage with AspectJ

public class App implements RequestHandler<APIGatewayProxyRequestEvent, String> {
    private static final Logger log = LoggerFactory.getLogger(App.class);

    @Logging(logEvent = true, logResponse = true, samplingRate = 0.7, correlationIdPath = "requestContext.requestId")
    public String handleRequest(APIGatewayProxyRequestEvent input, Context context) {
        log.info("Processing request");
        return "Hello World";
    }
}

Usage without AspectJ

public class App implements RequestHandler<APIGatewayProxyRequestEvent, String> {
    private static final Logger log = LoggerFactory.getLogger(App.class);

    public String handleRequest(APIGatewayProxyRequestEvent input, Context context) {
        try {
                PowertoolsLogging.initializeLogging(context, 0.7, "requestContext.requestId", input);
                
                // Manual event logging (if desired)
                log.info("Handler Event", entry("event", input));
                
                log.info("Processing request");
                String response = "Hello World";
                
                // Manual response logging (if desired)
                log.info("Handler Response", entry("response", response));
                
                return response;
        } finally {
            PowertoolsLogging.clearState()
        }
    }
}

Note: In this small RFC I am investigating an improvement to this imperative API leveraging a more modern functional Middleware approach similar to TypeScript middy.js. See #2202

Changes

Issue number: #2204

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@phipag phipag self-assigned this Oct 17, 2025
@phipag phipag added feature-request New feature or request logger labels Oct 17, 2025
@phipag phipag linked an issue Oct 17, 2025 that may be closed by this pull request
Feature request: Support functional interface for Logging utility #2204
Closed
2 tasks
@phipag phipag mentioned this pull request Oct 17, 2025
Closed
2 tasks
@phipag phipag marked this pull request as ready for review October 20, 2025 07:43
@hjgraca
Copy link
Collaborator

hjgraca commented Oct 20, 2025

Just one small observation on the API design and developer experience.
Unfortunately we need to have try... finally block, but will developers consistently remember to call clearState() in finally blocks?

Could we add to the API the possibility to create a functional wrapper that handles the try-finally automatically? I think this is what you mention in the #2202 issue

For example:

PowertoolsLogging.withLogging(context, config, () -> {
    log.info("Processing request");
    return "Hello World";
});

hjgraca
hjgraca reviewed Oct 20, 2025
View reviewed changes
@phipag
Copy link
Contributor Author

phipag commented Oct 20, 2025

Just one small observation on the API design and developer experience. Unfortunately we need to have try... finally block, but will developers consistently remember to call clearState() in finally blocks?

Could we add to the API the possibility to create a functional wrapper that handles the try-finally automatically? I think this is what you mention in the #2202 issue

For example:

PowertoolsLogging.withLogging(context, config, () -> {
    log.info("Processing request");
    return "Hello World";
});

Yes, I like this idea. I'll implement such a wrapper function.

Correct, issue #2202 will abstract such wrappers away from individual utilities to a middleware approach which is more scalable. But I like the idea of having a functional wrapper for an individual utility as well for customers who simply want to get started with a utility.

This was referenced Oct 21, 2025
Merged
Merged
@phipag phipag changed the title feat(logging): Support functional interface in addition to AspectJ @Logging annotation feat(logging): Support functional interface in addition to AspectJ @Logging annotation Oct 21, 2025
@sonarqubecloud
Copy link

sonarqubecloud bot commented Oct 27, 2025

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@phipag
Copy link
Contributor Author

phipag commented Oct 27, 2025 •
edited
Loading

Thanks @hjgraca. I implemented your suggestions. See this file for how it is used in E2E tests: https://github.com/aws-powertools/powertools-lambda-java/pull/2205/files#diff-3bcb5e87cb7cc4655b7d9427e50b10a9546c2a92910f6ae860635a041db2ebc9

@phipag phipag requested a review from hjgraca October 27, 2025 11:06
@phipag phipag merged commit 1296a9d into main Oct 27, 2025
21 checks passed
@phipag phipag deleted the phipag/logging-imperative-style branch October 27, 2025 11:13
@AdamBien AdamBien mentioned this pull request Oct 30, 2025
Open
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hjgraca hjgraca hjgraca approved these changes

Assignees

@phipag phipag

Labels

feature-request New feature or request logger size/XXL

Projects

Powertools for AWS Lambda (Java)
Status: Coming soon

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Feature request: Support functional interface for Logging utility

2 participants

@phipag @hjgraca