Skip to content

Commit b9c845f

Browse files
johnstcnjohnstcn
committed
make gen
1 parent 7b98b35 commit b9c845f

File tree

5 files changed

+214
-0
lines changed

5 files changed

+214
-0
lines changed

‎cli/testdata/coder_scaletest_--help.golden

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Run a scale test against the Coder API
1010
online. Optionally runs a command inside each
1111
workspace, and connects to the workspace over
1212
WireGuard.
13+
workspace-traffic Generate traffic to scaletest workspaces through coderd
1314

1415
---
1516
Run `coder --help` for a list of global options.

‎cli/testdata/coder_scaletest_workspace-traffic_--help.golden

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
Usage: coder scaletest workspace-traffic [flags]
2+
3+
Generate traffic to scaletest workspaces through coderd
4+
5+
Options
6+
--bytes-per-tick int, $CODER_SCALETEST_WORKSPACE_TRAFFIC_BYTES_PER_TICK (default: 1024)
7+
How much traffic to generate per tick.
8+
9+
--cleanup-concurrency int, $CODER_SCALETEST_CLEANUP_CONCURRENCY (default: 1)
10+
Number of concurrent cleanup jobs to run. 0 means unlimited.
11+
12+
--cleanup-job-timeout duration, $CODER_SCALETEST_CLEANUP_JOB_TIMEOUT (default: 5m)
13+
Timeout per job. Jobs may take longer to complete under higher
14+
concurrency limits.
15+
16+
--cleanup-timeout duration, $CODER_SCALETEST_CLEANUP_TIMEOUT (default: 30m)
17+
Timeout for the entire cleanup run. 0 means unlimited.
18+
19+
--concurrency int, $CODER_SCALETEST_CONCURRENCY (default: 1)
20+
Number of concurrent jobs to run. 0 means unlimited.
21+
22+
--duration duration, $CODER_SCALETEST_WORKSPACE_TRAFFIC_DURATION (default: 10s)
23+
How long to generate traffic for.
24+
25+
--job-timeout duration, $CODER_SCALETEST_JOB_TIMEOUT (default: 5m)
26+
Timeout per job. Jobs may take longer to complete under higher
27+
concurrency limits.
28+
29+
--output string-array, $CODER_SCALETEST_OUTPUTS (default: text)
30+
Output format specs in the format "<format>[:<path>]". Not specifying
31+
a path will default to stdout. Available formats: text, json.
32+
33+
--tick-interval duration, $CODER_SCALETEST_WORKSPACE_TRAFFIC_TICK_INTERVAL (default: 100ms)
34+
How often to send traffic.
35+
36+
--timeout duration, $CODER_SCALETEST_TIMEOUT (default: 30m)
37+
Timeout for the entire test run. 0 means unlimited.
38+
39+
--trace bool, $CODER_SCALETEST_TRACE
40+
Whether application tracing data is collected. It exports to a backend
41+
configured by environment variables. See:
42+
https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md.
43+
44+
--trace-coder bool, $CODER_SCALETEST_TRACE_CODER
45+
Whether opentelemetry traces are sent to Coder. We recommend keeping
46+
this disabled unless we advise you to enable it.
47+
48+
--trace-honeycomb-api-key string, $CODER_SCALETEST_TRACE_HONEYCOMB_API_KEY
49+
Enables trace exporting to Honeycomb.io using the provided API key.
50+
51+
--trace-propagate bool, $CODER_SCALETEST_TRACE_PROPAGATE
52+
Enables trace propagation to the Coder backend, which will be used to
53+
correlate server-side spans with client-side spans. Only enable this
54+
if the server is configured with the exact same tracing configuration
55+
as the client.
56+
57+
---
58+
Run `coder --help` for a list of global options.

