report sys metrics

app.go

@@ -315,6 +315,11 @@ func initSysRemotes() {
 	)
 }
 
+func periodicMetrics() {
+	period := app.config.GetDuration("pitaya.metrics.periodicMetrics.period")
+	go metrics.ReportSysMetrics(app.metricsReporters, period)
+}
+
 // Start starts the app
 func Start() {
 	if !app.configured {
@@ -396,6 +401,8 @@ func Start() {
 		app.metricsReporters,
 	)
 
+	periodicMetrics()
+
 	listen()
 
 	defer func() {

config/config.go

@@ -94,6 +94,7 @@ func (c *Config) fillDefaultValues() {
 		"pitaya.metrics.prometheus.port":                        9090,
 		"pitaya.metrics.prometheus.enabled":                     false,
 		"pitaya.metrics.tags":                                   map[string]string{},
+		"pitaya.metrics.periodicMetrics.period":                 "15s",
 		"pitaya.defaultpipelines.structvalidation.enabled":      false,
 	}
 

docs/configuration.rst

@@ -180,6 +180,10 @@ Metrics Reporting
     - map[string]string{}
     - map[string]string
     - Tags to be added to reported metrics
+  * - pitaya.metrics.periodicMetrics.period
+    - 15s
+    - string
+    - Period that system metrics will be reported
 
 Concurrency
 ===========

metrics/constants.go

@@ -13,4 +13,10 @@ var (
 	DroppedMessages = "dropped_messages"
 	// ProcessDelay reports the message processing delay to handle the messages at the handler service
 	ProcessDelay = "handler_delay_ns"
+	// Goroutines reports the number of goroutines
+	Goroutines = "goroutines"
+	// HeapSize reports the size of heap
+	HeapSize = "heapsize"
+	// HeapObjects reports the number of allocated heap objects
+	HeapObjects = "heapobjects"
 )

metrics/prometheus_reporter.go

@@ -119,6 +119,39 @@ func (p *PrometheusReporter) registerMetrics(constLabels map[string]string) {
 		[]string{},
 	)
 
+	p.gaugeReportersMap[Goroutines] = prometheus.NewGaugeVec(
+		prometheus.GaugeOpts{
+			Namespace:   "pitaya",
+			Subsystem:   "sys",
+			Name:        Goroutines,
+			Help:        "the current number of goroutines",
+			ConstLabels: constLabels,
+		},
+		[]string{},
+	)
+
+	p.gaugeReportersMap[HeapSize] = prometheus.NewGaugeVec(
+		prometheus.GaugeOpts{
+			Namespace:   "pitaya",
+			Subsystem:   "sys",
+			Name:        HeapSize,
+			Help:        "the current heap size",
+			ConstLabels: constLabels,
+		},
+		[]string{},
+	)
+
+	p.gaugeReportersMap[HeapObjects] = prometheus.NewGaugeVec(
+		prometheus.GaugeOpts{
+			Namespace:   "pitaya",
+			Subsystem:   "sys",
+			Name:        HeapObjects,
+			Help:        "the current number of allocated heap objects",
+			ConstLabels: constLabels,
+		},
+		[]string{},
+	)
+
 	toRegister := make([]prometheus.Collector, 0)
 	for _, c := range p.countReportersMap {
 		toRegister = append(toRegister, c)

metrics/report.go

@@ -22,6 +22,7 @@ package metrics
 
 import (
 	"context"
+	"runtime"
 	"time"
 
 	"github.com/topfreegames/pitaya/constants"
@@ -71,3 +72,20 @@ func ReportNumberOfConnectedClients(reporters []Reporter, number int64) {
 		r.ReportGauge(ConnectedClients, map[string]string{}, float64(number))
 	}
 }
+
+// ReportSysMetrics reports sys metrics
+func ReportSysMetrics(reporters []Reporter, period time.Duration) {
+	for {
+		for _, r := range reporters {
+			num := runtime.NumGoroutine()
+			m := &runtime.MemStats{}
+			runtime.ReadMemStats(m)
+
+			r.ReportGauge(Goroutines, map[string]string{}, float64(num))
+			r.ReportGauge(HeapSize, map[string]string{}, float64(m.Alloc))
+			r.ReportGauge(HeapObjects, map[string]string{}, float64(m.HeapObjects))
+		}
+
+		time.Sleep(period)
+	}
+}