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

feat: include read/write byte stats in scaletests JSON report#17777

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
cstyan merged 4 commits intomainfromcallum-report-bytes
Jun 13, 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
36 changes: 20 additions & 16 deletionsscaletest/harness/results.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,14 +27,16 @@ type Results struct {

// RunResult is the result of a single test run.
type RunResult struct {
FullID string `json:"full_id"`
TestName string `json:"test_name"`
ID string `json:"id"`
Logs string `json:"logs"`
Error error `json:"error"`
StartedAt time.Time `json:"started_at"`
Duration httpapi.Duration `json:"duration"`
DurationMS int64 `json:"duration_ms"`
FullID string `json:"full_id"`
TestName string `json:"test_name"`
ID string `json:"id"`
Logs string `json:"logs"`
Error error `json:"error"`
StartedAt time.Time `json:"started_at"`
Duration httpapi.Duration `json:"duration"`
DurationMS int64 `json:"duration_ms"`
TotalBytesRead int64 `json:"total_bytes_read"`
TotalBytesWritten int64 `json:"total_bytes_written"`
}

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

return RunResult{
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(),
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,
}
}

Expand Down
60 changes: 36 additions & 24 deletionsscaletest/harness/results_test.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -36,34 +36,40 @@ 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,
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,
},
"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,
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,
},
"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,
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,
},
},
Elapsed: httpapi.Duration(time.Second),
Expand DownExpand Up@@ -109,6 +115,8 @@ 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"
},
"test-0/1": {
Expand All@@ -119,6 +127,8 @@ Test results:
"started_at": "2023-10-05T12:03:56.728813665Z",
"duration": "1s",
"duration_ms": 1000,
"total_bytes_read": 512,
"total_bytes_written": 1024,
"error": "\u003cnil\u003e"
},
"test-0/2": {
Expand All@@ -129,6 +139,8 @@ Test results:
"started_at": "2023-10-05T12:03:57.061813665Z",
"duration": "1s",
"duration_ms": 1000,
"total_bytes_read": 2048,
"total_bytes_written": 4096,
"error": "test-0/2 error"
}
}
Expand Down
25 changes: 20 additions & 5 deletionsscaletest/harness/run.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,13 @@ 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.
type Collectable interface {
Runnable
// Gets the bytes transferred
GetBytesTransferred() (int64, int64)
}

// AddRun creates a new *TestRun with the given name, ID and Runnable, adds it
// to the harness and returns it. Panics if the harness has been started, or a
// test with the given run.FullID() is already registered.
Expand DownExpand Up@@ -66,11 +73,13 @@ type TestRun struct {
id string
runner Runnable

logs *syncBuffer
done chan struct{}
started time.Time
duration time.Duration
err error
logs *syncBuffer
done chan struct{}
started time.Time
duration time.Duration
err error
bytesRead int64
bytesWritten int64
}

func NewTestRun(testName string, id string, runner Runnable) *TestRun {
Expand DownExpand Up@@ -98,6 +107,11 @@ func (r *TestRun) Run(ctx context.Context) (err error) {
defer func() {
r.duration = time.Since(r.started)
r.err = err
c, ok := r.runner.(Collectable)
if !ok {
return
}
r.bytesRead, r.bytesWritten = c.GetBytesTransferred()
}()
defer func() {
e := recover()
Expand All@@ -107,6 +121,7 @@ func (r *TestRun) Run(ctx context.Context) (err error) {
}()

err = r.runner.Run(ctx, r.id, r.logs)

//nolint:revive // we use named returns because we mutate it in a defer
return
}
Expand Down
41 changes: 38 additions & 3 deletionsscaletest/harness/run_test.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,13 +17,24 @@ 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 if byte transfer tracking is required.
getBytesTransferred func() (int64, int64)
}

// 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) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I'm curious what's going on with this pattern, but your addition seems totally in line with what's already here :)

Copy link
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

yeah I don't particularly like it, feels odd/reads strangely, but it's already in use for the cleanable interface as well so 🤷

if fns.getBytesTransferred == nil {
return 0, 0
}

return fns.getBytesTransferred()
}

// Cleanup implements Cleanable.
func (fns testFns) Cleanup(ctx context.Context, id string, logs io.Writer) error {
if fns.CleanupFn == nil {
Expand All@@ -40,9 +51,10 @@ func Test_TestRun(t *testing.T) {
t.Parallel()

var (
name, id = "test", "1"
runCalled int64
cleanupCalled int64
name, id = "test", "1"
runCalled int64
cleanupCalled int64
collectableCalled int64

testFns = testFns{
RunFn: func(ctx context.Context, id string, logs io.Writer) error {
Expand All@@ -53,6 +65,10 @@ func Test_TestRun(t *testing.T) {
atomic.AddInt64(&cleanupCalled, 1)
return nil
},
getBytesTransferred: func() (int64, int64) {
atomic.AddInt64(&collectableCalled, 1)
return 0, 0
},
}
)

Expand All@@ -62,6 +78,7 @@ func Test_TestRun(t *testing.T) {
err := run.Run(context.Background())
require.NoError(t, err)
require.EqualValues(t, 1, atomic.LoadInt64(&runCalled))
require.EqualValues(t, 1, atomic.LoadInt64(&collectableCalled))

err = run.Cleanup(context.Background())
require.NoError(t, err)
Expand DownExpand Up@@ -105,6 +122,24 @@ func Test_TestRun(t *testing.T) {
})
})

t.Run("Collectable", func(t *testing.T) {
t.Parallel()

t.Run("NoFn", func(t *testing.T) {
t.Parallel()

run := harness.NewTestRun("test", "1", testFns{
RunFn: func(ctx context.Context, id string, logs io.Writer) error {
return nil
},
getBytesTransferred: nil,
})

err := run.Run(context.Background())
require.NoError(t, err)
})
})

t.Run("CatchesRunPanic", func(t *testing.T) {
t.Parallel()

Expand Down
13 changes: 12 additions & 1 deletionscaletest/workspacetraffic/metrics.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
package workspacetraffic

import "github.com/prometheus/client_golang/prometheus"
import (
"sync/atomic"

"github.com/prometheus/client_golang/prometheus"
)

type Metrics struct {
BytesReadTotal prometheus.CounterVec
Expand DownExpand Up@@ -75,12 +79,14 @@ type ConnMetrics interface {
AddError(float64)
ObserveLatency(float64)
AddTotal(float64)
GetTotalBytes() int64
}

type connMetrics struct {
addError func(float64)
observeLatency func(float64)
addTotal func(float64)
total int64
}

func (c *connMetrics) AddError(f float64) {
Expand All@@ -92,5 +98,10 @@ func (c *connMetrics) ObserveLatency(f float64) {
}

func (c *connMetrics) AddTotal(f float64) {
atomic.AddInt64(&c.total, int64(f))
c.addTotal(f)
}

func (c *connMetrics) GetTotalBytes() int64 {
return c.total
}
6 changes: 6 additions & 0 deletionsscaletest/workspacetraffic/run.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -210,6 +210,12 @@ 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
}

// Cleanup does nothing, successfully.
func (*Runner) Cleanup(context.Context, string, io.Writer) error {
return nil
Expand Down
4 changes: 4 additions & 0 deletionsscaletest/workspacetraffic/run_test.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -422,3 +422,7 @@ func (m *testMetrics) Latencies() []float64 {
defer m.Unlock()
return m.latencies
}

func (m *testMetrics) GetTotalBytes() int64 {
return int64(m.total)
}
Loading
[8]ページ先頭
©2009-2025 Movatter.jp