Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Task] add NonCachingRotatingFileHanlder for worker task #41064

Merged
merged 2 commits into from
Jul 28, 2024

Conversation

HuanjieGuo
Copy link
Contributor

You can see the detail in #40880

  • Currently, we do not have any worker log disk isolation, and a bug in a dag can write a 10Gb + file, which can cause the cluster out of service.

  • This PR change the NonCachingFileHandler -> NonCachingRotatingFileHandler in FileTaskHandler, and users can limit the log rotate size for a task.

Copy link

boring-cyborg bot commented Jul 27, 2024

Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contributors' Guide (https://github.com/apache/airflow/blob/main/contributing-docs/README.rst)
Here are some useful points:

  • Pay attention to the quality of your code (ruff, mypy and type annotations). Our pre-commits will help you with that.
  • In case of a new feature add useful documentation (in docstrings or in docs/ directory). Adding a new operator? Check this short guide Consider adding an example DAG that shows how users should use it.
  • Consider using Breeze environment for testing locally, it's a heavy docker but it ships with a working Airflow and a lot of integrations.
  • Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
  • Please follow ASF Code of Conduct for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
  • Be sure to read the Airflow Coding style.
  • Always keep your Pull Requests rebased, otherwise your build might fail due to changes not related to your commits.
    Apache Airflow is a community-driven project and together we are making it better 🚀.
    In case of doubts contact the developers at:
    Mailing List: dev@airflow.apache.org
    Slack: https://s.apache.org/airflow-slack

@potiuk
Copy link
Member

potiuk commented Jul 27, 2024

Are you sure this change is going to be backwards compatible?

@HuanjieGuo
Copy link
Contributor Author

HuanjieGuo commented Jul 28, 2024

Are you sure this change is going to be backwards compatible?

@potiuk

the new added parameters all have default value, should not break the existed init process for FileTaskHandler

About the running logic:

NonCachingRotatingFileHandler -> RotatingFileHandler -> BaseRotatingHandler -> FileHandler

NonCachingFileHandler -> FileHandler

In the BaseRotatingHandler, the code will check if it needs to do the rollover.

    def emit(self, record):
        """
        Emit a record.

        Output the record to the file, catering for rollover as described
        in doRollover().
        """
        try:
            if self.shouldRollover(record):
                self.doRollover()
            logging.FileHandler.emit(self, record)
        except Exception:
            self.handleError(record)

In the RotatingFileHandler, the rolling over check is based on if self.maxBytes > 0.

    def shouldRollover(self, record):
        """
        Determine if rollover should occur.

        Basically, see if the supplied record would cause the file to exceed
        the size limit we have.
        """
        if self.stream is None:                 # delay was set...
            self.stream = self._open()
        if self.maxBytes > 0:                   # are we rolling over?
            msg = "%s\n" % self.format(record)
            self.stream.seek(0, 2)  #due to non-posix-compliant Windows feature
            if self.stream.tell() + len(msg) >= self.maxBytes:
                return 1
        return 0

since the default maxBytes for this change is set to 0, so the call to the BaseRotatingHandler.emit() will directly call the logging.FileHandler.emit(self, record).

It should be the same as we directly call the NonCachingFileHandler.emit()

Copy link
Member

@potiuk potiuk left a comment

Choose a reason for hiding this comment

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

LGTM

@potiuk potiuk merged commit b6ed1a9 into apache:main Jul 28, 2024
48 checks passed
Copy link

boring-cyborg bot commented Jul 28, 2024

Awesome work, congrats on your first merged pull request! You are invited to check our Issue Tracker for additional contributions.

@potiuk
Copy link
Member

potiuk commented Jul 28, 2024

Cool!

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.

3 participants