You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
API reference for pushgateway, textfile, and multiprocess #1161
Title: docs: add API reference for pushgateway, textfile, and multiprocess
Following the API reference work in #1021 (metric types) and the existing HTTP exporting docs, the pushgateway, textfile, and multiprocess docs have the same gap — examples without formal parameter documentation.
Currently 88 lines with good examples but no formal parameter tables for:
push_to_gateway(gateway, job, registry, grouping_key, timeout, handler, compression) — full signature with types and defaults undocumented
pushadd_to_gateway() — same params, registry is Optional[Collector] here (unlike push_to_gateway)
delete_from_gateway(gateway, job, grouping_key, timeout, handler) — no registry or compression params (differs from the other two)
Handler functions (default_handler) — the handler protocol (accepts url, method, timeout, headers, content) is only in the source docstring, not in the docs site
compression parameter ('gzip' or 'snappy') — not mentioned in the docs at all
Textfile (docs/content/exporting/textfile.md)
Only 23 lines. write_to_textfile() has undocumented parameters:
Hi @csmarchbanks , I'd like to work on this! I'll follow the same pattern established in PR #1159 - API Reference sections with parameter tables and a validation script.
Activity
kkukadia commentedon Apr 10, 2026
Hi @csmarchbanks , I'd like to work on this! I'll follow the same pattern established in PR #1159 - API Reference sections with parameter tables and a validation script.
docs: add API reference for pushgateway, textfile, and multiprocess
docs: add API reference for pushgateway, textfile, and multiprocess
docs: add API reference for pushgateway, textfile, and multiprocess (#…