From e3251e5d39e4f6d313c5709dadf1f080b08b33fd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juraci=20Paix=C3=A3o=20Kr=C3=B6hling?= Date: Thu, 21 Oct 2021 11:39:27 +0200 Subject: [PATCH] Remove $ from console examples MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Juraci Paixão Kröhling --- monitoring/jaeger-mixin/README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/monitoring/jaeger-mixin/README.md b/monitoring/jaeger-mixin/README.md index 575ca15b0a5..b26206c3972 100644 --- a/monitoring/jaeger-mixin/README.md +++ b/monitoring/jaeger-mixin/README.md @@ -3,16 +3,16 @@ The Prometheus monitoring mixin for Jaeger provides a starting point for people wanting to monitor Jaeger using Prometheus, Alertmanager, and Grafana. To use it, you'll need [`jsonnet`](https://github.com/google/go-jsonnet) and [`jb` (jsonnet-bundler)](https://github.com/jsonnet-bundler/jsonnet-bundler). They can be installed using `go get`, as follows: ```console -$ mkdir -p ~/bin && curl -sL https://github.com/google/go-jsonnet/releases/download/v0.17.0/go-jsonnet_0.17.0_Linux_x86_64.tar.gz | tar -C ~/bin/ -xzf - -$ curl -sLo ~/bin/jb https://github.com/jsonnet-bundler/jsonnet-bundler/releases/download/v0.4.0/jb-linux-amd64 -$ chmod +x ~/bin/jb +mkdir -p ~/bin && curl -sL https://github.com/google/go-jsonnet/releases/download/v0.17.0/go-jsonnet_0.17.0_Linux_x86_64.tar.gz | tar -C ~/bin/ -xzf - +curl -sLo ~/bin/jb https://github.com/jsonnet-bundler/jsonnet-bundler/releases/download/v0.4.0/jb-linux-amd64 +chmod +x ~/bin/jb ``` Your monitoring mixin can then be initialized as follows: ```console -$ jb init -$ jb install \ +jb init +jb install \ github.com/jaegertracing/jaeger/monitoring/jaeger-mixin@master \ github.com/grafana/jsonnet-libs/grafana-builder@master \ github.com/coreos/kube-prometheus/jsonnet/kube-prometheus@main @@ -28,7 +28,7 @@ local jaegerDashboard = (import 'jaeger-mixin/mixin.libsonnet').grafanaDashboard The manifest files can be generated via the `jsonnet` command below. Once the command finishes, the file `manifests/dashboards-jaeger.json` should be available and can be loaded directly into Grafana. ```console -$ jsonnet -J vendor -cm manifests/ monitoring-setup.jsonnet +jsonnet -J vendor -cm manifests/ monitoring-setup.jsonnet ``` An example producing the manifests for a complete monitoring stack is located in this directory, as `monitoring-setup.example.jsonnet`. The manifests include Prometheus, Grafana, and Alertmanager managed via the Prometheus Operator for Kubernetes. @@ -76,8 +76,8 @@ local kp = The manifest files can be generated via `jsonnet` and passed directly to `kubectl`: ```console -$ jsonnet -J vendor -cm manifests/ monitoring-setup.jsonnet -$ kubectl apply -f manifests/ +jsonnet -J vendor -cm manifests/ monitoring-setup.jsonnet +kubectl apply -f manifests/ ``` The resulting manifests will include everything that is needed to have a Prometheus, Alertmanager, and Grafana instances. Whenever a new alert rule is needed, or a new dashboard has to be defined, change your `monitoring-setup.jsonnet`, re-generate and re-apply the manifests. @@ -85,7 +85,7 @@ The resulting manifests will include everything that is needed to have a Prometh Make sure your Prometheus setup is properly scraping the Jaeger components, either by creating a `ServiceMonitor` (and the backing `Service` objects), or via `PodMonitor` resources, like: ```console -$ kubectl apply -f - <