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 our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
add CgroupSummary to parse /proc/cgroups #424
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains 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,98 @@ | ||
// Copyright 2020 The Prometheus Authors | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
|
||
package procfs | ||
|
||
import ( | ||
"bufio" | ||
"bytes" | ||
"fmt" | ||
"strconv" | ||
"strings" | ||
|
||
"github.com/prometheus/procfs/internal/util" | ||
) | ||
|
||
// CgroupSummary models one line from /proc/cgroups. | ||
// This file contains information about the controllers that are compiled into the kernel. | ||
// | ||
// Also see http://man7.org/linux/man-pages/man7/cgroups.7.html | ||
type CgroupSummary struct { | ||
// The name of the controller. controller is also known as subsystem. | ||
SubsysName string | ||
// The unique ID of the cgroup hierarchy on which this controller is mounted. | ||
Hierarchy int | ||
// The number of control groups in this hierarchy using this controller. | ||
Cgroups int | ||
// This field contains the value 1 if this controller is enabled, or 0 if it has been disabled | ||
Enabled int | ||
} | ||
|
||
// parseCgroupSummary parses each line of the /proc/cgroup file | ||
// Line format is `subsys_name hierarchy num_cgroups enabled`. | ||
func parseCgroupSummaryString(CgroupSummaryStr string) (*CgroupSummary, error) { | ||
var err error | ||
|
||
fields := strings.Fields(CgroupSummaryStr) | ||
// require at least 4 fields | ||
if len(fields) < 4 { | ||
return nil, fmt.Errorf("at least 4 fields required, found %d fields in cgroup info string: %s", len(fields), CgroupSummaryStr) | ||
} | ||
|
||
CgroupSummary := &CgroupSummary{ | ||
SubsysName: fields[0], | ||
} | ||
CgroupSummary.Hierarchy, err = strconv.Atoi(fields[1]) | ||
if err != nil { | ||
return nil, fmt.Errorf("failed to parse hierarchy ID") | ||
} | ||
CgroupSummary.Cgroups, err = strconv.Atoi(fields[2]) | ||
if err != nil { | ||
return nil, fmt.Errorf("failed to parse Cgroup Num") | ||
} | ||
CgroupSummary.Enabled, err = strconv.Atoi(fields[3]) | ||
if err != nil { | ||
return nil, fmt.Errorf("failed to parse Enabled") | ||
} | ||
return CgroupSummary, nil | ||
} | ||
|
||
// parseCgroupSummary reads each line of the /proc/cgroup file. | ||
func parseCgroupSummary(data []byte) ([]CgroupSummary, error) { | ||
var CgroupSummarys []CgroupSummary | ||
scanner := bufio.NewScanner(bytes.NewReader(data)) | ||
for scanner.Scan() { | ||
CgroupSummaryString := scanner.Text() | ||
// ignore comment lines | ||
if strings.HasPrefix(CgroupSummaryString, "#") { | ||
continue | ||
} | ||
CgroupSummary, err := parseCgroupSummaryString(CgroupSummaryString) | ||
if err != nil { | ||
return nil, err | ||
} | ||
CgroupSummarys = append(CgroupSummarys, *CgroupSummary) | ||
} | ||
|
||
err := scanner.Err() | ||
return CgroupSummarys, err | ||
} | ||
|
||
// CgroupSummarys returns information about current /proc/cgroups. | ||
func (fs FS) CgroupSummarys() ([]CgroupSummary, error) { | ||
data, err := util.ReadFileNoStat(fs.proc.Path("cgroups")) | ||
if err != nil { | ||
return nil, err | ||
} | ||
return parseCgroupSummary(data) | ||
} |
This file contains 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,64 @@ | ||
// Copyright 2020 The Prometheus Authors | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
|
||
package procfs | ||
|
||
import ( | ||
"reflect" | ||
"testing" | ||
) | ||
|
||
func TestParseCgroupSummaryString(t *testing.T) { | ||
tests := []struct { | ||
name string | ||
s string | ||
shouldErr bool | ||
CgroupSummary *CgroupSummary | ||
}{ | ||
{ | ||
name: "cpuset simple line", | ||
s: "cpuset 7 148 1", | ||
shouldErr: false, | ||
CgroupSummary: &CgroupSummary{ | ||
SubsysName: "cpuset", | ||
Hierarchy: 7, | ||
Cgroups: 148, | ||
Enabled: 1, | ||
}, | ||
}, | ||
{ | ||
name: "memory cgroup number mis format", | ||
s: "memory 9 ## 1", | ||
shouldErr: true, | ||
CgroupSummary: nil, | ||
}, | ||
} | ||
|
||
for i, test := range tests { | ||
t.Logf("[%02d] test %q", i, test.name) | ||
|
||
CgroupSummary, err := parseCgroupSummaryString(test.s) | ||
|
||
if test.shouldErr && err == nil { | ||
t.Errorf("%s: expected an error, but none occurred", test.name) | ||
} | ||
if !test.shouldErr && err != nil { | ||
t.Errorf("%s: unexpected error: %v", test.name, err) | ||
} | ||
|
||
if want, have := test.CgroupSummary, CgroupSummary; !reflect.DeepEqual(want, have) { | ||
t.Errorf("cgroup:\nwant:\n%+v\nhave:\n%+v", want, have) | ||
} | ||
} | ||
|
||
} |
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.
Nit
// Copyright 2021 The Prometheus Authors
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.
updated