From 73d702c05201c44b6c8a9367efd1c12caa896bcf Mon Sep 17 00:00:00 2001 From: Miek Gieben Date: Wed, 18 Oct 2017 17:20:27 +0100 Subject: [PATCH] plugin/metrcs: add env variable example (#1151) We support ENV variables in config files, add an example in the one for metric, note that `localhost:` is a valid host (in Go), so the TestReadme will parse this correctly. Fixes #1150 --- plugin/metrics/README.md | 9 +++++++++ test/readme_test.go | 5 ++--- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/plugin/metrics/README.md b/plugin/metrics/README.md index 714b17bd2..1abb5b40c 100644 --- a/plugin/metrics/README.md +++ b/plugin/metrics/README.md @@ -48,6 +48,15 @@ Use an alternative address: } ~~~ +Or via an enviroment variable (this is supported throughout the Corefile): `export PORT=9253`, and +then: + +~~~ corefile +. { + prometheus localhost:{$PORT} +} +~~~ + # Bugs When reloading, we keep the handler running, meaning that any changes to the handler's address diff --git a/test/readme_test.go b/test/readme_test.go index 80b6feeb7..dcbb56619 100644 --- a/test/readme_test.go +++ b/test/readme_test.go @@ -14,15 +14,14 @@ import ( "github.com/mholt/caddy" ) -// Pasrse all README.md's of the plugin and check if every example Corefile -// actually works. Each corefile is only used if the language is set to 'corefile': +// TestReadme parses all README.md's of the plugins and checks if every example Corefile +// actually works. Each corefile snippet is only used if the language is set to 'corefile': // // ~~~ corefile // . { // # check-this-please // } // ~~~ - func TestReadme(t *testing.T) { port := 30053 caddy.Quiet = true