WIP: Add flags

Makefile

@@ -1,6 +1,8 @@
 HTMLPROOFER  = bundle exec htmlproofer
 HUGO_THEME   = jaeger-docs
 THEME_DIR    := themes/$(HUGO_THEME)
+JAEGER_VERSION?=latest
+
 
 develop:
 	HUGO_PREVIEW=true \
@@ -29,3 +31,17 @@ htmlproofer:
 	$(HTMLPROOFER) \
         --empty-alt-ignore \
         public
+
+# TODO add ingester, collector
+.PHONY:gen-commands
+gen-commands:
+	rm ./content/docs/next-release/jaeger-*
+	docker run --rm -it -e SPAN_STORAGE_TYPE=elasticsearch -v "${PWD}/content/docs/next-release:/data" jaegertracing/jaeger-query:${JAEGER_VERSION} docs --format=md --dir=/data
+#	add _elasticsaerch suffix to files
+	rename '.md' '_elasticsearch.md' ./content/docs/next-release/jaeger-query*
+#	change links in files to reflect rename to _elasticsearch
+	sed -i -e "s/\.md/_elasticsearch/g" ./content/docs/next-release/jaeger-*.md
+	docker run --rm -it -v "${PWD}/content/docs/next-release:/data" jaegertracing/jaeger-query:${JAEGER_VERSION} docs --format=md --dir=/data
+	sed -i -e "s/\.md//g" ./content/docs/next-release/jaeger-*.md
+#	hugo links have to start with ../
+	sed -i -e "s/](/](..\//g" ./content/docs/next-release/jaeger-*.md

content/docs/next-release/commands.md

@@ -0,0 +1,15 @@
+---
+title: Commands
+weight: 5
+description: Jaeger commands documentation
+---
+
+This page contains commands and flags documentation for Jaeger components.
+The same output can be generated locally by running `help` commands.
+
+* Query 
+  - [Cassandra storage](../jaeger-query)
+  - [Elasticsearch storage](../jaeger-query_elasticsearch)
+* Collector
+* Ingester
+* all-in-one

content/docs/next-release/jaeger-query.md

