fix: Fix file descriptor leaks in WriteApi #95
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ecsv
changed the title
When a worker is created for a flush of the worker on close, it will just create a new object which makes it harder for for the garbage collector to correctly free the unused objects because the Worker itself has a reference to the WriteApi object it called. This is especially frustrating for WriteType::SYNCHRONOUS which doesn't need workers at all.
The worker will be flushed when something calls close on the WriteApi. But the worker will still continue to hold an reference to the WriteApi. This prevents an easy cleanup of the WriteApi by the (non-cyclic) garbage collector.
The autoCloseable list of a client is only growing but is never cleared. This causes problems with the reference based garbage collection. But there is nothing more to process when all writers were closed. This problem can often be seen on a system that each call of client->createWriteApi (on the same "global" client) followed by a ->write() will leak one or more file descriptor(s).
Codecov Report
@@ Coverage Diff @@
## master #95 +/- ##
============================================
+ Coverage 81.60% 81.66% +0.06%
- Complexity 378 379 +1
============================================
Files 23 23
Lines 897 900 +3
============================================
+ Hits 732 735 +3
Misses 165 165
Continue to review full report at Codecov.
|
bednar
approved these changes
Sep 29, 2021
peynman
pushed a commit
to peynman/influxdb-client-php
that referenced
this pull request
Mar 7, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed Changes
disable creation of WriteApi worker on close
When a worker is created for a flush of the worker on close, it will just create a new object which makes it harder for for the garbage collector to correctly free the unused objects because the Worker itself has a reference to the WriteApi object it called. This is especially frustrating for WriteType::SYNCHRONOUS which doesn't need workers at all.
ensure worker are destroyed after WriteApi::close
The worker will be flushed when something calls close on the WriteApi. But the worker will still continue to hold an reference to the WriteApi. This prevents an easy cleanup of the WriteApi by the (non-cyclic) garbage collector.
clear Client::autoCloseable on close
The autoCloseable list of a client is only growing but is never cleared. This causes problems with the reference based garbage collection. But there is nothing more to process when all writers were closed.
This problem can often be seen on a system that each call of client->createWriteApi (on the same "global" client) followed by a ->write() will leak one or more file descriptor(s).
Checklist
make testcompletes successfully