Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

refactor(scaletest): support exposing arbitrary metrics on scaletest runs#19886

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
ethanndickson merged 1 commit intomainfromethan/metrics-map-scaletest-runs
Sep 22, 2025
Merged
Show file tree
Hide file tree
Changes fromall commits
Commits
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 18 additions & 20 deletionsscaletest/harness/results.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,16 +27,15 @@ type Results struct {

// RunResult is the result of a single test run.
typeRunResultstruct {
FullIDstring`json:"full_id"`
TestNamestring`json:"test_name"`
IDstring`json:"id"`
Logsstring`json:"logs"`
Errorerror`json:"error"`
StartedAt time.Time`json:"started_at"`
Duration httpapi.Duration`json:"duration"`
DurationMSint64`json:"duration_ms"`
TotalBytesReadint64`json:"total_bytes_read"`
TotalBytesWrittenint64`json:"total_bytes_written"`
FullIDstring`json:"full_id"`
TestNamestring`json:"test_name"`
IDstring`json:"id"`
Logsstring`json:"logs"`
Errorerror`json:"error"`
StartedAt time.Time`json:"started_at"`
Duration httpapi.Duration`json:"duration"`
DurationMSint64`json:"duration_ms"`
Metricsmap[string]any`json:"metrics,omitempty"`
}

// MarshalJSON implements json.Marhshaler for RunResult.
Expand All@@ -61,16 +60,15 @@ func (r *TestRun) Result() RunResult {
}

returnRunResult{
FullID:r.FullID(),
TestName:r.testName,
ID:r.id,
Logs:r.logs.String(),
Error:r.err,
StartedAt:r.started,
Duration:httpapi.Duration(r.duration),
DurationMS:r.duration.Milliseconds(),
TotalBytesRead:r.bytesRead,
TotalBytesWritten:r.bytesWritten,
FullID:r.FullID(),
TestName:r.testName,
ID:r.id,
Logs:r.logs.String(),
Error:r.err,
StartedAt:r.started,
Duration:httpapi.Duration(r.duration),
DurationMS:r.duration.Milliseconds(),
Metrics:r.metrics,
}
}

Expand Down
87 changes: 50 additions & 37 deletionsscaletest/harness/results_test.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ import (

"github.com/coder/coder/v2/coderd/httpapi"
"github.com/coder/coder/v2/scaletest/harness"
"github.com/coder/coder/v2/scaletest/workspacetraffic"
)

type testError struct {
Expand All@@ -36,40 +37,46 @@ func Test_Results(t *testing.T) {
TotalFail: 2,
Runs: map[string]harness.RunResult{
"test-0/0": {
FullID: "test-0/0",
TestName: "test-0",
ID: "0",
Logs: "test-0/0 log line 1\ntest-0/0 log line 2",
Error: xerrors.New("test-0/0 error"),
StartedAt: now,
Duration: httpapi.Duration(time.Second),
DurationMS: 1000,
TotalBytesRead: 1024,
TotalBytesWritten: 2048,
FullID: "test-0/0",
TestName: "test-0",
ID: "0",
Logs: "test-0/0 log line 1\ntest-0/0 log line 2",
Error: xerrors.New("test-0/0 error"),
StartedAt: now,
Duration: httpapi.Duration(time.Second),
DurationMS: 1000,
Metrics: map[string]any{
workspacetraffic.BytesReadMetric: 1024,
workspacetraffic.BytesWrittenMetric: 2048,
},
},
"test-0/1": {
FullID: "test-0/1",
TestName: "test-0",
ID: "1",
Logs: "test-0/1 log line 1\ntest-0/1 log line 2",
Error: nil,
StartedAt: now.Add(333 * time.Millisecond),
Duration: httpapi.Duration(time.Second),
DurationMS: 1000,
TotalBytesRead: 512,
TotalBytesWritten: 1024,
FullID: "test-0/1",
TestName: "test-0",
ID: "1",
Logs: "test-0/1 log line 1\ntest-0/1 log line 2",
Error: nil,
StartedAt: now.Add(333 * time.Millisecond),
Duration: httpapi.Duration(time.Second),
DurationMS: 1000,
Metrics: map[string]any{
workspacetraffic.BytesReadMetric: 512,
workspacetraffic.BytesWrittenMetric: 1024,
},
},
"test-0/2": {
FullID: "test-0/2",
TestName: "test-0",
ID: "2",
Logs: "test-0/2 log line 1\ntest-0/2 log line 2",
Error: testError{hidden: xerrors.New("test-0/2 error")},
StartedAt: now.Add(666 * time.Millisecond),
Duration: httpapi.Duration(time.Second),
DurationMS: 1000,
TotalBytesRead: 2048,
TotalBytesWritten: 4096,
FullID: "test-0/2",
TestName: "test-0",
ID: "2",
Logs: "test-0/2 log line 1\ntest-0/2 log line 2",
Error: testError{hidden: xerrors.New("test-0/2 error")},
StartedAt: now.Add(666 * time.Millisecond),
Duration: httpapi.Duration(time.Second),
DurationMS: 1000,
Metrics: map[string]any{
workspacetraffic.BytesReadMetric: 2048,
workspacetraffic.BytesWrittenMetric: 4096,
},
},
},
Elapsed: httpapi.Duration(time.Second),
Expand DownExpand Up@@ -115,9 +122,11 @@ Test results:
"started_at": "2023-10-05T12:03:56.395813665Z",
"duration": "1s",
"duration_ms": 1000,
"total_bytes_read": 1024,
"total_bytes_written": 2048,
"error": "test-0/0 error:\n github.com/coder/coder/v2/scaletest/harness_test.Test_Results\n [working_directory]/results_test.go:43"
"metrics": {
"bytes_read": 1024,
"bytes_written": 2048
},
"error": "test-0/0 error:\n github.com/coder/coder/v2/scaletest/harness_test.Test_Results\n [working_directory]/results_test.go:44"
},
"test-0/1": {
"full_id": "test-0/1",
Expand All@@ -127,8 +136,10 @@ Test results:
"started_at": "2023-10-05T12:03:56.728813665Z",
"duration": "1s",
"duration_ms": 1000,
"total_bytes_read": 512,
"total_bytes_written": 1024,
"metrics": {
"bytes_read": 512,
"bytes_written": 1024
},
"error": "\u003cnil\u003e"
},
"test-0/2": {
Expand All@@ -139,8 +150,10 @@ Test results:
"started_at": "2023-10-05T12:03:57.061813665Z",
"duration": "1s",
"duration_ms": 1000,
"total_bytes_read": 2048,
"total_bytes_written": 4096,
"metrics": {
"bytes_read": 2048,
"bytes_written": 4096
},
"error": "test-0/2 error"
}
}
Expand Down
21 changes: 10 additions & 11 deletionsscaletest/harness/run.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,11 +31,11 @@ type Cleanable interface {
Cleanup(ctx context.Context, id string, logs io.Writer) error
}

