chore: add prometheus monitoring of workspace traffic generation #7583
Next
Next commit
add prometheus metrics endpoint to workspacetraffic command
- Loading branch information
commit f62cf1663c70043ece072d026bc51d69070eb46c
There are no files selected for viewing
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 |
|---|---|---|
|
|
@@ -14,9 +14,13 @@ import ( | |
| "time" | ||
|
|
||
| "github.com/google/uuid" | ||
| "github.com/prometheus/client_golang/prometheus" | ||
| "go.opentelemetry.io/otel/trace" | ||
| "golang.org/x/xerrors" | ||
|
|
||
| "cdr.dev/slog" | ||
| "cdr.dev/slog/sloggers/sloghuman" | ||
|
|
||
| "github.com/coder/coder/cli/clibase" | ||
| "github.com/coder/coder/cli/cliui" | ||
| "github.com/coder/coder/coderd/httpapi" | ||
|
|
@@ -896,13 +900,14 @@ func (r *RootCmd) scaletestCreateWorkspaces() *clibase.Cmd { | |
|
|
||
| func (r *RootCmd) scaletestWorkspaceTraffic() *clibase.Cmd { | ||
| var ( | ||
| tickInterval time.Duration | ||
| bytesPerTick int64 | ||
| prometheusAddress string | ||
| client = &codersdk.Client{} | ||
| tracingFlags = &scaletestTracingFlags{} | ||
| strategy = &scaletestStrategyFlags{} | ||
| cleanupStrategy = &scaletestStrategyFlags{cleanup: true} | ||
| output = &scaletestOutputFlags{} | ||
| ) | ||
|
|
||
| cmd := &clibase.Cmd{ | ||
|
|
@@ -913,6 +918,12 @@ func (r *RootCmd) scaletestWorkspaceTraffic() *clibase.Cmd { | |
| ), | ||
| Handler: func(inv *clibase.Invocation) error { | ||
| ctx := inv.Context() | ||
| reg := prometheus.NewRegistry() | ||
| metrics := workspacetraffic.NewMetrics(reg) | ||
|
|
||
| logger := slog.Make(sloghuman.Sink(io.Discard)) | ||
| prometheusSrvClose := ServeHandler(ctx, logger, prometheusMetricsHandler(), prometheusAddress, "prometheus") | ||
| defer prometheusSrvClose() | ||
|
|
||
| // Bypass rate limiting | ||
| client.HTTPClient = &http.Client{ | ||
|
|
@@ -955,16 +966,18 @@ func (r *RootCmd) scaletestWorkspaceTraffic() *clibase.Cmd { | |
| th := harness.NewTestHarness(strategy.toStrategy(), cleanupStrategy.toStrategy()) | ||
| for idx, ws := range workspaces { | ||
| var ( | ||
| agentID uuid.UUID | ||
| agentName string | ||
|
There was a problem hiding this comment. I didn't go through the whole PR, but why is it required to specify the agent name? isn't it always "main"? There was a problem hiding this comment. My understanding is that the agent name maps directly to what's specified in the workspace Terraform, is this not the case? |
||
| name = "workspace-traffic" | ||
| id = strconv.Itoa(idx) | ||
| ) | ||
|
|
||
| for _, res := range ws.LatestBuild.Resources { | ||
| if len(res.Agents) == 0 { | ||
| continue | ||
| } | ||
| agentID = res.Agents[0].ID | ||
| agentName = res.Agents[0].Name | ||
| } | ||
|
|
||
| if agentID == uuid.Nil { | ||
|
|
@@ -974,16 +987,19 @@ func (r *RootCmd) scaletestWorkspaceTraffic() *clibase.Cmd { | |
|
|
||
| // Setup our workspace agent connection. | ||
| config := workspacetraffic.Config{ | ||
| AgentID: agentID, | ||
| AgentName: agentName, | ||
| BytesPerTick: bytesPerTick, | ||
| Duration: strategy.timeout, | ||
| TickInterval: tickInterval, | ||
| WorkspaceName: ws.Name, | ||
| WorkspaceOwner: ws.OwnerName, | ||
| } | ||
|
|
||
| if err := config.Validate(); err != nil { | ||
| return xerrors.Errorf("validate config: %w", err) | ||
| } | ||
| var runner harness.Runnable = workspacetraffic.NewRunner(client, config, metrics) | ||
| if tracingEnabled { | ||
| runner = &runnableTraceWrapper{ | ||
| tracer: tracer, | ||
|
|
@@ -1034,6 +1050,13 @@ func (r *RootCmd) scaletestWorkspaceTraffic() *clibase.Cmd { | |
| Description: "How often to send traffic.", | ||
| Value: clibase.DurationOf(&tickInterval), | ||
| }, | ||
| { | ||
| Flag: "prometheus-address", | ||
| Env: "CODER_SCALETEST_PROMETHEUS_ADDRESS", | ||
| Default: "0.0.0.0:2112", | ||
| Description: "Address on which to expose prometheus metrics.", | ||
| Value: clibase.StringOf(&prometheusAddress), | ||
| }, | ||
| } | ||
|
|
||
| tracingFlags.attach(&cmd.Options) | ||
|
|
||
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
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
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
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 |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| package workspacetraffic | ||
|
|
||
| import "github.com/prometheus/client_golang/prometheus" | ||
|
|
||
| type Metrics struct { | ||
johnstcn marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| BytesRead prometheus.CounterVec | ||
| BytesWritten prometheus.CounterVec | ||
| Errors prometheus.CounterVec | ||
| ReadLatencyMS prometheus.HistogramVec | ||
| WriteLatencyMS prometheus.HistogramVec | ||
| } | ||
|
|
||
| func NewMetrics(reg prometheus.Registerer) *Metrics { | ||
| m := &Metrics{ | ||
| BytesRead: *prometheus.NewCounterVec(prometheus.CounterOpts{ | ||
| Namespace: "coderd", | ||
| Subsystem: "scaletest", | ||
| Name: "bytes_read", | ||
| }, []string{"username", "workspace_name", "agent_name"}), | ||
| BytesWritten: *prometheus.NewCounterVec(prometheus.CounterOpts{ | ||
| Namespace: "coderd", | ||
| Subsystem: "scaletest", | ||
| Name: "bytes_written", | ||
| }, []string{"username", "workspace_name", "agent_name"}), | ||
| Errors: *prometheus.NewCounterVec(prometheus.CounterOpts{ | ||
johnstcn marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| Namespace: "coderd", | ||
| Subsystem: "scaletest", | ||
| Name: "errors", | ||
| }, []string{"username", "workspace_name", "agent_name"}), | ||
| ReadLatencyMS: *prometheus.NewHistogramVec(prometheus.HistogramOpts{ | ||
johnstcn marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| Namespace: "coderd", | ||
| Subsystem: "scaletest", | ||
| Name: "read_latency_seconds", | ||
| }, []string{"username", "workspace_name", "agent_name"}), | ||
| WriteLatencyMS: *prometheus.NewHistogramVec(prometheus.HistogramOpts{ | ||
| Namespace: "coderd", | ||
| Subsystem: "scaletest", | ||
| Name: "write_latency_seconds", | ||
| }, []string{"username", "workspace_name", "agent_name"}), | ||
| } | ||
|
|
||
| reg.MustRegister(m.BytesRead) | ||
| reg.MustRegister(m.BytesWritten) | ||
| reg.MustRegister(m.Errors) | ||
| reg.MustRegister(m.ReadLatencyMS) | ||
| reg.MustRegister(m.WriteLatencyMS) | ||
| return m | ||
| } | ||
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm wondering if we need to add some graceful period before closing to make sure that all relevant metrics are scraped before the tool goes down.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, this would be heavily dependent on the prometheus scrape interval. Simplest is probably to expose it as a parameter to be set by the test operatorl.