Skip to content

Add support to write_to_textfile for custom tmpdir #1115

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jul 11, 2025
Merged

Add support to write_to_textfile for custom tmpdir #1115

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7da3eee
Add support to write_to_textfile for custom tmpdir
aadityadhruv Jun 24, 2025
4804d35
Modify write_to_textfile to ensure tmpdir is on same filesystem
aadityadhruv Jul 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions prometheus_client/exposition.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -446,12 +446,21 @@ def factory(cls, registry: CollectorRegistry) -> type:
return MyMetricsHandler


def write_to_textfile(path: str, registry: CollectorRegistry, escaping: str = openmetrics.ALLOWUTF8) -> None:
def write_to_textfile(path: str, registry: CollectorRegistry, escaping: str = openmetrics.ALLOWUTF8, tmpdir: Optional[str] = None) -> None:
"""Write metrics to the given path.

This is intended for use with the Node exporter textfile collector.
The path must end in .prom for the textfile collector to process it."""
tmppath = f'{path}.{os.getpid()}.{threading.current_thread().ident}'
The path must end in .prom for the textfile collector to process it.

An optional tmpdir parameter can be set to determine where the
metrics will be temporarily written to. If not set, it will be in
the same directory as the .prom file. If provided, the path MUST be
on the same filesystem."""
if tmpdir is not None:
filename = os.path.basename(path)
tmppath = f'{os.path.join(tmpdir, filename)}.{os.getpid()}.{threading.current_thread().ident}'
else:
tmppath = f'{path}.{os.getpid()}.{threading.current_thread().ident}'
try:
with open(tmppath, 'wb') as f:
f.write(generate_latest(registry, escaping))
Expand Down