1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
|
// Copyright 2016 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.
//go:build !nologind
// +build !nologind
package collector
import (
"fmt"
"log/slog"
"os"
"slices"
"strconv"
"github.com/godbus/dbus/v5"
"github.com/prometheus/client_golang/prometheus"
)
const (
logindSubsystem = "logind"
dbusObject = "org.freedesktop.login1"
dbusPath = "/org/freedesktop/login1"
)
var (
// Taken from logind as of systemd v229.
// "other" is the fallback value for unknown values (in case logind gets extended in the future).
attrRemoteValues = []string{"true", "false"}
attrTypeValues = []string{"other", "unspecified", "tty", "x11", "wayland", "mir", "web"}
attrClassValues = []string{"other", "user", "greeter", "lock-screen", "background"}
sessionsDesc = prometheus.NewDesc(
prometheus.BuildFQName(namespace, logindSubsystem, "sessions"),
"Number of sessions registered in logind.", []string{"seat", "remote", "type", "class"}, nil,
)
)
type logindCollector struct {
logger *slog.Logger
}
type logindDbus struct {
conn *dbus.Conn
object dbus.BusObject
}
type logindInterface interface {
listSeats() ([]string, error)
listSessions() ([]logindSessionEntry, error)
getSession(logindSessionEntry) *logindSession
}
type logindSession struct {
seat string
remote string
sessionType string
class string
}
// Struct elements must be public for the reflection magic of godbus to work.
type logindSessionEntry struct {
SessionID string
UserID uint32
UserName string
SeatID string
SessionObjectPath dbus.ObjectPath
}
type logindSeatEntry struct {
SeatID string
SeatObjectPath dbus.ObjectPath
}
func init() {
registerCollector("logind", defaultDisabled, NewLogindCollector)
}
// NewLogindCollector returns a new Collector exposing logind statistics.
func NewLogindCollector(logger *slog.Logger) (Collector, error) {
return &logindCollector{logger}, nil
}
func (lc *logindCollector) Update(ch chan<- prometheus.Metric) error {
c, err := newDbus()
if err != nil {
return fmt.Errorf("unable to connect to dbus: %w", err)
}
defer c.conn.Close()
return collectMetrics(ch, c)
}
func collectMetrics(ch chan<- prometheus.Metric, c logindInterface) error {
seats, err := c.listSeats()
if err != nil {
return fmt.Errorf("unable to get seats: %w", err)
}
sessionList, err := c.listSessions()
if err != nil {
return fmt.Errorf("unable to get sessions: %w", err)
}
sessions := make(map[logindSession]float64)
for _, s := range sessionList {
session := c.getSession(s)
if session != nil {
sessions[*session]++
}
}
for _, remote := range attrRemoteValues {
for _, sessionType := range attrTypeValues {
for _, class := range attrClassValues {
for _, seat := range seats {
count := sessions[logindSession{seat, remote, sessionType, class}]
ch <- prometheus.MustNewConstMetric(
sessionsDesc, prometheus.GaugeValue, count,
seat, remote, sessionType, class)
}
}
}
}
return nil
}
func knownStringOrOther(value string, known []string) string {
if slices.Contains(known, value) {
return value
}
return "other"
}
func newDbus() (*logindDbus, error) {
conn, err := dbus.SystemBusPrivate()
if err != nil {
return nil, err
}
methods := []dbus.Auth{dbus.AuthExternal(strconv.Itoa(os.Getuid()))}
err = conn.Auth(methods)
if err != nil {
conn.Close()
return nil, err
}
err = conn.Hello()
if err != nil {
conn.Close()
return nil, err
}
object := conn.Object(dbusObject, dbus.ObjectPath(dbusPath))
return &logindDbus{
conn: conn,
object: object,
}, nil
}
func (c *logindDbus) listSeats() ([]string, error) {
var result [][]any
err := c.object.Call(dbusObject+".Manager.ListSeats", 0).Store(&result)
if err != nil {
return nil, err
}
resultInterface := make([]any, len(result))
for i := range result {
resultInterface[i] = result[i]
}
seats := make([]logindSeatEntry, len(result))
seatsInterface := make([]any, len(seats))
for i := range seats {
seatsInterface[i] = &seats[i]
}
err = dbus.Store(resultInterface, seatsInterface...)
if err != nil {
return nil, err
}
ret := make([]string, len(seats)+1)
for i := range seats {
ret[i] = seats[i].SeatID
}
// Always add the empty seat, which is used for remote sessions like SSH
ret[len(seats)] = ""
return ret, nil
}
func (c *logindDbus) listSessions() ([]logindSessionEntry, error) {
var result [][]any
err := c.object.Call(dbusObject+".Manager.ListSessions", 0).Store(&result)
if err != nil {
return nil, err
}
resultInterface := make([]any, len(result))
for i := range result {
resultInterface[i] = result[i]
}
sessions := make([]logindSessionEntry, len(result))
sessionsInterface := make([]any, len(sessions))
for i := range sessions {
sessionsInterface[i] = &sessions[i]
}
err = dbus.Store(resultInterface, sessionsInterface...)
if err != nil {
return nil, err
}
return sessions, nil
}
func (c *logindDbus) getSession(session logindSessionEntry) *logindSession {
object := c.conn.Object(dbusObject, session.SessionObjectPath)
remote, err := object.GetProperty(dbusObject + ".Session.Remote")
if err != nil {
return nil
}
sessionType, err := object.GetProperty(dbusObject + ".Session.Type")
if err != nil {
return nil
}
sessionTypeStr, ok := sessionType.Value().(string)
if !ok {
return nil
}
class, err := object.GetProperty(dbusObject + ".Session.Class")
if err != nil {
return nil
}
classStr, ok := class.Value().(string)
if !ok {
return nil
}
return &logindSession{
seat: session.SeatID,
remote: remote.String(),
sessionType: knownStringOrOther(sessionTypeStr, attrTypeValues),
class: knownStringOrOther(classStr, attrClassValues),
}
}
|