- Notifications
You must be signed in to change notification settings - Fork927
feat(cli): add trafficgen command for load testing#7307
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
26 commits Select commitHold shift + click to select a range
220edbf feat(cli): add trafficgen command for load testing
johnstcn737b475 skip test for now
johnstcn9b26587 make fmt
johnstcnc56d84e lint
johnstcne548892 swap order of waiting for read and write
johnstcn31ef743 close connection, add output formatting
johnstcnfafca95 do what the comment says
johnstcn65c6d88 move back under scaletest cmd
johnstcn0bfa9f6 integrate with scaletest harness
johnstcnda935a2 drain connection async
johnstcn5daa526 fix cancellation
johnstcn4f165be handle deadline exceeded in drain
johnstcn31fa8be address PR comments
johnstcn0817204 fixup! address PR comments
johnstcna6d7870 ACTUALLY limit traffic instead of just blasting the firehose
johnstcn935dcbd log config
johnstcne2efeff lint
johnstcnb105e67 chore(cli): scaletest: move logic for flushing traces into tracing pr…
johnstcn731b4db remove unnecessary context-based I/O
johnstcn9dc28a2 refactor bytes per second to bytes per tick and tick interval
johnstcn7b98b35 rename trafficgen -> workspace-traffic
johnstcnb9c845f make gen
johnstcn2574a00 use strategy.timeout instead of duration
johnstcn516ffa1 rm ctx from countReadWriter
johnstcn655d95a fixup
johnstcnca8b212 Merge remote-tracking branch 'origin/main' into cj/scaletest-trafficgen
johnstcnFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
10 changes: 5 additions & 5 deletionscli/root.go
This file contains hidden or 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 |
|---|---|---|
| @@ -87,11 +87,13 @@ func (r *RootCmd) Core() []*clibase.Cmd { | ||
| // Workspace Commands | ||
| r.configSSH(), | ||
| r.create(), | ||
| r.deleteWorkspace(), | ||
| r.list(), | ||
| r.parameters(), | ||
| r.ping(), | ||
| r.rename(), | ||
| r.scaletest(), | ||
| r.schedules(), | ||
| r.show(), | ||
| r.speedtest(), | ||
| @@ -100,13 +102,11 @@ func (r *RootCmd) Core() []*clibase.Cmd { | ||
| r.stop(), | ||
| r.update(), | ||
| r.restart(), | ||
| // Hidden | ||
| r.gitssh(), | ||
| r.vscodeSSH(), | ||
| r.workspaceAgent(), | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. review: I'm assuming all of this wants to be sorted alphabetically. | ||
| } | ||
| } | ||
306 changes: 236 additions & 70 deletionscli/scaletest.go
This file contains hidden or 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 |
|---|---|---|
| @@ -28,6 +28,7 @@ import ( | ||
| "github.com/coder/coder/scaletest/harness" | ||
| "github.com/coder/coder/scaletest/reconnectingpty" | ||
| "github.com/coder/coder/scaletest/workspacebuild" | ||
| "github.com/coder/coder/scaletest/workspacetraffic" | ||
| ) | ||
| const scaletestTracerName = "coder_scaletest" | ||
| @@ -42,6 +43,7 @@ func (r *RootCmd) scaletest() *clibase.Cmd { | ||
| Children: []*clibase.Cmd{ | ||
| r.scaletestCleanup(), | ||
| r.scaletestCreateWorkspaces(), | ||
| r.scaletestWorkspaceTraffic(), | ||
| }, | ||
| } | ||
| @@ -107,7 +109,10 @@ func (s *scaletestTracingFlags) provider(ctx context.Context) (trace.TracerProvi | ||
| return tracerProvider, func(ctx context.Context) error { | ||
| var err error | ||
| closeTracingOnce.Do(func() { | ||
| // Allow time to upload traces even if ctx is canceled | ||
| traceCtx, traceCancel := context.WithTimeout(context.Background(), 10*time.Second) | ||
| defer traceCancel() | ||
| err = closeTracing(traceCtx) | ||
| }) | ||
| return err | ||
| @@ -384,33 +389,9 @@ func (r *RootCmd) scaletestCleanup() *clibase.Cmd { | ||
| } | ||
| cliui.Infof(inv.Stdout, "Fetching scaletest workspaces...") | ||
Comment on lines -387 to -413 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. review: extracted to function | ||
| workspaces, err := getScaletestWorkspaces(ctx, client) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| cliui.Errorf(inv.Stderr, "Found %d scaletest workspaces\n", len(workspaces)) | ||
| @@ -441,33 +422,9 @@ func (r *RootCmd) scaletestCleanup() *clibase.Cmd { | ||
| } | ||
| cliui.Infof(inv.Stdout, "Fetching scaletest users...") | ||
Comment on lines -444 to -470 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. review: extracted to function | ||
| users, err := getScaletestUsers(ctx, client) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| cliui.Errorf(inv.Stderr, "Found %d scaletest users\n", len(users)) | ||
| @@ -683,10 +640,11 @@ func (r *RootCmd) scaletestCreateWorkspaces() *clibase.Cmd { | ||
| } | ||
| defer func() { | ||
| // Allow time for traces to flush even if command context is | ||
| // canceled. This is a no-op if tracing is not enabled. | ||
| _, _ = fmt.Fprintln(inv.Stderr, "\nUploading traces...") | ||
| if err := closeTracing(ctx); err != nil { | ||
| _, _ = fmt.Fprintf(inv.Stderr, "\nError uploading traces: %+v\n", err) | ||
| } | ||
| }() | ||
| tracer := tracerProvider.Tracer(scaletestTracerName) | ||
| @@ -800,17 +758,6 @@ func (r *RootCmd) scaletestCreateWorkspaces() *clibase.Cmd { | ||
| return xerrors.Errorf("cleanup tests: %w", err) | ||
| } | ||
| if res.TotalFail > 0 { | ||
| return xerrors.New("load test failed, see above for more details") | ||
| } | ||
| @@ -947,6 +894,156 @@ func (r *RootCmd) scaletestCreateWorkspaces() *clibase.Cmd { | ||
| return cmd | ||
| } | ||
| func (r *RootCmd) scaletestWorkspaceTraffic() *clibase.Cmd { | ||
| var ( | ||
| tickInterval time.Duration | ||
| bytesPerTick int64 | ||
| client = &codersdk.Client{} | ||
| tracingFlags = &scaletestTracingFlags{} | ||
| strategy = &scaletestStrategyFlags{} | ||
| cleanupStrategy = &scaletestStrategyFlags{cleanup: true} | ||
| output = &scaletestOutputFlags{} | ||
johnstcn marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| ) | ||
| cmd := &clibase.Cmd{ | ||
| Use: "workspace-traffic", | ||
| Short: "Generate traffic to scaletest workspaces through coderd", | ||
| Middleware: clibase.Chain( | ||
| r.InitClient(client), | ||
| ), | ||
| Handler: func(inv *clibase.Invocation) error { | ||
| ctx := inv.Context() | ||
| // Bypass rate limiting | ||
| client.HTTPClient = &http.Client{ | ||
| Transport: &headerTransport{ | ||
| transport: http.DefaultTransport, | ||
| header: map[string][]string{ | ||
| codersdk.BypassRatelimitHeader: {"true"}, | ||
| }, | ||
| }, | ||
| } | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Suggestion: Since header transport isn't implementing close idler, (Or alternatively, implementing deferhttp.DefaultTransport.(*http.Transport).CloseIdleConnections() | ||
| workspaces, err := getScaletestWorkspaces(inv.Context(), client) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| if len(workspaces) == 0 { | ||
| return xerrors.Errorf("no scaletest workspaces exist") | ||
| } | ||
| tracerProvider, closeTracing, tracingEnabled, err := tracingFlags.provider(ctx) | ||
| if err != nil { | ||
| return xerrors.Errorf("create tracer provider: %w", err) | ||
| } | ||
| defer func() { | ||
| // Allow time for traces to flush even if command context is | ||
| // canceled. This is a no-op if tracing is not enabled. | ||
| _, _ = fmt.Fprintln(inv.Stderr, "\nUploading traces...") | ||
| if err := closeTracing(ctx); err != nil { | ||
| _, _ = fmt.Fprintf(inv.Stderr, "\nError uploading traces: %+v\n", err) | ||
| } | ||
| }() | ||
| tracer := tracerProvider.Tracer(scaletestTracerName) | ||
| outputs, err := output.parse() | ||
| if err != nil { | ||
| return xerrors.Errorf("could not parse --output flags") | ||
| } | ||
| th := harness.NewTestHarness(strategy.toStrategy(), cleanupStrategy.toStrategy()) | ||
| for idx, ws := range workspaces { | ||
| var ( | ||
| agentID uuid.UUID | ||
| name = "workspace-traffic" | ||
| id = strconv.Itoa(idx) | ||
| ) | ||
| for _, res := range ws.LatestBuild.Resources { | ||
| if len(res.Agents) == 0 { | ||
| continue | ||
| } | ||
| agentID = res.Agents[0].ID | ||
| } | ||
| if agentID == uuid.Nil { | ||
| _, _ = fmt.Fprintf(inv.Stderr, "WARN: skipping workspace %s: no agent\n", ws.Name) | ||
| continue | ||
| } | ||
| // Setup our workspace agent connection. | ||
| config := workspacetraffic.Config{ | ||
| AgentID: agentID, | ||
| BytesPerTick: bytesPerTick, | ||
| Duration: strategy.timeout, | ||
| TickInterval: tickInterval, | ||
| } | ||
| if err := config.Validate(); err != nil { | ||
| return xerrors.Errorf("validate config: %w", err) | ||
| } | ||
| var runner harness.Runnable = workspacetraffic.NewRunner(client, config) | ||
| if tracingEnabled { | ||
| runner = &runnableTraceWrapper{ | ||
| tracer: tracer, | ||
| spanName: fmt.Sprintf("%s/%s", name, id), | ||
| runner: runner, | ||
| } | ||
| } | ||
| th.AddRun(name, id, runner) | ||
| } | ||
| _, _ = fmt.Fprintln(inv.Stderr, "Running load test...") | ||
| testCtx, testCancel := strategy.toContext(ctx) | ||
| defer testCancel() | ||
| err = th.Run(testCtx) | ||
| if err != nil { | ||
| return xerrors.Errorf("run test harness (harness failure, not a test failure): %w", err) | ||
| } | ||
| res := th.Results() | ||
| for _, o := range outputs { | ||
| err = o.write(res, inv.Stdout) | ||
| if err != nil { | ||
| return xerrors.Errorf("write output %q to %q: %w", o.format, o.path, err) | ||
| } | ||
| } | ||
| if res.TotalFail > 0 { | ||
| return xerrors.New("load test failed, see above for more details") | ||
| } | ||
| return nil | ||
| }, | ||
| } | ||
| cmd.Options = []clibase.Option{ | ||
| { | ||
| Flag: "bytes-per-tick", | ||
| Env: "CODER_SCALETEST_WORKSPACE_TRAFFIC_BYTES_PER_TICK", | ||
| Default: "1024", | ||
| Description: "How much traffic to generate per tick.", | ||
| Value: clibase.Int64Of(&bytesPerTick), | ||
| }, | ||
| { | ||
| Flag: "tick-interval", | ||
| Env: "CODER_SCALETEST_WORKSPACE_TRAFFIC_TICK_INTERVAL", | ||
| Default: "100ms", | ||
| Description: "How often to send traffic.", | ||
| Value: clibase.DurationOf(&tickInterval), | ||
| }, | ||
| } | ||
| tracingFlags.attach(&cmd.Options) | ||
| strategy.attach(&cmd.Options) | ||
| cleanupStrategy.attach(&cmd.Options) | ||
| output.attach(&cmd.Options) | ||
| return cmd | ||
| } | ||
| type runnableTraceWrapper struct { | ||
| tracer trace.Tracer | ||
| spanName string | ||
| @@ -1023,3 +1120,72 @@ func isScaleTestWorkspace(workspace codersdk.Workspace) bool { | ||
| return strings.HasPrefix(workspace.OwnerName, "scaletest-") || | ||
| strings.HasPrefix(workspace.Name, "scaletest-") | ||
| } | ||
| func getScaletestWorkspaces(ctx context.Context, client *codersdk.Client) ([]codersdk.Workspace, error) { | ||
| var ( | ||
| pageNumber = 0 | ||
| limit = 100 | ||
| workspaces []codersdk.Workspace | ||
| ) | ||
| for { | ||
| page, err := client.Workspaces(ctx, codersdk.WorkspaceFilter{ | ||
| Name: "scaletest-", | ||
| Offset: pageNumber * limit, | ||
| Limit: limit, | ||
| }) | ||
| if err != nil { | ||
| return nil, xerrors.Errorf("fetch scaletest workspaces page %d: %w", pageNumber, err) | ||
| } | ||
| pageNumber++ | ||
| if len(page.Workspaces) == 0 { | ||
| break | ||
| } | ||
| pageWorkspaces := make([]codersdk.Workspace, 0, len(page.Workspaces)) | ||
| for _, w := range page.Workspaces { | ||
| if isScaleTestWorkspace(w) { | ||
| pageWorkspaces = append(pageWorkspaces, w) | ||
| } | ||
| } | ||
| workspaces = append(workspaces, pageWorkspaces...) | ||
| } | ||
| return workspaces, nil | ||
| } | ||
| func getScaletestUsers(ctx context.Context, client *codersdk.Client) ([]codersdk.User, error) { | ||
| var ( | ||
| pageNumber = 0 | ||
| limit = 100 | ||
| users []codersdk.User | ||
| ) | ||
| for { | ||
| page, err := client.Users(ctx, codersdk.UsersRequest{ | ||
| Search: "scaletest-", | ||
| Pagination: codersdk.Pagination{ | ||
| Offset: pageNumber * limit, | ||
| Limit: limit, | ||
| }, | ||
| }) | ||
| if err != nil { | ||
| return nil, xerrors.Errorf("fetch scaletest users page %d: %w", pageNumber, err) | ||
| } | ||
| pageNumber++ | ||
| if len(page.Users) == 0 { | ||
| break | ||
| } | ||
| pageUsers := make([]codersdk.User, 0, len(page.Users)) | ||
| for _, u := range page.Users { | ||
| if isScaleTestUser(u) { | ||
| pageUsers = append(pageUsers, u) | ||
| } | ||
| } | ||
| users = append(users, pageUsers...) | ||
| } | ||
| return users, nil | ||
| } | ||
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.