@@ -0,0 +1,80 @@
+## jaeger-query
+
+Jaeger query service provides a Web UI and an API for accessing trace data.
+
+### Synopsis
+
+Jaeger query service provides a Web UI and an API for accessing trace data.
+
+```
+jaeger-query [flags]
+```
+
+### Options
+
+```
+      --admin-http-port int                             The http port for the admin server, including health check, /metrics, etc. (default 16687)
+      --cassandra-archive.connections-per-host int      The number of Cassandra connections from a single backend instance
+      --cassandra-archive.consistency string            The Cassandra consistency level, e.g. ANY, ONE, TWO, THREE, QUORUM, ALL, LOCAL_QUORUM, EACH_QUORUM, LOCAL_ONE (default LOCAL_ONE)
+      --cassandra-archive.enable-dependencies-v2        (deprecated) Jaeger will automatically detect the version of the dependencies table
+      --cassandra-archive.enabled                       Enable extra storage
+      --cassandra-archive.keyspace string               The Cassandra keyspace for Jaeger data
+      --cassandra-archive.local-dc string               The name of the Cassandra local data center for DC Aware host selection
+      --cassandra-archive.max-retry-attempts int        The number of attempts when reading from Cassandra
+      --cassandra-archive.password string               Password for password authentication for Cassandra
+      --cassandra-archive.port int                      The port for cassandra
+      --cassandra-archive.proto-version int             The Cassandra protocol version
+      --cassandra-archive.reconnect-interval duration   Reconnect interval to retry connecting to downed hosts (default 0s)
+      --cassandra-archive.servers string                The comma-separated list of Cassandra servers
+      --cassandra-archive.socket-keep-alive duration    Cassandra's keepalive period to use, enabled if > 0 (default 0s)
+      --cassandra-archive.timeout duration              Timeout used for queries. A Timeout of zero means no timeout (default 0s)
+      --cassandra-archive.tls                           Enable TLS
+      --cassandra-archive.tls.ca string                 Path to TLS CA file
+      --cassandra-archive.tls.cert string               Path to TLS certificate file
+      --cassandra-archive.tls.key string                Path to TLS key file
+      --cassandra-archive.tls.server-name string        Override the TLS server name
+      --cassandra-archive.tls.verify-host               Enable (or disable) host key verification
+      --cassandra-archive.username string               Username for password authentication for Cassandra
+      --cassandra.connections-per-host int              The number of Cassandra connections from a single backend instance (default 2)
+      --cassandra.consistency string                    The Cassandra consistency level, e.g. ANY, ONE, TWO, THREE, QUORUM, ALL, LOCAL_QUORUM, EACH_QUORUM, LOCAL_ONE (default LOCAL_ONE)
+      --cassandra.enable-dependencies-v2                (deprecated) Jaeger will automatically detect the version of the dependencies table
+      --cassandra.keyspace string                       The Cassandra keyspace for Jaeger data (default "jaeger_v1_test")
+      --cassandra.local-dc string                       The name of the Cassandra local data center for DC Aware host selection
+      --cassandra.max-retry-attempts int                The number of attempts when reading from Cassandra (default 3)
+      --cassandra.password string                       Password for password authentication for Cassandra
+      --cassandra.port int                              The port for cassandra
+      --cassandra.proto-version int                     The Cassandra protocol version (default 4)
+      --cassandra.reconnect-interval duration           Reconnect interval to retry connecting to downed hosts (default 1m0s)
+      --cassandra.servers string                        The comma-separated list of Cassandra servers (default "127.0.0.1")
+      --cassandra.socket-keep-alive duration            Cassandra's keepalive period to use, enabled if > 0 (default 0s)
+      --cassandra.span-store-write-cache-ttl duration   The duration to wait before rewriting an existing service or operation name (default 12h0m0s)
+      --cassandra.timeout duration                      Timeout used for queries. A Timeout of zero means no timeout (default 0s)
+      --cassandra.tls                                   Enable TLS
+      --cassandra.tls.ca string                         Path to TLS CA file
+      --cassandra.tls.cert string                       Path to TLS certificate file
+      --cassandra.tls.key string                        Path to TLS key file
+      --cassandra.tls.server-name string                Override the TLS server name
+      --cassandra.tls.verify-host                       Enable (or disable) host key verification (default true)
+      --cassandra.username string                       Username for password authentication for Cassandra
+      --config-file string                              Configuration file in JSON, TOML, YAML, HCL, or Java properties formats (default none). See spf13/viper for precedence.
+      --downsampling.hashsalt string                    Salt used when hashing trace id for downsampling.
+      --downsampling.ratio float                        Ratio of spans passed to storage after downsampling (between 0 and 1), e.g ratio = 0.3 means we are keeping 30% of spans and dropping 70% of spans; ratio = 1.0 disables downsampling. (default 1)
+      --health-check-http-port int                      (deprecated) see --admin-http-port
+  -h, --help                                            help for jaeger-query
+      --log-level string                                Minimal allowed log Level. For more levels see https://github.com/uber-go/zap (default "info")
+      --metrics-backend string                          Defines which metrics backend to use for metrics reporting: expvar, prometheus, none (default "prometheus")
+      --metrics-http-route string                       Defines the route of HTTP endpoint for metrics backends that support scraping (default "/metrics")
+      --query.base-path string                          The base path for all HTTP routes, e.g. /jaeger; useful when running behind a reverse proxy (default "/")
+      --query.port int                                  The port for the query service (default 16686)
+      --query.static-files string                       The directory path override for the static assets for the UI
+      --query.ui-config string                          The path to the UI configuration file in JSON format
+      --span-storage.type string                        (deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with "env" command for help.
+```
+
+### SEE ALSO
+
+* [jaeger-query docs](../jaeger-query_docs)	 - Generates documentation
+* [jaeger-query env](../jaeger-query_env)	 - Help about environment variables
+* [jaeger-query version](../jaeger-query_version)	 - Print the version
+
+###### Auto generated by spf13/cobra on 4-Jun-2019

content/docs/next-release/jaeger-query_docs.md

@@ -0,0 +1,25 @@
+## jaeger-query docs
+
+Generates documentation
+
+### Synopsis
+
+Generates command and flags documentation
+
+```
+jaeger-query docs [flags]
+```
+
+### Options
+
+```
+      --dir string      Directory where generate the documentation. (default "./")
+      --format string   Supported formats: [md man rst yaml]. (default "md")
+  -h, --help            help for docs
+```
+
+### SEE ALSO
+
+* [jaeger-query](../jaeger-query)	 - Jaeger query service provides a Web UI and an API for accessing trace data.
+
+###### Auto generated by spf13/cobra on 4-Jun-2019

content/docs/next-release/jaeger-query_docs_elasticsearch.md

