Merge pull request #28 from k1LoW/group_count

Add default metrics `grouped_process_num_grouped` ( Number of grouped )

Author: k1LoW

README.md

@@ -32,6 +32,7 @@ For example, by setting `--group.exclude='user.\slice'`, the exporter excludes t
 | Name | Type | Description |
 | --- | --- | --- |
 | grouped_process_num_procs | Gauge | Number of processes in the group |
+| grouped_process_num_grouped | Gauge | Number of grouped |
 
 ### Grouped /proc/[PID]/stat ( `--collector.stat` )
 

grouped_proc/grouped_proc.go

@@ -40,6 +40,20 @@ func NewGroupedProc(enabled map[metric.MetricKey]bool) *GroupedProc {
 	return &g
 }
 
+func (g *GroupedProc) Collect(key string) error {
+	for _, k := range metric.MetricKeys {
+		if g.Enabled[k] {
+			g.Lock()
+			err := g.Metrics[k].Collect(key)
+			g.Unlock()
+			if err != nil {
+				return err
+			}
+		}
+	}
+	return nil
+}
+
 func (g *GroupedProc) AppendProcAndCollect(pid int) error {
 	fs, err := procfs.NewFS(g.ProcMountPoint)
 	if err != nil {

grouper/cgroup/cgroup.go

@@ -38,8 +38,8 @@ var DefaultSubsystems = []string{
 type Cgroup struct {
 	fsPath     string
 	subsystems []string
-	nRe        *regexp.Regexp
-	eRe        *regexp.Regexp
+	nRe        *regexp.Regexp // normalize regexp
+	eRe        *regexp.Regexp // exclude regexp
 }
 
 func (c *Cgroup) Name() string {
@@ -86,8 +86,7 @@ func (c *Cgroup) Collect(gprocs *grouped_proc.GroupedProcs, enabled map[metric.M
 			if f == nil {
 				return nil
 			}
-			err = sem.Acquire(ctx, 2)
-			if err != nil {
+			if err := sem.Acquire(ctx, 2); err != nil {
 				return err
 			}
 			defer sem.Release(2)
@@ -106,7 +105,10 @@ func (c *Cgroup) Collect(gprocs *grouped_proc.GroupedProcs, enabled map[metric.M
 					cPath = matches[1]
 				}
 			}
-			if cPath != "" {
+			if cPath == "" {
+				return nil
+			}
+			{
 				f, err := os.Open(filepath.Clean(filepath.Join(path, "cgroup.procs")))
 				if err != nil {
 					_ = f.Close()
@@ -121,6 +123,9 @@ func (c *Cgroup) Collect(gprocs *grouped_proc.GroupedProcs, enabled map[metric.M
 					gproc = grouped_proc.NewGroupedProc(enabled)
 					gprocs.Store(cPath, gproc)
 				}
+				if err := gproc.Collect(cPath); err != nil {
+					return err
+				}
 				gproc.Exists = true
 				reader := bufio.NewReaderSize(f, 1028)
 				for {

grouper/proc_status_name/proc_status_name.go

@@ -14,8 +14,8 @@ import (
 )
 
 type ProcStatusName struct {
-	nRe            *regexp.Regexp
-	eRe            *regexp.Regexp
+	nRe            *regexp.Regexp // normalize regexp
+	eRe            *regexp.Regexp // exclude regexp
 	procMountPoint string
 }
 
@@ -77,6 +77,9 @@ func (g *ProcStatusName) Collect(gprocs *grouped_proc.GroupedProcs, enabled map[
 			gproc = grouped_proc.NewGroupedProc(enabled)
 			gprocs.Store(name, gproc)
 		}
+		if err := gproc.Collect(name); err != nil {
+			return err
+		}
 		gproc.Exists = true
 		wg.Add(1)
 		_ = sem.Acquire(ctx, gproc.RequiredWeight)

metric/metric.go

@@ -8,6 +8,7 @@ import (
 type Metric interface {
 	Describe() map[string]*prometheus.Desc
 	String() string
+	Collect(k string) error
 	CollectFromProc(proc procfs.Proc) error
 	PushCollected(ch chan<- prometheus.Metric, descs map[string]*prometheus.Desc, grouper string, group string) error
 	RequiredWeight() int64
@@ -16,14 +17,16 @@ type Metric interface {
 type MetricKey string
 
 var (
-	ProcProcs  MetricKey = "proc_procs"
-	ProcStat   MetricKey = "proc_stat"
-	ProcIO     MetricKey = "proc_io"
-	ProcStatus MetricKey = "proc_status"
+	ProcProcs   MetricKey = "proc_procs"
+	ProcGrouped MetricKey = "proc_grouped"
+	ProcStat    MetricKey = "proc_stat"
+	ProcIO      MetricKey = "proc_io"
+	ProcStatus  MetricKey = "proc_status"
 )
 
 var MetricKeys = []MetricKey{
 	ProcProcs,
+	ProcGrouped,
 	ProcStat,
 	ProcIO,
 	ProcStatus,
@@ -35,6 +38,9 @@ func AvairableMetrics() map[MetricKey]Metric {
 	// procs
 	metrics[ProcProcs] = NewProcProcsMetric()
 
+	// grouped
+	metrics[ProcGrouped] = NewProcGroupedMetric()
+
 	// stat
 	metrics[ProcStat] = NewProcStatMetric()
 
@@ -53,5 +59,6 @@ func DefaultEnabledMetrics() map[MetricKey]bool {
 		enabled[k] = false
 	}
 	enabled[ProcProcs] = true
+	enabled[ProcGrouped] = true
 	return enabled
 }

metric/proc_grouped.go

@@ -0,0 +1,60 @@
+package metric
+
+import (
+	"sync"
+
+	"github.com/prometheus/client_golang/prometheus"
+	"github.com/prometheus/procfs"
+)
+
+// ProcGroupedMetric is metric
+type ProcGroupedMetric struct {
+	sync.Mutex
+	count float64
+}
+
+func (m *ProcGroupedMetric) Describe() map[string]*prometheus.Desc {
+	descs := map[string]*prometheus.Desc{
+		"grouped_process_num_grouped": prometheus.NewDesc(
+			"grouped_process_num_grouped",
+			"Number of grouped",
+			[]string{"grouper", "group"}, nil,
+		),
+	}
+	return descs
+}
+
+func (m *ProcGroupedMetric) String() string {
+	return "grouped_count"
+}
+
+func (m *ProcGroupedMetric) Collect(k string) error {
+	m.Lock()
+	m.count = m.count + 1
+	m.Unlock()
+	return nil
+}
+
+func (m *ProcGroupedMetric) CollectFromProc(proc procfs.Proc) error {
+	return nil
+}
+
+func (m *ProcGroupedMetric) PushCollected(ch chan<- prometheus.Metric, descs map[string]*prometheus.Desc, grouper string, group string) error {
+	m.Lock()
+	if d, ok := descs["grouped_process_num_grouped"]; ok {
+		ch <- prometheus.MustNewConstMetric(d, prometheus.GaugeValue, m.count, grouper, group)
+	}
+	m.count = 0 // clear
+	m.Unlock()
+	return nil
+}
+
+func (m *ProcGroupedMetric) RequiredWeight() int64 {
+	return 0
+}
+
+func NewProcGroupedMetric() *ProcGroupedMetric {
+	return &ProcGroupedMetric{
+		count: 0,
+	}
+}

metric/proc_io.go

@@ -58,6 +58,10 @@ func (m *ProcIOMetric) String() string {
 	return "proc_io"
 }
 
+func (m *ProcIOMetric) Collect(k string) error {
+	return nil
+}
+
 func (m *ProcIOMetric) CollectFromProc(proc procfs.Proc) error {
 	pio, err := proc.IO()
 	if err != nil {

metric/proc_procs.go

@@ -28,6 +28,10 @@ func (m *ProcProcsMetric) String() string {
 	return "proc_count"
 }
 
+func (m *ProcProcsMetric) Collect(k string) error {
+	return nil
+}
+
 func (m *ProcProcsMetric) CollectFromProc(proc procfs.Proc) error {
 	m.Lock()
 	m.metrics[proc.PID] = struct{}{}

metric/proc_stat.go

@@ -87,6 +87,10 @@ func (m *ProcStatMetric) String() string {
 	return "proc_stat"
 }
 
+func (m *ProcStatMetric) Collect(k string) error {
+	return nil
+}
+
 func (m *ProcStatMetric) CollectFromProc(proc procfs.Proc) error {
 	stat, err := proc.Stat()
 	if err != nil {

metric/proc_status.go

@@ -118,6 +118,10 @@ func (m *ProcStatusMetric) String() string {
 	return "proc_status"
 }
 
+func (m *ProcStatusMetric) Collect(k string) error {
+	return nil
+}
+
 func (m *ProcStatusMetric) CollectFromProc(proc procfs.Proc) error {
 	status, err := proc.NewStatus()
 	if err != nil {