2015-12-06 22:33:47 +01:00
// Copyright 2015 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.
// +build !nosystemd
package collector
import (
"fmt"
2016-08-16 08:39:49 +02:00
"regexp"
2015-12-06 22:33:47 +01:00
"github.com/coreos/go-systemd/dbus"
"github.com/prometheus/client_golang/prometheus"
2016-08-16 08:39:49 +02:00
"github.com/prometheus/common/log"
2017-08-12 15:07:24 +02:00
"gopkg.in/alecthomas/kingpin.v2"
2016-08-16 08:39:49 +02:00
)
var (
2017-08-12 15:07:24 +02:00
unitWhitelist = kingpin . Flag ( "collector.systemd.unit-whitelist" , "Regexp of systemd units to whitelist. Units must both match whitelist and not match blacklist to be included." ) . Default ( ".+" ) . String ( )
unitBlacklist = kingpin . Flag ( "collector.systemd.unit-blacklist" , "Regexp of systemd units to blacklist. Units must both match whitelist and not match blacklist to be included." ) . Default ( ".+\\.scope" ) . String ( )
systemdPrivate = kingpin . Flag ( "collector.systemd.private" , "Establish a private, direct connection to systemd without dbus." ) . Bool ( )
2015-12-06 22:33:47 +01:00
)
type systemdCollector struct {
2016-08-16 08:39:49 +02:00
unitDesc * prometheus . Desc
systemRunningDesc * prometheus . Desc
2018-01-04 11:49:36 +01:00
summaryDesc * prometheus . Desc
2016-08-16 08:39:49 +02:00
unitWhitelistPattern * regexp . Regexp
unitBlacklistPattern * regexp . Regexp
2015-12-06 22:33:47 +01:00
}
var unitStatesName = [ ] string { "active" , "activating" , "deactivating" , "inactive" , "failed" }
func init ( ) {
2017-09-28 15:06:26 +02:00
registerCollector ( "systemd" , defaultDisabled , NewSystemdCollector )
2015-12-06 22:33:47 +01:00
}
2017-02-28 17:44:53 +01:00
// NewSystemdCollector returns a new Collector exposing systemd statistics.
2015-12-06 22:33:47 +01:00
func NewSystemdCollector ( ) ( Collector , error ) {
2015-12-17 19:30:35 +01:00
const subsystem = "systemd"
2015-12-06 22:33:47 +01:00
unitDesc := prometheus . NewDesc (
2017-09-28 15:06:26 +02:00
prometheus . BuildFQName ( namespace , subsystem , "unit_state" ) ,
2015-12-06 22:33:47 +01:00
"Systemd unit" , [ ] string { "name" , "state" } , nil ,
)
2015-12-17 19:30:35 +01:00
systemRunningDesc := prometheus . NewDesc (
2017-09-28 15:06:26 +02:00
prometheus . BuildFQName ( namespace , subsystem , "system_running" ) ,
2015-12-17 19:30:35 +01:00
"Whether the system is operational (see 'systemctl is-system-running')" ,
nil , nil ,
)
2018-01-04 11:49:36 +01:00
summaryDesc := prometheus . NewDesc (
prometheus . BuildFQName ( namespace , subsystem , "units" ) ,
"Summary of systemd unit states" , [ ] string { "state" } , nil )
2016-08-16 08:39:49 +02:00
unitWhitelistPattern := regexp . MustCompile ( fmt . Sprintf ( "^(?:%s)$" , * unitWhitelist ) )
unitBlacklistPattern := regexp . MustCompile ( fmt . Sprintf ( "^(?:%s)$" , * unitBlacklist ) )
2015-12-06 22:33:47 +01:00
return & systemdCollector {
2016-08-16 08:39:49 +02:00
unitDesc : unitDesc ,
systemRunningDesc : systemRunningDesc ,
2018-01-04 11:49:36 +01:00
summaryDesc : summaryDesc ,
2016-08-16 08:39:49 +02:00
unitWhitelistPattern : unitWhitelistPattern ,
unitBlacklistPattern : unitBlacklistPattern ,
2015-12-06 22:33:47 +01:00
} , nil
}
2017-02-28 19:47:20 +01:00
func ( c * systemdCollector ) Update ( ch chan <- prometheus . Metric ) error {
2018-01-04 11:49:36 +01:00
allUnits , err := c . getAllUnits ( )
2015-12-06 22:33:47 +01:00
if err != nil {
2018-01-04 11:49:36 +01:00
return fmt . Errorf ( "couldn't get units: %s" , err )
2015-12-06 22:33:47 +01:00
}
2018-01-04 11:49:36 +01:00
summary := summarizeUnits ( allUnits )
c . collectSummaryMetrics ( ch , summary )
units := filterUnits ( allUnits , c . unitWhitelistPattern , c . unitBlacklistPattern )
2015-12-17 19:30:35 +01:00
c . collectUnitStatusMetrics ( ch , units )
2015-12-06 22:33:47 +01:00
2015-12-17 19:30:35 +01:00
systemState , err := c . getSystemState ( )
if err != nil {
return fmt . Errorf ( "couldn't get system state: %s" , err )
}
c . collectSystemState ( ch , systemState )
2015-12-06 22:33:47 +01:00
return nil
}
2015-12-17 19:30:35 +01:00
func ( c * systemdCollector ) collectUnitStatusMetrics ( ch chan <- prometheus . Metric , units [ ] dbus . UnitStatus ) {
2015-12-06 22:33:47 +01:00
for _ , unit := range units {
for _ , stateName := range unitStatesName {
isActive := 0.0
if stateName == unit . ActiveState {
isActive = 1.0
}
ch <- prometheus . MustNewConstMetric (
c . unitDesc , prometheus . GaugeValue , isActive ,
unit . Name , stateName )
}
}
}
2018-01-04 11:49:36 +01:00
func ( c * systemdCollector ) collectSummaryMetrics ( ch chan <- prometheus . Metric , summary map [ string ] float64 ) {
for stateName , count := range summary {
ch <- prometheus . MustNewConstMetric (
c . summaryDesc , prometheus . GaugeValue , count , stateName )
}
}
2015-12-17 19:30:35 +01:00
func ( c * systemdCollector ) collectSystemState ( ch chan <- prometheus . Metric , systemState string ) {
isSystemRunning := 0.0
if systemState == ` "running" ` {
isSystemRunning = 1.0
}
ch <- prometheus . MustNewConstMetric ( c . systemRunningDesc , prometheus . GaugeValue , isSystemRunning )
}
2016-03-29 16:19:47 +02:00
func ( c * systemdCollector ) newDbus ( ) ( * dbus . Conn , error ) {
if * systemdPrivate {
return dbus . NewSystemdConnection ( )
}
return dbus . New ( )
}
2018-01-04 11:49:36 +01:00
func ( c * systemdCollector ) getAllUnits ( ) ( [ ] dbus . UnitStatus , error ) {
2016-03-29 16:19:47 +02:00
conn , err := c . newDbus ( )
2015-12-06 22:33:47 +01:00
if err != nil {
return nil , fmt . Errorf ( "couldn't get dbus connection: %s" , err )
}
2016-08-16 08:39:49 +02:00
allUnits , err := conn . ListUnits ( )
2015-12-06 22:33:47 +01:00
conn . Close ( )
2016-08-16 08:39:49 +02:00
if err != nil {
return [ ] dbus . UnitStatus { } , err
}
2018-01-04 11:49:36 +01:00
return allUnits , nil
}
func summarizeUnits ( units [ ] dbus . UnitStatus ) map [ string ] float64 {
summarized := make ( map [ string ] float64 )
for _ , unitStateName := range unitStatesName {
summarized [ unitStateName ] = 0.0
}
for _ , unit := range units {
summarized [ unit . ActiveState ] += 1.0
}
return summarized
2016-08-16 08:39:49 +02:00
}
func filterUnits ( units [ ] dbus . UnitStatus , whitelistPattern , blacklistPattern * regexp . Regexp ) [ ] dbus . UnitStatus {
filtered := make ( [ ] dbus . UnitStatus , 0 , len ( units ) )
for _ , unit := range units {
if whitelistPattern . MatchString ( unit . Name ) && ! blacklistPattern . MatchString ( unit . Name ) {
filtered = append ( filtered , unit )
} else {
log . Debugf ( "Ignoring unit: %s" , unit . Name )
}
}
return filtered
2015-12-06 22:33:47 +01:00
}
2015-12-17 19:30:35 +01:00
func ( c * systemdCollector ) getSystemState ( ) ( state string , err error ) {
2016-03-29 16:19:47 +02:00
conn , err := c . newDbus ( )
2015-12-17 19:30:35 +01:00
if err != nil {
return "" , fmt . Errorf ( "couldn't get dbus connection: %s" , err )
}
state , err = conn . GetManagerProperty ( "SystemState" )
conn . Close ( )
return state , err
}