Direct cloud logging

[scwhittle]

Please add a meaningful description for your change here

---

Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:

• Mention the appropriate issue in your description (for example: addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, comment fixes #<ISSUE NUMBER> instead.
• Update CHANGES.md with noteworthy changes.
• If this contribution is large, please file an Apache Individual Contributor License Agreement.

See the Contributor Guide for more tips on how to make review process smoother.

To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md

GitHub Actions Tests Status (on master branch)

See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.

[gemini-code-assist]

Summary of Changes

Hello @scwhittle, I'm Gemini Code Assist¹! 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 enhances Dataflow worker logging by enabling direct transmission of logs to Google Cloud Logging. This change aims to reduce log latency and improve reliability by allowing logs to bypass the traditional disk-based ingestion mechanism. A new configuration option provides granular control over which log levels are directly uploaded, offering more flexibility for users to manage their logging behavior.

Highlights

• Direct Cloud Logging Integration: Introduced the capability for Dataflow workers to directly upload logs to Google Cloud Logging, bypassing disk-based logging for messages at or below a configurable threshold.
• New Pipeline Option: Added a new pipeline option, getDefaultWorkerDirectLoggerLevel, allowing users to specify the minimum log level for direct upload to Cloud Logging.
• Logging Handler Refactoring: Refactored the DataflowWorkerLoggingHandler to support dual-path logging (disk-based and direct Cloud Logging) and improved thread safety and nullability handling.
• Dependency Update: Added the google-cloud-logging dependency to enable direct interaction with Google Cloud Logging services.
• GCE Metadata Utility Enhancement: Extended GceMetadataUtil to fetch the Dataflow worker's cloud region, which is used for direct logging metadata.

🧠 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

• buildSrc/src/main/groovy/org/apache/beam/gradle/BeamModulePlugin.groovy
  • Added the google_cloud_logging dependency to the build configuration.
• runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/options/DataflowWorkerLoggingOptions.java
  • Introduced getDefaultWorkerDirectLoggerLevel and setDefaultWorkerDirectLoggerLevel methods to control direct logging levels.
• runners/google-cloud-dataflow-java/worker/build.gradle
  • Added google_cloud_logging as an implementation dependency for the Dataflow worker.
• runners/google-cloud-dataflow-java/worker/src/main/java/org/apache/beam/runners/dataflow/worker/logging/DataflowWorkerLoggingHandler.java
  • Imported necessary Google Cloud Logging classes for direct logging.
  • Added fields for direct logging configuration and a delegate handler.
  • Modified the constructor to accept a LoggingHandler.LogTarget.
  • Implemented helper methods directLoggingLabels, middleCrop, and severityFor for log entry construction.
  • Introduced an inner class DataflowDirectCloudLoggingHandler to encapsulate direct logging logic.
  • Added enableDirectLogger method to initialize and configure the direct logging handler.
  • Updated the publish method to conditionally route log records to either disk or the direct Cloud Logging handler based on the configured level.
  • Renamed the original disk-based publish method to publishToDisk.
  • Removed the publish(BeamFnApi.LogEntry) method.
  • Synchronized createOutputStream and rolloverOutputStreamIfNeeded methods for thread safety.
  • Modified writeIfNotEmpty to accept a JsonGenerator parameter.
  • Applied @GuardedBy and @Nullable annotations to generator and counter fields.
• runners/google-cloud-dataflow-java/worker/src/main/java/org/apache/beam/runners/dataflow/worker/logging/DataflowWorkerLoggingInitializer.java
  • Configured the loggingHandler to enable the direct logger based on the DataflowWorkerLoggingOptions.
• runners/google-cloud-dataflow-java/worker/src/test/java/org/apache/beam/runners/dataflow/worker/logging/DataflowWorkerLoggingHandlerTest.java
  • Added a restoreStdOut JUnit rule to manage System.out during tests.
  • Updated createJson methods to include LoggingHandler.LogTarget in the DataflowWorkerLoggingHandler constructor.
  • Introduced createDirectJson and createDirectJsonWithCustomMdc helper methods for testing direct logging.
  • Removed tests and helper methods related to BeamFnApi.LogEntry.
  • Added new test cases to verify the functionality of direct logging, including MDC integration, custom formatters, exception handling, and scenarios with unset values.
• sdks/java/extensions/google-cloud-platform-core/src/main/java/org/apache/beam/sdk/extensions/gcp/util/GceMetadataUtil.java
  • Added a new method fetchDataflowRegion to retrieve the cloud region from GCE metadata.

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. ↩