// Collectable is an optional extension to Runnable that allows to get metrics from the runner.
// Collectable is an optional extension to Runnable that exposes additional
// metrics from the runner.
type Collectable interface {
Runnable
// Gets the bytes transferred
GetBytesTransferred() (int64, int64)
GetMetrics() map[string]any
}

// AddRun creates a new *TestRun with the given name, ID and Runnable, adds it
Expand DownExpand Up@@ -73,13 +73,12 @@ type TestRun struct {
id string
runner Runnable

logs *syncBuffer
done chan struct{}
started time.Time
duration time.Duration
err error
bytesRead int64
bytesWritten int64
logs *syncBuffer
done chan struct{}
started time.Time
duration time.Duration
err error
metrics map[string]any
}

func NewTestRun(testName string, id string, runner Runnable) *TestRun {
Expand DownExpand Up@@ -111,7 +110,7 @@ func (r *TestRun) Run(ctx context.Context) (err error) {
if !ok {
return
}
r.bytesRead, r.bytesWritten= c.GetBytesTransferred()
r.metrics= c.GetMetrics()
}()
defer func() {
e := recover()
Expand Down
24 changes: 15 additions & 9 deletionsscaletest/harness/run_test.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,22 +17,28 @@ type testFns struct {
RunFn func(ctx context.Context, id string, logs io.Writer) error
// CleanupFn is optional if no cleanup is required.
CleanupFn func(ctx context.Context, id string, logs io.Writer) error
//getBytesTransferred is optional ifbyte transfer tracking is required.
getBytesTransferred func()(int64, int64)
//GetMetricsFn is optional ifno metric collection is required.
GetMetricsFn func()map[string]any
}

var (
_ harness.Runnable = &testFns{}
_ harness.Cleanable = &testFns{}
_ harness.Collectable = &testFns{}
)

// Run implements Runnable.
func (fns testFns) Run(ctx context.Context, id string, logs io.Writer) error {
return fns.RunFn(ctx, id, logs)
}

// GetBytesTransferred implements Collectable.
func (fns testFns)GetBytesTransferred()(bytesRead int64, bytesWritten int64) {
if fns.getBytesTransferred == nil {
return0, 0
func (fns testFns)GetMetrics()map[string]any {
if fns.GetMetricsFn == nil {
returnnil
}

return fns.getBytesTransferred()
return fns.GetMetricsFn()
}

// Cleanup implements Cleanable.
Expand DownExpand Up@@ -65,9 +71,9 @@ func Test_TestRun(t *testing.T) {
atomic.AddInt64(&cleanupCalled, 1)
return nil
},
getBytesTransferred: func()(int64, int64) {
GetMetricsFn: func()map[string]any {
atomic.AddInt64(&collectableCalled, 1)
return0, 0
returnnil
},
}
)
Expand DownExpand Up@@ -132,7 +138,7 @@ func Test_TestRun(t *testing.T) {
RunFn: func(ctx context.Context, id string, logs io.Writer) error {
return nil
},
getBytesTransferred: nil,
GetMetricsFn: nil,
})

err := run.Run(context.Background())
Expand Down
19 changes: 13 additions & 6 deletionsscaletest/workspacetraffic/run.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,8 +28,9 @@ type Runner struct {
}

var (
_ harness.Runnable = &Runner{}
_ harness.Cleanable = &Runner{}
_ harness.Runnable = &Runner{}
_ harness.Cleanable = &Runner{}
_ harness.Collectable = &Runner{}
)

// func NewRunner(client *codersdk.Client, cfg Config, metrics *Metrics) *Runner {
Expand DownExpand Up@@ -210,10 +211,16 @@ func (r *Runner) Run(ctx context.Context, _ string, logs io.Writer) (err error)
}
}

func (r *Runner) GetBytesTransferred() (bytesRead, bytesWritten int64) {
bytesRead = r.cfg.ReadMetrics.GetTotalBytes()
bytesWritten = r.cfg.WriteMetrics.GetTotalBytes()
return bytesRead, bytesWritten
const (
BytesReadMetric = "bytes_read"
BytesWrittenMetric = "bytes_written"
)

func (r *Runner) GetMetrics() map[string]any {
return map[string]any{
BytesReadMetric: r.cfg.ReadMetrics.GetTotalBytes(),
BytesWrittenMetric: r.cfg.WriteMetrics.GetTotalBytes(),
}
}

// Cleanup does nothing, successfully.
Expand Down
Loading
[8]ページ先頭
©2009-2025 Movatter.jp