From abce6cef465918d4ce0875ba3c6b323a29c8f66a Mon Sep 17 00:00:00 2001 From: Ashmita Bohara Date: Sun, 29 Nov 2020 21:43:06 +0800 Subject: [PATCH] Add tools page with tracegen and anonymizer Signed-off-by: Ashmita Bohara --- content/docs/1.13/operator.md | 2 +- content/docs/1.14/operator.md | 2 +- content/docs/1.15/operator.md | 2 +- content/docs/1.16/operator.md | 2 +- content/docs/1.17/operator.md | 2 +- content/docs/1.18/operator.md | 2 +- content/docs/1.19/operator.md | 2 +- content/docs/1.20/operator.md | 2 +- content/docs/1.21/tools.md | 29 +++++++++++++++++++++++++++ content/docs/next-release/operator.md | 2 +- content/docs/next-release/tools.md | 29 +++++++++++++++++++++++++++ 11 files changed, 67 insertions(+), 9 deletions(-) create mode 100644 content/docs/1.21/tools.md create mode 100644 content/docs/next-release/tools.md diff --git a/content/docs/1.13/operator.md b/content/docs/1.13/operator.md index 8914e4fa..54540ec2 100644 --- a/content/docs/1.13/operator.md +++ b/content/docs/1.13/operator.md @@ -111,7 +111,7 @@ agent-as-daemonset-agent-daemonset 1 1 1 1 # Quick Start - Deploying the AllInOne image -The simplest possible way to create a Jaeger instance is by creating a YAML file like the following example. This will install the default AllInOne strategy, which deploys the "all-in-one" image (agent, collector, query, ingestor, Jaeger UI) in a single pod, using in-memory storage by default. +The simplest possible way to create a Jaeger instance is by creating a YAML file like the following example. This will install the default AllInOne strategy, which deploys the "all-in-one" image (agent, collector, query, ingester, Jaeger UI) in a single pod, using in-memory storage by default. {{< info >}} This default strategy is intended for development, testing, and demo purposes, not for production. diff --git a/content/docs/1.14/operator.md b/content/docs/1.14/operator.md index 386b6e68..810db079 100644 --- a/content/docs/1.14/operator.md +++ b/content/docs/1.14/operator.md @@ -82,7 +82,7 @@ After the role is granted, switch back to a non-privileged user. # Quick Start - Deploying the AllInOne image -The simplest possible way to create a Jaeger instance is by creating a YAML file like the following example. This will install the default AllInOne strategy, which deploys the "all-in-one" image (agent, collector, query, ingestor, Jaeger UI) in a single pod, using in-memory storage by default. +The simplest possible way to create a Jaeger instance is by creating a YAML file like the following example. This will install the default AllInOne strategy, which deploys the "all-in-one" image (agent, collector, query, ingester, Jaeger UI) in a single pod, using in-memory storage by default. {{< info >}} This default strategy is intended for development, testing, and demo purposes, not for production. diff --git a/content/docs/1.15/operator.md b/content/docs/1.15/operator.md index 95216abf..34cb6381 100644 --- a/content/docs/1.15/operator.md +++ b/content/docs/1.15/operator.md @@ -82,7 +82,7 @@ After the role is granted, switch back to a non-privileged user. # Quick Start - Deploying the AllInOne image -The simplest possible way to create a Jaeger instance is by creating a YAML file like the following example. This will install the default AllInOne strategy, which deploys the "all-in-one" image (agent, collector, query, ingestor, Jaeger UI) in a single pod, using in-memory storage by default. +The simplest possible way to create a Jaeger instance is by creating a YAML file like the following example. This will install the default AllInOne strategy, which deploys the "all-in-one" image (agent, collector, query, ingester, Jaeger UI) in a single pod, using in-memory storage by default. {{< info >}} This default strategy is intended for development, testing, and demo purposes, not for production. diff --git a/content/docs/1.16/operator.md b/content/docs/1.16/operator.md index 145587d2..84a30e96 100644 --- a/content/docs/1.16/operator.md +++ b/content/docs/1.16/operator.md @@ -82,7 +82,7 @@ After the role is granted, switch back to a non-privileged user. # Quick Start - Deploying the AllInOne image -The simplest possible way to create a Jaeger instance is by creating a YAML file like the following example. This will install the default AllInOne strategy, which deploys the "all-in-one" image (agent, collector, query, ingestor, Jaeger UI) in a single pod, using in-memory storage by default. +The simplest possible way to create a Jaeger instance is by creating a YAML file like the following example. This will install the default AllInOne strategy, which deploys the "all-in-one" image (agent, collector, query, ingester, Jaeger UI) in a single pod, using in-memory storage by default. {{< info >}} This default strategy is intended for development, testing, and demo purposes, not for production. diff --git a/content/docs/1.17/operator.md b/content/docs/1.17/operator.md index dc155a89..ba1a553f 100644 --- a/content/docs/1.17/operator.md +++ b/content/docs/1.17/operator.md @@ -127,7 +127,7 @@ After the role is granted, switch back to a non-privileged user. # Quick Start - Deploying the AllInOne image -The simplest possible way to create a Jaeger instance is by creating a YAML file like the following example. This will install the default AllInOne strategy, which deploys the "all-in-one" image (agent, collector, query, ingestor, Jaeger UI) in a single pod, using in-memory storage by default. +The simplest possible way to create a Jaeger instance is by creating a YAML file like the following example. This will install the default AllInOne strategy, which deploys the "all-in-one" image (agent, collector, query, ingester, Jaeger UI) in a single pod, using in-memory storage by default. {{< info >}} This default strategy is intended for development, testing, and demo purposes, not for production. diff --git a/content/docs/1.18/operator.md b/content/docs/1.18/operator.md index 19d7502c..a58c4769 100644 --- a/content/docs/1.18/operator.md +++ b/content/docs/1.18/operator.md @@ -127,7 +127,7 @@ After the role is granted, switch back to a non-privileged user. # Quick Start - Deploying the AllInOne image -The simplest possible way to create a Jaeger instance is by creating a YAML file like the following example. This will install the default AllInOne strategy, which deploys the "all-in-one" image (agent, collector, query, ingestor, Jaeger UI) in a single pod, using in-memory storage by default. +The simplest possible way to create a Jaeger instance is by creating a YAML file like the following example. This will install the default AllInOne strategy, which deploys the "all-in-one" image (agent, collector, query, ingester, Jaeger UI) in a single pod, using in-memory storage by default. {{< info >}} This default strategy is intended for development, testing, and demo purposes, not for production. diff --git a/content/docs/1.19/operator.md b/content/docs/1.19/operator.md index 55a37fe3..6bf08afe 100644 --- a/content/docs/1.19/operator.md +++ b/content/docs/1.19/operator.md @@ -131,7 +131,7 @@ After the role is granted, switch back to a non-privileged user. # Quick Start - Deploying the AllInOne image -The simplest possible way to create a Jaeger instance is by creating a YAML file like the following example. This will install the default AllInOne strategy, which deploys the "all-in-one" image (agent, collector, query, ingestor, Jaeger UI) in a single pod, using in-memory storage by default. +The simplest possible way to create a Jaeger instance is by creating a YAML file like the following example. This will install the default AllInOne strategy, which deploys the "all-in-one" image (agent, collector, query, ingester, Jaeger UI) in a single pod, using in-memory storage by default. {{< info >}} This default strategy is intended for development, testing, and demo purposes, not for production. diff --git a/content/docs/1.20/operator.md b/content/docs/1.20/operator.md index 55a37fe3..6bf08afe 100644 --- a/content/docs/1.20/operator.md +++ b/content/docs/1.20/operator.md @@ -131,7 +131,7 @@ After the role is granted, switch back to a non-privileged user. # Quick Start - Deploying the AllInOne image -The simplest possible way to create a Jaeger instance is by creating a YAML file like the following example. This will install the default AllInOne strategy, which deploys the "all-in-one" image (agent, collector, query, ingestor, Jaeger UI) in a single pod, using in-memory storage by default. +The simplest possible way to create a Jaeger instance is by creating a YAML file like the following example. This will install the default AllInOne strategy, which deploys the "all-in-one" image (agent, collector, query, ingester, Jaeger UI) in a single pod, using in-memory storage by default. {{< info >}} This default strategy is intended for development, testing, and demo purposes, not for production. diff --git a/content/docs/1.21/tools.md b/content/docs/1.21/tools.md new file mode 100644 index 00000000..71ad83a3 --- /dev/null +++ b/content/docs/1.21/tools.md @@ -0,0 +1,29 @@ +--- +title: Tools +navtitle: Tools +description: Extra Jaeger utilities. +weight: 12 +--- + +## Tracegen + +It is a powerful utility that can be used to generate continuous stream of simple spans. This is specially useful for stress testing. It supports flags to control the number of workers and number of traces to generate in each worker. Not only that, it can generate spans in firehose mode (a flag set on spans to skip indexing). + +```sh +docker run \ + --rm \ + jaegertracing/jaeger-tracegen:{{< currentVersion >}} +``` + +## Anonymizer + +It is a small utility that expects a trace-id and outputs an anonymized json version of that trace. This is useful in case you want to share your span with someone for purposes like debugging. By anonymized version, we mean that it removes or hashes details which are particular to your environment and you're not comfortable sharing them. + +```sh +docker run \ + --rm \ + --volume /tmp:/tmp \ + jaegertracing/jaeger-anonymizer:{{< currentVersion >}} \ + --trace-id \ + --query-host-port +``` diff --git a/content/docs/next-release/operator.md b/content/docs/next-release/operator.md index 55a37fe3..6bf08afe 100644 --- a/content/docs/next-release/operator.md +++ b/content/docs/next-release/operator.md @@ -131,7 +131,7 @@ After the role is granted, switch back to a non-privileged user. # Quick Start - Deploying the AllInOne image -The simplest possible way to create a Jaeger instance is by creating a YAML file like the following example. This will install the default AllInOne strategy, which deploys the "all-in-one" image (agent, collector, query, ingestor, Jaeger UI) in a single pod, using in-memory storage by default. +The simplest possible way to create a Jaeger instance is by creating a YAML file like the following example. This will install the default AllInOne strategy, which deploys the "all-in-one" image (agent, collector, query, ingester, Jaeger UI) in a single pod, using in-memory storage by default. {{< info >}} This default strategy is intended for development, testing, and demo purposes, not for production. diff --git a/content/docs/next-release/tools.md b/content/docs/next-release/tools.md new file mode 100644 index 00000000..71ad83a3 --- /dev/null +++ b/content/docs/next-release/tools.md @@ -0,0 +1,29 @@ +--- +title: Tools +navtitle: Tools +description: Extra Jaeger utilities. +weight: 12 +--- + +## Tracegen + +It is a powerful utility that can be used to generate continuous stream of simple spans. This is specially useful for stress testing. It supports flags to control the number of workers and number of traces to generate in each worker. Not only that, it can generate spans in firehose mode (a flag set on spans to skip indexing). + +```sh +docker run \ + --rm \ + jaegertracing/jaeger-tracegen:{{< currentVersion >}} +``` + +## Anonymizer + +It is a small utility that expects a trace-id and outputs an anonymized json version of that trace. This is useful in case you want to share your span with someone for purposes like debugging. By anonymized version, we mean that it removes or hashes details which are particular to your environment and you're not comfortable sharing them. + +```sh +docker run \ + --rm \ + --volume /tmp:/tmp \ + jaegertracing/jaeger-anonymizer:{{< currentVersion >}} \ + --trace-id \ + --query-host-port +```