-
Notifications
You must be signed in to change notification settings - Fork 168
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Add data generation script and jaeger-query output Signed-off-by: lucperkins <[email protected]> * Add jaeger-collector data Signed-off-by: lucperkins <[email protected]> * Add initial CLI-related shortcodes Signed-off-by: lucperkins <[email protected]> * Re-work generation script to include version Signed-off-by: lucperkins <[email protected]> * Finish initial version Signed-off-by: lucperkins <[email protected]> * Re-generate version 1.13 docs and add README instructions Signed-off-by: lucperkins <[email protected]> * Refactor CLI scripts and templates Signed-off-by: Yuri Shkuro <[email protected]> * Add some comments at the top of the page. - Prefix all flags with `--`, to reflect how they are actually used. Signed-off-by: Yuri Shkuro <[email protected]> * Clarify CLI flags docs generation process Signed-off-by: Yuri Shkuro <[email protected]> * Remove right sidebar and add in-page sub-section navigation Signed-off-by: Yuri Shkuro <[email protected]>
- Loading branch information
1 parent
2e9adf4
commit 1f02d8d
Showing
29 changed files
with
4,165 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| --- | ||
| title: CLI flags | ||
| widescreen: true | ||
| --- | ||
|
|
||
| This is auto-generated documentation for CLI flags supported by Jaeger binaries. | ||
|
|
||
| * CLI flags for some binaries change depending on the `SPAN_STORAGE_TYPE` environment variable. Relevant variations are included below. | ||
| * Some binaries support _commands_ (mostly informational), such as `env`, `docs`, and `version`. These commands are not included here. | ||
| * All parameters can be also provided via environment variables, by changing all letters to upper-case and replacing all punctuation characters with underscore `_`. For example, the value for the flag `--cassandra.connections-per-host` can be provided via `CASSANDRA_CONNECTIONS_PER_HOST` environment variable. | ||
|
|
||
| {{< cli/tools-list >}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| { | ||
| "tools": [ | ||
| "jaeger-all-in-one", | ||
| "jaeger-agent", | ||
| "jaeger-collector", | ||
| "jaeger-ingester", | ||
| "jaeger-query" | ||
| ], | ||
| "jaeger-all-in-one": { | ||
| "storage": [ | ||
| "cassandra", | ||
| "elasticsearch", | ||
| "memory", | ||
| "badger", | ||
| "grpc-plugin" | ||
| ] | ||
| }, | ||
| "jaeger-collector": { | ||
| "storage": [ | ||
| "cassandra", | ||
| "elasticsearch", | ||
| "kafka", | ||
| "grpc-plugin" | ||
| ] | ||
| }, | ||
| "jaeger-ingester": { | ||
| "storage": [ | ||
| "cassandra", | ||
| "elasticsearch", | ||
| "grpc-plugin" | ||
| ] | ||
| }, | ||
| "jaeger-query": { | ||
| "storage": [ | ||
| "cassandra", | ||
| "elasticsearch", | ||
| "grpc-plugin" | ||
| ] | ||
| }, | ||
| "jaeger-agent": { | ||
| "storage": [] | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| name: jaeger-agent | ||
| synopsis: | | ||
| Jaeger agent is a local daemon program which collects tracing data. | ||
| description: | | ||
| Jaeger agent is a daemon program that runs on every host and receives tracing data submitted by Jaeger client libraries. | ||
| options: | ||
| - name: admin-http-port | ||
| default_value: "14271" | ||
| usage: | | ||
| The http port for the admin server, including health check, /metrics, etc. | ||
| - name: collector.host-port | ||
| usage: (deprecated) see --reporter.tchannel.host-port | ||
| - name: config-file | ||
| usage: | | ||
| Configuration file in JSON, TOML, YAML, HCL, or Java properties formats (default none). See spf13/viper for precedence. | ||
| - name: discovery.conn-check-timeout | ||
| default_value: 250ms | ||
| usage: | | ||
| (deprecated) see --reporter.tchannel.discovery.conn-check-timeout | ||
| - name: discovery.min-peers | ||
| default_value: "3" | ||
| usage: (deprecated) see --reporter.tchannel.discovery.min-peers | ||
| - name: health-check-http-port | ||
| default_value: "0" | ||
| usage: (deprecated) see --admin-http-port | ||
| - name: help | ||
| shorthand: h | ||
| default_value: "false" | ||
| usage: help for jaeger-agent | ||
| - name: http-server.host-port | ||
| default_value: :5778 | ||
| usage: | | ||
| host:port of the http server (e.g. for /sampling point and /baggageRestrictions endpoint) | ||
| - name: jaeger.tags | ||
| usage: | | ||
| One or more tags to be added to the Process tags of all spans passing through this agent. Ex: key1=value1,key2=${envVar:defaultValue} | ||
| - name: log-level | ||
| default_value: info | ||
| usage: | | ||
| Minimal allowed log Level. For more levels see https://github.com/uber-go/zap | ||
| - name: metrics-backend | ||
| default_value: prometheus | ||
| usage: | | ||
| Defines which metrics backend to use for metrics reporting: expvar, prometheus, none | ||
| - name: metrics-http-route | ||
| default_value: /metrics | ||
| usage: | | ||
| Defines the route of HTTP endpoint for metrics backends that support scraping | ||
| - name: processor.jaeger-binary.server-host-port | ||
| default_value: :6832 | ||
| usage: host:port for the UDP server | ||
| - name: processor.jaeger-binary.server-max-packet-size | ||
| default_value: "65000" | ||
| usage: max packet size for the UDP server | ||
| - name: processor.jaeger-binary.server-queue-size | ||
| default_value: "1000" | ||
| usage: length of the queue for the UDP server | ||
| - name: processor.jaeger-binary.workers | ||
| default_value: "10" | ||
| usage: how many workers the processor should run | ||
| - name: processor.jaeger-compact.server-host-port | ||
| default_value: :6831 | ||
| usage: host:port for the UDP server | ||
| - name: processor.jaeger-compact.server-max-packet-size | ||
| default_value: "65000" | ||
| usage: max packet size for the UDP server | ||
| - name: processor.jaeger-compact.server-queue-size | ||
| default_value: "1000" | ||
| usage: length of the queue for the UDP server | ||
| - name: processor.jaeger-compact.workers | ||
| default_value: "10" | ||
| usage: how many workers the processor should run | ||
| - name: processor.zipkin-compact.server-host-port | ||
| default_value: :5775 | ||
| usage: host:port for the UDP server | ||
| - name: processor.zipkin-compact.server-max-packet-size | ||
| default_value: "65000" | ||
| usage: max packet size for the UDP server | ||
| - name: processor.zipkin-compact.server-queue-size | ||
| default_value: "1000" | ||
| usage: length of the queue for the UDP server | ||
| - name: processor.zipkin-compact.workers | ||
| default_value: "10" | ||
| usage: how many workers the processor should run | ||
| - name: reporter.grpc.discovery.min-peers | ||
| default_value: "3" | ||
| usage: | | ||
| Max number of collectors to which the agent will try to connect at any given time | ||
| - name: reporter.grpc.host-port | ||
| usage: | | ||
| Comma-separated string representing host:port of a static list of collectors to connect to directly. | ||
| - name: reporter.grpc.retry.max | ||
| default_value: "3" | ||
| usage: Sets the maximum number of retries for a call. | ||
| - name: reporter.grpc.tls | ||
| default_value: "false" | ||
| usage: Enable TLS. | ||
| - name: reporter.grpc.tls.ca | ||
| usage: Path to a TLS CA file. (default use the systems truststore) | ||
| - name: reporter.grpc.tls.server-name | ||
| usage: Override the TLS server name. | ||
| - name: reporter.tchannel.discovery.conn-check-timeout | ||
| default_value: 250ms | ||
| usage: sets the timeout used when establishing new connections | ||
| - name: reporter.tchannel.discovery.min-peers | ||
| default_value: "3" | ||
| usage: | | ||
| if using service discovery, the min number of connections to maintain to the backend | ||
| - name: reporter.tchannel.host-port | ||
| usage: | | ||
| comma-separated string representing host:ports of a static list of collectors to connect to directly (e.g. when not using service discovery) | ||
| - name: reporter.tchannel.report-timeout | ||
| default_value: 1s | ||
| usage: sets the timeout used when reporting spans | ||
| - name: reporter.type | ||
| default_value: grpc | ||
| usage: Reporter type to use e.g. grpc, tchannel | ||
| see_also: | ||
| - docs - Generates documentation | ||
| - version - Print the version. |
Oops, something went wrong.