Skip to content

feat: deprecate NewReader and migrate to NewReaderOptions #257

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 15, 2025
Merged

feat: deprecate NewReader and migrate to NewReaderOptions #257

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
06b56a9
feat: deprecate NewReader and migrate to NewReaderOptions
kruskall Aug 15, 2025
b755577
Update util_test.go
kruskall Aug 15, 2025
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
11 changes: 8 additions & 3 deletions metric/system/cgroup/reader.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,11 +119,13 @@ type ReaderOptions struct {
}

// NewReader creates and returns a new Reader.
func NewReader(rootfsMountpoint resolve.Resolver, ignoreRootCgroups bool, logger *logp.Logger) (*Reader, error) {
//
// Deprecated: use NewReaderOptions
func NewReader(rootfsMountpoint resolve.Resolver, ignoreRootCgroups bool) (*Reader, error) {
return NewReaderOptions(ReaderOptions{
RootfsMountpoint: rootfsMountpoint,
IgnoreRootCgroups: ignoreRootCgroups,
Logger: logger,
Logger: logp.NewNopLogger(),
})
}

Expand Down Expand Up @@ -258,7 +260,10 @@ func (r *Reader) GetV2StatsForProcess(pid int) (*StatsV2, error) { //nolint: dup
// ProcessCgroupPaths is a wrapper around Reader.ProcessCgroupPaths for libraries that only need the slimmer functionality from
// the gosigar cgroups code. This does not have the same function signature, and consumers still need to distinguish between v1 and v2 cgroups.
func ProcessCgroupPaths(hostfs resolve.Resolver, pid int, logger *logp.Logger) (PathList, error) {
reader, err := NewReader(hostfs, false, logger)
reader, err := NewReaderOptions(ReaderOptions{
RootfsMountpoint: hostfs,
Logger: logger,
})
if err != nil {
return PathList{}, fmt.Errorf("error creating cgroups reader: %w", err)
}
Expand Down
24 changes: 20 additions & 4 deletions metric/system/cgroup/reader_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,11 @@ func TestReaderOptsWithoutResolve(t *testing.T) {

func TestV1EventDifferentPaths(t *testing.T) {
pid := 3757
reader, err := NewReader(resolve.NewTestResolver("testdata/ubuntu1804"), true, logptest.NewTestingLogger(t, ""))
reader, err := NewReaderOptions(ReaderOptions{
RootfsMountpoint: resolve.NewTestResolver("testdata/ubuntu1804"),
IgnoreRootCgroups: true,
Logger: logptest.NewTestingLogger(t, ""),
})
require.NoError(t, err, "error in NewReader")

stats, err := reader.GetV1StatsForProcess(pid)
Expand All @@ -67,7 +71,11 @@ func TestV1EventDifferentPaths(t *testing.T) {
}

func TestReaderGetStatsV1(t *testing.T) {
reader, err := NewReader(resolve.NewTestResolver("testdata/docker"), true, logptest.NewTestingLogger(t, ""))
reader, err := NewReaderOptions(ReaderOptions{
RootfsMountpoint: resolve.NewTestResolver("testdata/docker"),
IgnoreRootCgroups: true,
Logger: logptest.NewTestingLogger(t, ""),
})
require.NoError(t, err, "error in NewReader")

stats, err := reader.GetV1StatsForProcess(985)
Expand Down Expand Up @@ -97,7 +105,11 @@ func TestReaderGetStatsV1(t *testing.T) {
// testcase for the situation where both cgroup v1 and v2 controllers exist but
// /sys/fs/cgroup/unified is not mounted
func TestReaderGetStatsV1MalformedHybrid(t *testing.T) {
reader, err := NewReader(resolve.NewTestResolver("testdata/amzn2"), true, logptest.NewTestingLogger(t, ""))
reader, err := NewReaderOptions(ReaderOptions{
RootfsMountpoint: resolve.NewTestResolver("testdata/amzn2"),
IgnoreRootCgroups: true,
Logger: logptest.NewTestingLogger(t, ""),
})
require.NoError(t, err, "error in NewReader")

stats, err := reader.GetV1StatsForProcess(493239)
Expand All @@ -124,7 +136,11 @@ func TestReaderGetStatsV1MalformedHybrid(t *testing.T) {
}

func TestReaderGetStatsV2(t *testing.T) {
reader, err := NewReader(resolve.NewTestResolver("testdata/docker"), true, logptest.NewTestingLogger(t, ""))
reader, err := NewReaderOptions(ReaderOptions{
RootfsMountpoint: resolve.NewTestResolver("testdata/docker"),
IgnoreRootCgroups: true,
Logger: logptest.NewTestingLogger(t, ""),
})
require.NoError(t, err, "error in NewReader")

stats, err := reader.GetV2StatsForProcess(312)
Expand Down
20 changes: 16 additions & 4 deletions metric/system/cgroup/util_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,10 @@ func TestSubsystemMountpoints(t *testing.T) {
}

func TestProcessCgroupPaths(t *testing.T) {
reader, err := NewReader(resolve.NewTestResolver("testdata/docker"), false, logptest.NewTestingLogger(t, ""))
reader, err := NewReaderOptions(ReaderOptions{
RootfsMountpoint: resolve.NewTestResolver("testdata/docker"),
Logger: logptest.NewTestingLogger(t, ""),
})
if err != nil {
t.Fatalf("error in NewReader: %s", err)
}
Expand All @@ -181,7 +184,10 @@ func TestProcessCgroupPaths(t *testing.T) {
}

func TestProcessCgroupHybridPaths(t *testing.T) {
reader, err := NewReader(resolve.NewTestResolver("testdata/amzn2"), false, logptest.NewTestingLogger(t, ""))
reader, err := NewReaderOptions(ReaderOptions{
RootfsMountpoint: resolve.NewTestResolver("testdata/amzn2"),
Logger: logptest.NewTestingLogger(t, ""),
})
if err != nil {
t.Fatalf("error in NewReader: %s", err)
}
Expand All @@ -206,7 +212,10 @@ func TestProcessCgroupHybridPaths(t *testing.T) {
}

func TestProcessCgroupPathsV2(t *testing.T) {
reader, err := NewReader(resolve.NewTestResolver("testdata/docker"), false, logptest.NewTestingLogger(t, ""))
reader, err := NewReaderOptions(ReaderOptions{
RootfsMountpoint: resolve.NewTestResolver("testdata/docker"),
Logger: logptest.NewTestingLogger(t, ""),
})
if err != nil {
t.Fatalf("error in NewReader: %s", err)
}
Expand All @@ -233,7 +242,10 @@ func TestMountpointsV2(t *testing.T) {
[]byte(pidFmt), 0o744)
require.NoError(t, err)

reader, err := NewReader(resolve.NewTestResolver("testdata/docker2"), false, logptest.NewTestingLogger(t, ""))
reader, err := NewReaderOptions(ReaderOptions{
RootfsMountpoint: resolve.NewTestResolver("testdata/docker2"),
Logger: logptest.NewTestingLogger(t, ""),
})
require.NoError(t, err)

stats, err := reader.GetStatsForPid(2233801)
Expand Down
Loading