‎docs/cli/scaletest.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,4 @@ coder scaletest
1616
| ------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1717
| [<code>cleanup</code>](./scaletest_cleanup.md) | Cleanup scaletest workspaces, then cleanup scaletest users. |
1818
| [<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. |
19+
| [<code>workspace-traffic</code>](./scaletest_workspace-traffic.md) | Generate traffic to scaletest workspaces through coderd |

‎docs/cli/scaletest_workspace-traffic.md

Lines changed: 149 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
1+
<!-- DO NOT EDIT | GENERATED CONTENT -->
2+
3+
# scaletest workspace-traffic
4+
5+
Generate traffic to scaletest workspaces through coderd
6+
7+
## Usage
8+
9+
```console
10+
coder scaletest workspace-traffic [flags]
11+
```
12+
13+
## Options
14+
15+
### --bytes-per-tick
16+
17+
| | |
18+
| ----------- | -------------------------------------------------------------- |
19+
| Type | <code>int</code> |
20+
| Environment | <code>$CODER_SCALETEST_WORKSPACE_TRAFFIC_BYTES_PER_TICK</code> |
21+
| Default | <code>1024</code> |
22+
23+
How much traffic to generate per tick.
24+
25+
### --cleanup-concurrency
26+
27+
| | |
28+
| ----------- | ------------------------------------------------- |
29+
| Type | <code>int</code> |
30+
| Environment | <code>$CODER_SCALETEST_CLEANUP_CONCURRENCY</code> |
31+
| Default | <code>1</code> |
32+
33+
Number of concurrent cleanup jobs to run. 0 means unlimited.
34+
35+
### --cleanup-job-timeout
36+
37+
| | |
38+
| ----------- | ------------------------------------------------- |
39+
| Type | <code>duration</code> |
40+
| Environment | <code>$CODER_SCALETEST_CLEANUP_JOB_TIMEOUT</code> |
41+
| Default | <code>5m</code> |
42+
43+
Timeout per job. Jobs may take longer to complete under higher concurrency limits.
44+
45+
### --cleanup-timeout
46+
47+
| | |
48+
| ----------- | --------------------------------------------- |
49+
| Type | <code>duration</code> |
50+
| Environment | <code>$CODER_SCALETEST_CLEANUP_TIMEOUT</code> |
51+
| Default | <code>30m</code> |
52+
53+
Timeout for the entire cleanup run. 0 means unlimited.
54+
55+
### --concurrency
56+
57+
| | |
58+
| ----------- | ----------------------------------------- |
59+
| Type | <code>int</code> |
60+
| Environment | <code>$CODER_SCALETEST_CONCURRENCY</code> |
61+
| Default | <code>1</code> |
62+
63+
Number of concurrent jobs to run. 0 means unlimited.
64+
65+
### --duration
66+
67+
| | |
68+
| ----------- | -------------------------------------------------------- |
69+
| Type | <code>duration</code> |
70+
| Environment | <code>$CODER_SCALETEST_WORKSPACE_TRAFFIC_DURATION</code> |
71+
| Default | <code>10s</code> |
72+
73+
How long to generate traffic for.
74+
75+
### --job-timeout
76+
77+
| | |
78+
| ----------- | ----------------------------------------- |
79+
| Type | <code>duration</code> |
80+
| Environment | <code>$CODER_SCALETEST_JOB_TIMEOUT</code> |
81+
| Default | <code>5m</code> |
82+
83+
Timeout per job. Jobs may take longer to complete under higher concurrency limits.
84+
85+
### --output
86+
87+
| | |
88+
| ----------- | ------------------------------------- |
89+
| Type | <code>string-array</code> |
90+
| Environment | <code>$CODER_SCALETEST_OUTPUTS</code> |
91+
| Default | <code>text</code> |
92+
93+
Output format specs in the format "<format>[:<path>]". Not specifying a path will default to stdout. Available formats: text, json.
94+
95+
### --tick-interval
96+
97+
| | |
98+
| ----------- | ------------------------------------------------------------- |
99+
| Type | <code>duration</code> |
100+
| Environment | <code>$CODER_SCALETEST_WORKSPACE_TRAFFIC_TICK_INTERVAL</code> |
101+
| Default | <code>100ms</code> |
102+
103+
How often to send traffic.
104+
105+
### --timeout
106+
107+
| | |
108+
| ----------- | ------------------------------------- |
109+
| Type | <code>duration</code> |
110+
| Environment | <code>$CODER_SCALETEST_TIMEOUT</code> |
111+
| Default | <code>30m</code> |
112+
113+
Timeout for the entire test run. 0 means unlimited.
114+
115+
### --trace
116+
117+
| | |
118+
| ----------- | ----------------------------------- |
119+
| Type | <code>bool</code> |
120+
| Environment | <code>$CODER_SCALETEST_TRACE</code> |
121+
122+
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.
123+
124+
### --trace-coder
125+
126+
| | |
127+
| ----------- | ----------------------------------------- |
128+
| Type | <code>bool</code> |
129+
| Environment | <code>$CODER_SCALETEST_TRACE_CODER</code> |
130+
131+
Whether opentelemetry traces are sent to Coder. We recommend keeping this disabled unless we advise you to enable it.
132+
133+
### --trace-honeycomb-api-key
134+
135+
| | |
136+
| ----------- | ----------------------------------------------------- |
137+
| Type | <code>string</code> |
138+
| Environment | <code>$CODER_SCALETEST_TRACE_HONEYCOMB_API_KEY</code> |
139+
140+
Enables trace exporting to Honeycomb.io using the provided API key.
141+
142+
### --trace-propagate
143+
144+
| | |
145+
| ----------- | --------------------------------------------- |
146+
| Type | <code>bool</code> |
147+
| Environment | <code>$CODER_SCALETEST_TRACE_PROPAGATE</code> |
148+
149+
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.

‎docs/manifest.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -630,6 +630,11 @@
630630
"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.",
631631
"path": "cli/scaletest_create-workspaces.md"
632632
},
633+
{
634+
"title": "scaletest workspace-traffic",
635+
"description": "Generate traffic to scaletest workspaces through coderd",
636+
"path": "cli/scaletest_workspace-traffic.md"
637+
},
633638
{
634639
"title": "schedule",
635640
"description": "Schedule automated start and stop times for workspaces",

0 commit comments

Comments
 (0)