docs: add API reference for pushgateway, textfile, and multiprocess#1162
Open
k1chik wants to merge 1 commit intoprometheus:masterfrom
Open
docs: add API reference for pushgateway, textfile, and multiprocess#1162k1chik wants to merge 1 commit intoprometheus:masterfrom
k1chik wants to merge 1 commit intoprometheus:masterfrom
Conversation
Closes prometheus#1161 Adds parameter tables and formal API reference sections to three pages that previously had examples but no parameter documentation. pushgateway.md: documents push_to_gateway, pushadd_to_gateway, delete_from_gateway, instance_ip_grouping_key, and all four built-in handlers (default, basic_auth, tls_auth, passthrough_redirect). textfile.md: documents write_to_textfile with all four parameters including the previously undocumented escaping and tmpdir, plus atomic write semantics and error behavior. multiprocess/_index.md: documents MultiProcessCollector constructor and mark_process_dead with parameter tables including the previously undocumented path parameter on both. Signed-off-by: k1chik <107162115+k1chik@users.noreply.github.com>
k1chik
force-pushed
the
fix/1161-api-reference-pushgateway-textfile-multiprocess
branch
from
b3e3005 to
37d0fa8
Compare
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Closes #1161
Adds parameter tables and formal API reference sections to three pages
that previously had examples but no parameter documentation. Follows the
same pattern as #1021.
pushgateway.md: push_to_gateway, pushadd_to_gateway, delete_from_gateway,
instance_ip_grouping_key, and all four built-in handlers (default_handler,
basic_auth_handler, tls_auth_handler, passthrough_redirect_handler).
textfile.md: write_to_textfile with all four parameters including the
previously undocumented escaping and tmpdir, atomic write semantics, and
error behavior.
multiprocess/_index.md: MultiProcessCollector and mark_process_dead with
parameter tables including the previously undocumented path parameter on both.
cc @csmarchbanks