@@ -0,0 +1,25 @@
+## jaeger-query docs
+
+Generates documentation
+
+### Synopsis
+
+Generates command and flags documentation
+
+```
+jaeger-query docs [flags]
+```
+
+### Options
+
+```
+      --dir string      Directory where generate the documentation. (default "./")
+      --format string   Supported formats: [md man rst yaml]. (default "md")
+  -h, --help            help for docs
+```
+
+### SEE ALSO
+
+* [jaeger-query](../jaeger-query_elasticsearch)	 - Jaeger query service provides a Web UI and an API for accessing trace data.
+
+###### Auto generated by spf13/cobra on 4-Jun-2019

content/docs/next-release/jaeger-query_elasticsearch.md

@@ -0,0 +1,87 @@
+## jaeger-query
+
+Jaeger query service provides a Web UI and an API for accessing trace data.
+
+### Synopsis
+
+Jaeger query service provides a Web UI and an API for accessing trace data.
+
+```
+jaeger-query [flags]
+```
+
+### Options
+
+```
+      --admin-http-port int                                The http port for the admin server, including health check, /metrics, etc. (default 16687)
+      --config-file string                                 Configuration file in JSON, TOML, YAML, HCL, or Java properties formats (default none). See spf13/viper for precedence.
+      --downsampling.hashsalt string                       Salt used when hashing trace id for downsampling.
+      --downsampling.ratio float                           Ratio of spans passed to storage after downsampling (between 0 and 1), e.g ratio = 0.3 means we are keeping 30% of spans and dropping 70% of spans; ratio = 1.0 disables downsampling. (default 1)
+      --es-archive.bulk.actions int                        The number of requests that can be enqueued before the bulk processor decides to commit
+      --es-archive.bulk.flush-interval duration            A time.Duration after which bulk requests are committed, regardless of other thresholds. Set to zero to disable. By default, this is disabled. (default 0s)
+      --es-archive.bulk.size int                           The number of bytes that the bulk requests can take up before the bulk processor decides to commit
+      --es-archive.bulk.workers int                        The number of workers that are able to receive bulk requests and eventually commit them to Elasticsearch
+      --es-archive.enabled                                 Enable extra storage
+      --es-archive.index-prefix string                     Optional prefix of Jaeger indices. For example "production" creates "production-jaeger-*".
+      --es-archive.max-num-spans int                       The maximum number of spans to fetch at a time per query in Elasticsearch
+      --es-archive.max-span-age duration                   The maximum lookback for spans in Elasticsearch (default 0s)
+      --es-archive.num-replicas int                        The number of replicas per index in Elasticsearch
+      --es-archive.num-shards int                          The number of shards per index in Elasticsearch
+      --es-archive.password string                         The password required by Elasticsearch
+      --es-archive.server-urls string                      The comma-separated list of Elasticsearch servers, must be full url i.e. http://localhost:9200
+      --es-archive.sniffer                                 The sniffer config for Elasticsearch; client uses sniffing process to find all nodes automatically, disable if not required
+      --es-archive.tags-as-fields.all                      (experimental) Store all span and process tags as object fields. If true .tags-as-fields.config-file is ignored. Binary tags are always stored as nested objects.
+      --es-archive.tags-as-fields.config-file string       (experimental) Optional path to a file containing tag keys which will be stored as object fields. Each key should be on a separate line.
+      --es-archive.tags-as-fields.dot-replacement string   (experimental) The character used to replace dots (".") in tag keys stored as object fields.
+      --es-archive.timeout duration                        Timeout used for queries. A Timeout of zero means no timeout (default 0s)
+      --es-archive.tls                                     Enable TLS with client certificates.
+      --es-archive.tls.ca string                           Path to TLS CA file
+      --es-archive.tls.cert string                         Path to TLS certificate file
+      --es-archive.tls.key string                          Path to TLS key file
+      --es-archive.tls.skip-host-verify                    (insecure) Skip server's certificate chain and host name verification
+      --es-archive.token-file string                       Path to a file containing bearer token. This flag also loads CA if it is specified.
+      --es-archive.use-aliases                             (experimental) Use read and write aliases for indices. Use this option with Elasticsearch rollover API. It requires an external component to create aliases before startup and then performing its management. Note that es-archive.max-span-age is not taken into the account and has to be substituted by external component managing read alias.
+      --es-archive.username string                         The username required by Elasticsearch. The basic authentication also loads CA if it is specified.
+      --es.bulk.actions int                                The number of requests that can be enqueued before the bulk processor decides to commit (default 1000)
+      --es.bulk.flush-interval duration                    A time.Duration after which bulk requests are committed, regardless of other thresholds. Set to zero to disable. By default, this is disabled. (default 200ms)
+      --es.bulk.size int                                   The number of bytes that the bulk requests can take up before the bulk processor decides to commit (default 5000000)
+      --es.bulk.workers int                                The number of workers that are able to receive bulk requests and eventually commit them to Elasticsearch (default 1)
+      --es.index-prefix string                             Optional prefix of Jaeger indices. For example "production" creates "production-jaeger-*".
+      --es.max-num-spans int                               The maximum number of spans to fetch at a time per query in Elasticsearch (default 10000)
+      --es.max-span-age duration                           The maximum lookback for spans in Elasticsearch (default 72h0m0s)
+      --es.num-replicas int                                The number of replicas per index in Elasticsearch (default 1)
+      --es.num-shards int                                  The number of shards per index in Elasticsearch (default 5)
+      --es.password string                                 The password required by Elasticsearch
+      --es.server-urls string                              The comma-separated list of Elasticsearch servers, must be full url i.e. http://localhost:9200 (default "http://127.0.0.1:9200")
+      --es.sniffer                                         The sniffer config for Elasticsearch; client uses sniffing process to find all nodes automatically, disable if not required
+      --es.tags-as-fields.all                              (experimental) Store all span and process tags as object fields. If true .tags-as-fields.config-file is ignored. Binary tags are always stored as nested objects.
+      --es.tags-as-fields.config-file string               (experimental) Optional path to a file containing tag keys which will be stored as object fields. Each key should be on a separate line.
+      --es.tags-as-fields.dot-replacement string           (experimental) The character used to replace dots (".") in tag keys stored as object fields. (default "@")
+      --es.timeout duration                                Timeout used for queries. A Timeout of zero means no timeout (default 0s)
+      --es.tls                                             Enable TLS with client certificates.
+      --es.tls.ca string                                   Path to TLS CA file
+      --es.tls.cert string                                 Path to TLS certificate file
+      --es.tls.key string                                  Path to TLS key file
+      --es.tls.skip-host-verify                            (insecure) Skip server's certificate chain and host name verification
+      --es.token-file string                               Path to a file containing bearer token. This flag also loads CA if it is specified.
+      --es.use-aliases                                     (experimental) Use read and write aliases for indices. Use this option with Elasticsearch rollover API. It requires an external component to create aliases before startup and then performing its management. Note that es.max-span-age is not taken into the account and has to be substituted by external component managing read alias.
+      --es.username string                                 The username required by Elasticsearch. The basic authentication also loads CA if it is specified.
+      --health-check-http-port int                         (deprecated) see --admin-http-port
+  -h, --help                                               help for jaeger-query
+      --log-level string                                   Minimal allowed log Level. For more levels see https://github.com/uber-go/zap (default "info")
+      --metrics-backend string                             Defines which metrics backend to use for metrics reporting: expvar, prometheus, none (default "prometheus")
+      --metrics-http-route string                          Defines the route of HTTP endpoint for metrics backends that support scraping (default "/metrics")
+      --query.base-path string                             The base path for all HTTP routes, e.g. /jaeger; useful when running behind a reverse proxy (default "/")
+      --query.port int                                     The port for the query service (default 16686)
+      --query.static-files string                          The directory path override for the static assets for the UI
+      --query.ui-config string                             The path to the UI configuration file in JSON format
+      --span-storage.type string                           (deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with "env" command for help.
+```
+
+### SEE ALSO
+
+* [jaeger-query docs](../jaeger-query_docs_elasticsearch)	 - Generates documentation
+* [jaeger-query env](../jaeger-query_env_elasticsearch)	 - Help about environment variables
+* [jaeger-query version](../jaeger-query_version_elasticsearch)	 - Print the version
+
+###### Auto generated by spf13/cobra on 4-Jun-2019

content/docs/next-release/jaeger-query_env.md

@@ -0,0 +1,23 @@
+## jaeger-query env
+
+Help about environment variables
+
+### Synopsis
+
+Help about environment variables
+
+```
+jaeger-query env [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for env
+```
+
+### SEE ALSO
+
+* [jaeger-query](../jaeger-query)	 - Jaeger query service provides a Web UI and an API for accessing trace data.
+
+###### Auto generated by spf13/cobra on 4-Jun-2019