-
Notifications
You must be signed in to change notification settings - Fork 1.9k
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 periodic cgroup fingerprinter #712
Changes from 3 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,82 @@ | ||
package fingerprint | ||
|
||
import ( | ||
"fmt" | ||
"log" | ||
"time" | ||
|
||
client "github.com/hashicorp/nomad/client/config" | ||
"github.com/hashicorp/nomad/nomad/structs" | ||
) | ||
|
||
const ( | ||
cgroupAvailable = "available" | ||
cgroupUnavailable = "unavailable" | ||
) | ||
|
||
type CGroupFingerprint struct { | ||
logger *log.Logger | ||
lastState string | ||
mountPointDetector MountPointDetector | ||
} | ||
|
||
// An interface to isolate calls to the cgroup library | ||
// This facilitates testing where we can implement | ||
// fake mount points to test various code paths | ||
type MountPointDetector interface { | ||
MountPoint() (string, error) | ||
} | ||
|
||
// Implements the interface detector which calls the cgroups library directly | ||
type DefaultMountPointDetector struct { | ||
} | ||
|
||
// Call out to the default cgroup library | ||
func (b *DefaultMountPointDetector) MountPoint() (string, error) { | ||
return FindCgroupMountpointDir() | ||
} | ||
|
||
func NewCGroupFingerprint(logger *log.Logger) Fingerprint { | ||
f := &CGroupFingerprint{ | ||
logger: logger, | ||
lastState: cgroupUnavailable, | ||
mountPointDetector: &DefaultMountPointDetector{}, | ||
} | ||
return f | ||
} | ||
|
||
func (f *CGroupFingerprint) Fingerprint(cfg *client.Config, node *structs.Node) (bool, error) { | ||
// Try to find a valid cgroup mount point | ||
mount, err := f.mountPointDetector.MountPoint() | ||
if err != nil { | ||
return false, fmt.Errorf("Failed to discover cgroup mount point: %s", err) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Clear the attribute in the error case? |
||
} | ||
|
||
// Check if a cgroup mount point was found | ||
if mount == "" { | ||
// Clear any attributes from the previous fingerprint. | ||
f.clearCGroupAttributes(node) | ||
|
||
if f.lastState == cgroupAvailable { | ||
f.logger.Printf("[INFO] fingerprint.cgroups: cgroups are unavailable") | ||
} | ||
f.lastState = cgroupUnavailable | ||
return true, nil | ||
} | ||
|
||
node.Attributes["cgroup.mountpoint"] = mount | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you make the attribute |
||
|
||
if f.lastState == cgroupUnavailable { | ||
f.logger.Printf("[INFO] fingerprint.cgroups: cgroups are available") | ||
} | ||
f.lastState = cgroupAvailable | ||
return true, nil | ||
} | ||
|
||
func (f *CGroupFingerprint) clearCGroupAttributes(n *structs.Node) { | ||
delete(n.Attributes, "cgroup.mountpoint") | ||
} | ||
|
||
func (f *CGroupFingerprint) Periodic() (bool, time.Duration) { | ||
return true, 15 * time.Second | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
// +build linux | ||
|
||
package fingerprint | ||
|
||
import ( | ||
"github.com/opencontainers/runc/libcontainer/cgroups" | ||
) | ||
|
||
func FindCgroupMountpointDir() (string, error) { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Add comment to all the methods |
||
mount, err := cgroups.FindCgroupMountpointDir() | ||
if err != nil { | ||
switch e := err.(type) { | ||
case *cgroups.NotFoundError: | ||
// It's okay if the mount point is not discovered | ||
return "", nil | ||
default: | ||
// All other errors are passed back as is | ||
return "", e | ||
} | ||
} | ||
return mount, nil | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,100 @@ | ||
package fingerprint | ||
|
||
import ( | ||
"fmt" | ||
"testing" | ||
|
||
"github.com/hashicorp/nomad/client/config" | ||
"github.com/hashicorp/nomad/nomad/structs" | ||
) | ||
|
||
// A fake mount point detector that returns an empty path | ||
type MountPointDetectorNoMountPoint struct{} | ||
|
||
func (m *MountPointDetectorNoMountPoint) MountPoint() (string, error) { | ||
return "", nil | ||
} | ||
|
||
// A fake mount point detector that returns an error | ||
type MountPointDetectorMountPointFail struct{} | ||
|
||
func (m *MountPointDetectorMountPointFail) MountPoint() (string, error) { | ||
return "", fmt.Errorf("cgroup mountpoint discovery failed") | ||
} | ||
|
||
// A fake mount point detector that returns a valid path | ||
type MountPointDetectorValidMountPoint struct{} | ||
|
||
func (m *MountPointDetectorValidMountPoint) MountPoint() (string, error) { | ||
return "/sys/fs/cgroup", nil | ||
} | ||
|
||
// A fake mount point detector that returns an empty path | ||
type MountPointDetectorEmptyMountPoint struct{} | ||
|
||
func (m *MountPointDetectorEmptyMountPoint) MountPoint() (string, error) { | ||
return "", nil | ||
} | ||
|
||
func TestCGroupFingerprint(t *testing.T) { | ||
f := &CGroupFingerprint{ | ||
logger: testLogger(), | ||
lastState: cgroupUnavailable, | ||
mountPointDetector: &MountPointDetectorMountPointFail{}, | ||
} | ||
|
||
node := &structs.Node{ | ||
Attributes: make(map[string]string), | ||
} | ||
|
||
ok, err := f.Fingerprint(&config.Config{}, node) | ||
if err == nil { | ||
t.Fatalf("expected an error") | ||
} | ||
if ok { | ||
t.Fatalf("should not apply") | ||
} | ||
if a, ok := node.Attributes["cgroup.mountpoint"]; ok { | ||
t.Fatalf("unexpected attribute found, %s", a) | ||
} | ||
|
||
f = &CGroupFingerprint{ | ||
logger: testLogger(), | ||
lastState: cgroupUnavailable, | ||
mountPointDetector: &MountPointDetectorValidMountPoint{}, | ||
} | ||
|
||
node = &structs.Node{ | ||
Attributes: make(map[string]string), | ||
} | ||
|
||
ok, err = f.Fingerprint(&config.Config{}, node) | ||
if err != nil { | ||
t.Fatalf("unexpected error, %s", err) | ||
} | ||
if !ok { | ||
t.Fatalf("should apply") | ||
} | ||
assertNodeAttributeContains(t, node, "cgroup.mountpoint") | ||
|
||
f = &CGroupFingerprint{ | ||
logger: testLogger(), | ||
lastState: cgroupUnavailable, | ||
mountPointDetector: &MountPointDetectorEmptyMountPoint{}, | ||
} | ||
|
||
node = &structs.Node{ | ||
Attributes: make(map[string]string), | ||
} | ||
|
||
ok, err = f.Fingerprint(&config.Config{}, node) | ||
if err != nil { | ||
t.Fatalf("unexpected error, %s", err) | ||
} | ||
if !ok { | ||
t.Fatalf("should apply") | ||
} | ||
if a, ok := node.Attributes["cgroup.mountpoint"]; ok { | ||
t.Fatalf("unexpected attribute found, %s", a) | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
// +build !linux | ||
|
||
package fingerprint | ||
|
||
// cgroups only exist on Linux | ||
func FindCgroupMountpointDir() (string, error) { | ||
return "", nil | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -16,6 +16,7 @@ const EmptyDuration = time.Duration(0) | |
// fingerprints available, to provided an ordered iteration | ||
var BuiltinFingerprints = []string{ | ||
"arch", | ||
"cgroup", | ||
"consul", | ||
"cpu", | ||
"env_aws", | ||
|
@@ -30,6 +31,7 @@ var BuiltinFingerprints = []string{ | |
// which are available, corresponding to a key found in BuiltinFingerprints | ||
var builtinFingerprintMap = map[string]Factory{ | ||
"arch": NewArchFingerprint, | ||
"cgroup": NewCGroupFingerprint, | ||
"consul": NewConsulFingerprint, | ||
"cpu": NewCPUFingerprint, | ||
"env_aws": NewEnvAWSFingerprint, | ||
|
@@ -41,6 +43,7 @@ var builtinFingerprintMap = map[string]Factory{ | |
} | ||
|
||
// NewFingerprint is used to instantiate and return a new fingerprint | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Accidental new line? |
||
|
||
// given the name and a logger | ||
func NewFingerprint(name string, logger *log.Logger) (Fingerprint, error) { | ||
// Lookup the factory function | ||
|
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.
Extract 15 in a constant.