make gen

coder · johnstcn · May 5, 2023 · Apr 18, 2023 · Apr 27, 2023 · Apr 27, 2023
commit b9c845f2f0957386a21358b47a259b8851c7af2f
diff --git a/cli/testdata/coder_scaletest_--help.golden b/cli/testdata/coder_scaletest_--help.golden
@@ -10,6 +10,7 @@ Run a scale test against the Coder API
                          online. Optionally runs a command inside each
                          workspace, and connects to the workspace over
                          WireGuard.
+    workspace-traffic    Generate traffic to scaletest workspaces through coderd
 
 ---
 Run `coder --help` for a list of global options.
diff --git a/cli/testdata/coder_scaletest_workspace-traffic_--help.golden b/cli/testdata/coder_scaletest_workspace-traffic_--help.golden
@@ -0,0 +1,58 @@
+Usage: coder scaletest workspace-traffic [flags]
+
+Generate traffic to scaletest workspaces through coderd
+
+[1mOptions[0m
+      --bytes-per-tick int, $CODER_SCALETEST_WORKSPACE_TRAFFIC_BYTES_PER_TICK (default: 1024)
+          How much traffic to generate per tick.
+
+      --cleanup-concurrency int, $CODER_SCALETEST_CLEANUP_CONCURRENCY (default: 1)
+          Number of concurrent cleanup jobs to run. 0 means unlimited.
+
+      --cleanup-job-timeout duration, $CODER_SCALETEST_CLEANUP_JOB_TIMEOUT (default: 5m)
+          Timeout per job. Jobs may take longer to complete under higher
+          concurrency limits.
+
+      --cleanup-timeout duration, $CODER_SCALETEST_CLEANUP_TIMEOUT (default: 30m)
+          Timeout for the entire cleanup run. 0 means unlimited.
+
+      --concurrency int, $CODER_SCALETEST_CONCURRENCY (default: 1)
+          Number of concurrent jobs to run. 0 means unlimited.
+
+      --duration duration, $CODER_SCALETEST_WORKSPACE_TRAFFIC_DURATION (default: 10s)
+          How long to generate traffic for.
+
+      --job-timeout duration, $CODER_SCALETEST_JOB_TIMEOUT (default: 5m)
+          Timeout per job. Jobs may take longer to complete under higher
+          concurrency limits.
+
+      --output string-array, $CODER_SCALETEST_OUTPUTS (default: text)
+          Output format specs in the format "<format>[:<path>]". Not specifying
+          a path will default to stdout. Available formats: text, json.
+
+      --tick-interval duration, $CODER_SCALETEST_WORKSPACE_TRAFFIC_TICK_INTERVAL (default: 100ms)
+          How often to send traffic.
+
+      --timeout duration, $CODER_SCALETEST_TIMEOUT (default: 30m)
+          Timeout for the entire test run. 0 means unlimited.
+
+      --trace bool, $CODER_SCALETEST_TRACE
+          Whether application tracing data is collected. It exports to a backend
+          configured by environment variables. See:
+          https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md.
+
+      --trace-coder bool, $CODER_SCALETEST_TRACE_CODER
+          Whether opentelemetry traces are sent to Coder. We recommend keeping
+          this disabled unless we advise you to enable it.
+
+      --trace-honeycomb-api-key string, $CODER_SCALETEST_TRACE_HONEYCOMB_API_KEY
+          Enables trace exporting to Honeycomb.io using the provided API key.
+
+      --trace-propagate bool, $CODER_SCALETEST_TRACE_PROPAGATE
+          Enables trace propagation to the Coder backend, which will be used to
+          correlate server-side spans with client-side spans. Only enable this
+          if the server is configured with the exact same tracing configuration
+          as the client.
+
+---
+Run `coder --help` for a list of global options.
diff --git a/docs/cli/scaletest.md b/docs/cli/scaletest.md
@@ -16,3 +16,4 @@ coder scaletest
 | ------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | [<code>cleanup</code>](./scaletest_cleanup.md)                     | Cleanup scaletest workspaces, then cleanup scaletest users.                                                                                                                                                         |
 | [<code>create-workspaces</code>](./scaletest_create-workspaces.md) | Creates many users, then creates a workspace for each user and waits for them finish building and fully come online. Optionally runs a command inside each workspace, and connects to the workspace over WireGuard. |
+| [<code>workspace-traffic</code>](./scaletest_workspace-traffic.md) | Generate traffic to scaletest workspaces through coderd                                                                                                                                                             |
diff --git a/docs/cli/scaletest_workspace-traffic.md b/docs/cli/scaletest_workspace-traffic.md
@@ -0,0 +1,149 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
+
+# scaletest workspace-traffic
+
+Generate traffic to scaletest workspaces through coderd
+
+## Usage
+
+```console
+coder scaletest workspace-traffic [flags]
+```
+
+## Options
+
+### --bytes-per-tick
+
+|             |                                                                |
+| ----------- | -------------------------------------------------------------- |
+| Type        | <code>int</code>                                               |
+| Environment | <code>$CODER_SCALETEST_WORKSPACE_TRAFFIC_BYTES_PER_TICK</code> |
+| Default     | <code>1024</code>                                              |
+
+How much traffic to generate per tick.
+
+### --cleanup-concurrency
+
+|             |                                                   |
+| ----------- | ------------------------------------------------- |
+| Type        | <code>int</code>                                  |
+| Environment | <code>$CODER_SCALETEST_CLEANUP_CONCURRENCY</code> |
+| Default     | <code>1</code>                                    |
+
+Number of concurrent cleanup jobs to run. 0 means unlimited.
+
+### --cleanup-job-timeout
+
+|             |                                                   |
+| ----------- | ------------------------------------------------- |
+| Type        | <code>duration</code>                             |
+| Environment | <code>$CODER_SCALETEST_CLEANUP_JOB_TIMEOUT</code> |
+| Default     | <code>5m</code>                                   |
+
+Timeout per job. Jobs may take longer to complete under higher concurrency limits.
+
+### --cleanup-timeout
+
+|             |                                               |
+| ----------- | --------------------------------------------- |
+| Type        | <code>duration</code>                         |
+| Environment | <code>$CODER_SCALETEST_CLEANUP_TIMEOUT</code> |
+| Default     | <code>30m</code>                              |
+
+Timeout for the entire cleanup run. 0 means unlimited.
+
+### --concurrency
+
+|             |                                           |
+| ----------- | ----------------------------------------- |
+| Type        | <code>int</code>                          |
+| Environment | <code>$CODER_SCALETEST_CONCURRENCY</code> |
+| Default     | <code>1</code>                            |
+
+Number of concurrent jobs to run. 0 means unlimited.
+
+### --duration
+
+|             |                                                          |
+| ----------- | -------------------------------------------------------- |
+| Type        | <code>duration</code>                                    |
+| Environment | <code>$CODER_SCALETEST_WORKSPACE_TRAFFIC_DURATION</code> |
+| Default     | <code>10s</code>                                         |
+
+How long to generate traffic for.
+
+### --job-timeout
+
+|             |                                           |
+| ----------- | ----------------------------------------- |
+| Type        | <code>duration</code>                     |
+| Environment | <code>$CODER_SCALETEST_JOB_TIMEOUT</code> |
+| Default     | <code>5m</code>                           |
+
+Timeout per job. Jobs may take longer to complete under higher concurrency limits.
+
+### --output
+
+|             |                                       |
+| ----------- | ------------------------------------- |
+| Type        | <code>string-array</code>             |
+| Environment | <code>$CODER_SCALETEST_OUTPUTS</code> |
+| Default     | <code>text</code>                     |
+
+Output format specs in the format "<format>[:<path>]". Not specifying a path will default to stdout. Available formats: text, json.
+
+### --tick-interval
+
+|             |                                                               |
+| ----------- | ------------------------------------------------------------- |
+| Type        | <code>duration</code>                                         |
+| Environment | <code>$CODER_SCALETEST_WORKSPACE_TRAFFIC_TICK_INTERVAL</code> |
+| Default     | <code>100ms</code>                                            |
+
+How often to send traffic.
+
+### --timeout
+
+|             |                                       |
+| ----------- | ------------------------------------- |
+| Type        | <code>duration</code>                 |
+| Environment | <code>$CODER_SCALETEST_TIMEOUT</code> |
+| Default     | <code>30m</code>                      |
+
+Timeout for the entire test run. 0 means unlimited.
+
+### --trace
+
+|             |                                     |
+| ----------- | ----------------------------------- |
+| Type        | <code>bool</code>                   |
+| Environment | <code>$CODER_SCALETEST_TRACE</code> |
+
+Whether application tracing data is collected. It exports to a backend configured by environment variables. See: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md.
+
+### --trace-coder
+
+|             |                                           |
+| ----------- | ----------------------------------------- |
+| Type        | <code>bool</code>                         |
+| Environment | <code>$CODER_SCALETEST_TRACE_CODER</code> |
+
+Whether opentelemetry traces are sent to Coder. We recommend keeping this disabled unless we advise you to enable it.
+
+### --trace-honeycomb-api-key
+
+|             |                                                       |
+| ----------- | ----------------------------------------------------- |
+| Type        | <code>string</code>                                   |
+| Environment | <code>$CODER_SCALETEST_TRACE_HONEYCOMB_API_KEY</code> |
+
+Enables trace exporting to Honeycomb.io using the provided API key.
+
+### --trace-propagate
+
+|             |                                               |
+| ----------- | --------------------------------------------- |
+| Type        | <code>bool</code>                             |
+| Environment | <code>$CODER_SCALETEST_TRACE_PROPAGATE</code> |
+
+Enables trace propagation to the Coder backend, which will be used to correlate server-side spans with client-side spans. Only enable this if the server is configured with the exact same tracing configuration as the client.
diff --git a/docs/manifest.json b/docs/manifest.json
@@ -630,6 +630,11 @@
           "description": "Creates many users, then creates a workspace for each user and waits for them finish building and fully come online. Optionally runs a command inside each workspace, and connects to the workspace over WireGuard.",
           "path": "cli/scaletest_create-workspaces.md"
         },
+        {
+          "title": "scaletest workspace-traffic",
+          "description": "Generate traffic to scaletest workspaces through coderd",
+          "path": "cli/scaletest_workspace-traffic.md"
+        },
         {
           "title": "schedule",
           "description": "Schedule automated start and stop times for workspaces",