Skip to content
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

Add proxy and client CLI options #112

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add proxy and client CLI options #112

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,25 @@ If the target must be scraped over SSL/TLS, add:
rather than the usual `scheme: https`. Only the default `scheme: http` works with the proxy,
so this workaround is required.

## Proxy CLI Options

| Option | Default | Description |
|--------|---------|-------------|
| --web.listen-address | 8080 | Address to listen on for proxy and client requests.|
| --scrape.max-timeout | 5m | Any scrape with a timeout higher than this will have to be clamped to this|
| --scrape.default-timeout | 15s | If a scrape lacks a timeout, use this value|

## Client CLI Options

| Option | Default | Description|
|--------|---------|------------|
| --proxy-url | | Push proxy to talk to|
| --fqdn | FQDN your host | FQDN to register with|
| --tls.cacert | | \<file> CA certificate to verify peer against |
| --tls.cert | | \<cert> Client certificate file |
| --tls.key | | \<key> Private key file|
| --metrics-addr | | Serve Prometheus metrics at this address|

## Service Discovery

The `/clients` endpoint will return a list of all registered clients in the format
Expand Down