Improve multiprocessing documentation #524
Merged
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.
The current multiprocessing documentation is short, and can lead to some confusion.
This PR addresses the following aspects:
Setting up
prometheus_multiproc_dir
env. var but still fail to collect metrics, usually due to a wrong setting of the variable (see issues Multiprocessing collector doesn't work #490 & Question: how to instrument a multiprocessing program? #382).Separating mandatory steps (1 and 2) from optional steps (3), depending on the usage of
Gauge
. This is because themark_process_dead
function does nothing related toCount
,Summary
orHistogram
metrics, as seen in its definition.cc @brian-brazil