From 882de4857355c92a27e62711373f34786fdfa804 Mon Sep 17 00:00:00 2001 From: Martin Chodur Date: Sat, 8 Jun 2019 22:16:07 +0200 Subject: [PATCH] fix docs: update check cmd flags docs --- CHANGELOG.md | 2 +- docs/components/check.md | 28 ++++++++++++---------------- 2 files changed, 13 insertions(+), 17 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 76134fdbf7e..83890a11ffe 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,7 +12,7 @@ We use *breaking* word for marking changes that are not backward compatible (rel ## Unreleased. ### Added - + - [#1097](https://github.com/improbable-eng/thanos/pull/1097) Added `thanos check rules` linter for Thanos rule rules files. ## [v0.5.0](https://github.com/improbable-eng/thanos/releases/tag/v0.5.0) - 2019.06.05 diff --git a/docs/components/check.md b/docs/components/check.md index 58cbfb9f3d7..323f343df39 100644 --- a/docs/components/check.md +++ b/docs/components/check.md @@ -23,14 +23,12 @@ Flags: --version Show application version. --log.level=info Log filtering level. --log.format=logfmt Log format to use. - --gcloudtrace.project=GCLOUDTRACE.PROJECT - GCP project to send Google Cloud Trace tracings to. - If empty, tracing will be disabled. - --gcloudtrace.sample-factor=1 - How often we send traces (1/). If 0 no - trace will be sent periodically, unless forced by - baggage item. See `pkg/tracing/tracing.go` for - details. + --tracing.config-file= + Path to YAML file that contains tracing + configuration. + --tracing.config= + Alternative to 'tracing.config-file' flag. Tracing + configuration in YAML. Subcommands: check rules ... @@ -67,14 +65,12 @@ Flags: --version Show application version. --log.level=info Log filtering level. --log.format=logfmt Log format to use. - --gcloudtrace.project=GCLOUDTRACE.PROJECT - GCP project to send Google Cloud Trace tracings to. - If empty, tracing will be disabled. - --gcloudtrace.sample-factor=1 - How often we send traces (1/). If 0 no - trace will be sent periodically, unless forced by - baggage item. See `pkg/tracing/tracing.go` for - details. + --tracing.config-file= + Path to YAML file that contains tracing + configuration. + --tracing.config= + Alternative to 'tracing.config-file' flag. Tracing + configuration in YAML. Args: The rule files to check.