Skip to content

[Dataflow Logging handler] Change @LazyInit to AtomicBoolean#37846

Open
arunpandianp wants to merge 1 commit intoapache:masterfrom
arunpandianp:loghandler
Open

[Dataflow Logging handler] Change @LazyInit to AtomicBoolean#37846
arunpandianp wants to merge 1 commit intoapache:masterfrom
arunpandianp:loghandler

Conversation

@arunpandianp
Copy link
Contributor

IIUC, @lazyinit does not provide visibility guarantees. @lazyinit for things like hash code is fine, since the end results are the same.

Here if the thread calling publish didn't see the updated field logs will miss the custom payload.

IIUC, @lazyinit does not provide visibility guarantees.
@lazyinit for things like hash code is fine, since the end results
are the same.

Here if the thread calling publish didn't see the updated field
logs will miss the custom payload.
@arunpandianp
Copy link
Contributor Author

R: @scwhittle

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request addresses a potential concurrency issue within the Dataflow logging handler by enhancing the thread-safety of the logCustomMdc flag. By switching from a simple boolean with @LazyInit to an AtomicBoolean, the change guarantees that updates to this flag are immediately visible to all threads, preventing custom log data from being intermittently omitted due to visibility problems.

Highlights

  • Concurrency Fix: Replaced the @LazyInit annotated boolean field logCustomMdc with an AtomicBoolean to ensure proper visibility guarantees across threads. This prevents potential issues where log messages might miss custom payloads due to stale logCustomMdc values.
  • API Usage Update: Updated all read and write operations for the logCustomMdc field to use the get() and set() methods provided by AtomicBoolean, respectively.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • runners/google-cloud-dataflow-java/worker/src/main/java/org/apache/beam/runners/dataflow/worker/logging/DataflowWorkerLoggingHandler.java
    • Removed the import for com.google.errorprone.annotations.concurrent.LazyInit.
    • Changed the logCustomMdc field from a boolean type annotated with @LazyInit to an AtomicBoolean.
    • Modified the setLogMdc method to use logCustomMdc.set(enabled) instead of direct assignment.
    • Updated conditional checks for logCustomMdc in constructDirectLogEntry and publishToDisk to use logCustomMdc.get().
Activity
  • No human activity has been recorded for this pull request yet.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@github-actions
Copy link
Contributor

Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control. If you'd like to restart, comment assign set of reviewers


/** If true, add SLF4J MDC to custom_data of the log message. */
@LazyInit private boolean logCustomMdc = false;
private AtomicBoolean logCustomMdc = new AtomicBoolean(false);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can be final now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants