From 5f829c0dd32f4c6edb18dbdaa40c9fadaac1e5c1 Mon Sep 17 00:00:00 2001 From: stack72 Date: Tue, 20 Nov 2018 17:47:02 +0200 Subject: [PATCH] docs: Adding the documentation for metrics.circonus.submissionurl --- docs/content/ref/metrics.circonus.apikey.md | 3 ++- .../ref/metrics.circonus.submissionurl.md | 17 +++++++++++++++++ fabio.properties | 17 ++++++++++++++++- 3 files changed, 35 insertions(+), 2 deletions(-) create mode 100644 docs/content/ref/metrics.circonus.submissionurl.md diff --git a/docs/content/ref/metrics.circonus.apikey.md b/docs/content/ref/metrics.circonus.apikey.md index 41efd3033..45c219254 100644 --- a/docs/content/ref/metrics.circonus.apikey.md +++ b/docs/content/ref/metrics.circonus.apikey.md @@ -4,7 +4,8 @@ title: "metrics.circonus.apikey" `metrics.circonus.apikey` configures the API token key to use when submitting metrics to Circonus. See: https://login.circonus.com/user/tokens -This is required when [metrics.target](/ref/metrics.target/) is set to `circonus`. +This is optional when [metrics.target](/ref/metrics.target/) is set to `circonus` +but [metrics.circonus.submissionurl](/ref/metrics.circonus.submissionurl/) is specified} The default is diff --git a/docs/content/ref/metrics.circonus.submissionurl.md b/docs/content/ref/metrics.circonus.submissionurl.md new file mode 100644 index 000000000..33370d121 --- /dev/null +++ b/docs/content/ref/metrics.circonus.submissionurl.md @@ -0,0 +1,17 @@ +--- +title: "metrics.circonus.submissionurl" +--- + +`metrics.circonus.submissionurl` configures a specific check submission url +for a Check API object of a previously created HTTPTRAP check. + +This is optional when [metrics.target](/ref/metrics.target/) is set to `circonus` +but [metrics.circonus.apikey](/ref/metrics.circonus.apikey/) is specified}. + +#### Example + +`http://127.0.0.1:2609/write/fabio` + +The default is + + metrics.circonus.submissionurl = diff --git a/fabio.properties b/fabio.properties index c86c14c47..339ef700e 100644 --- a/fabio.properties +++ b/fabio.properties @@ -1,4 +1,5 @@ # proxy.cs configures one or more certificate sources. +# proxy.cs configures one or more certificate sources. # # Each certificate source is configured with a list of # key/value options. Each source must have a unique @@ -900,13 +901,27 @@ # metrics.circonus.apikey configures the API token key to use when # submitting metrics to Circonus. See: https://login.circonus.com/user/tokens -# This is required when ${metrics.target} is set to "circonus". +# This is optional when ${metrics.target} is set to "circonus" but +# ${metrics.circonus.submissionurl is specified}. # # The default is # # metrics.circonus.apikey = +# metrics.circonus.submissionurl configures a specific check submission url +# for a Check API object of a previously created HTTPTRAP check +# This is optional when ${metrics.target} is set to "circonus" but +# ${metrics.circonus.apikey is specified}. +# #### Example +# +# `http://127.0.0.1:2609/write/fabio` +# +# The default is +# +# metrics.circonus.submissionurl = + + # metrics.circonus.apiapp configures the API token app to use when # submitting metrics to Circonus. See: https://login.circonus.com/user/tokens # This is optional when ${metrics.target} is set to "circonus".