Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stfsy/prometheus-what-active-users-exporter

Prometheus exporter that scrapes currently logged in users on unix systems
https://github.com/stfsy/prometheus-what-active-users-exporter

prometheus prometheus-exporter ssh w

Last synced: about 1 month ago
JSON representation

Prometheus exporter that scrapes currently logged in users on unix systems

Host: GitHub
URL: https://github.com/stfsy/prometheus-what-active-users-exporter
Owner: stfsy
License: mit
Created: 2021-07-16T04:55:09.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-11-11T08:11:43.000Z (about 1 month ago)
Last Synced: 2024-11-11T09:21:12.923Z (about 1 month ago)
Topics: prometheus, prometheus-exporter, ssh, w
Language: JavaScript
Homepage:
Size: 2.04 MB
Stars: 33
Watchers: 3
Forks: 4
Open Issues: 2
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        # Active Users Exporter for Prometheus

[![Npm Version](https://img.shields.io/npm/v/prometheus-what-active-users-exporter.svg)](https://www.npmjs.com/package/prometheus-what-active-users-exporter)

[![Git tag](https://img.shields.io/github/tag/stfsy/prometheus-what-active-users-exporter.svg)](https://github.com/stfsy/prometheus-what-active-users-exporter/releases)

[![Github issues](https://img.shields.io/github/issues/stfsy/prometheus-what-active-users-exporter.svg)](https://github.com/stfsy/prometheus-what-active-users-exporter/issues)

[![License](https://img.shields.io/npm/l/prometheus-what-active-users-exporter.svg)](https://github.com/stfsy/prometheus-what-active-users-exporter/blob/main/LICENSE)

This is a simple server that scrapes the output of the unix command `w`. [w displays information about the users currently on the machine, and their processes. ](https://man7.org/linux/man-pages/man1/w.1.html)

**Why would you want to do that?** This exporter will allow you to monitor who logs into your system. So you can define alarms for unauthorized users, the max. amount of active session or even every active user session. **`W` will also monitor logins via SSH which allows you to track even active remote sessions.**

Currently, three metrics are created and exposed: 

- Status of the exporter: `what_up{version="x.x.x"} 1`

- Sum of session per user: `what_user_sessions_currently_active{user="demo"} 1`

- Single sessions per user: `what_each_session_currently_active{user="pip3",ip="192.168.2.107",tty="pts/0"} 1`

The exporter was tested on Ubuntu.

## Getting Started

Download the binary from the [latest release](https://github.com/stfsy/prometheus-what-active-users-exporter/releases/latest). We currently provide binaries for Linux and Alpine Linux on amd64.

To download latest Linux version and check sha256 sum:

```bash

#!/bin/bash

set -ex

declare -r owner="stfsy"

declare -r name="prometheus-what-active-users-exporter"

declare -r latest_release_url=$(curl -Ls -o /dev/null -w %{url_effective} https://github.com/${owner}/${name}/releases/latest)

declare -r latest_version=$(echo ${latest_release_url} | awk -F'/' '{print $8}')

declare -r latest_version_name=${name}-${latest_version}-linux-x64

declare -r shasum_url=https://github.com/${owner}/${name}/releases/download/${latest_version}/sha256sums.txt

declare -r binary_url=https://github.com/${owner}/${name}/releases/download/${latest_version}/${latest_version_name}

curl -L ${shasum_url} > shasums256.txt

curl -L ${binary_url} > ${latest_version_name}

declare -r hash_sum_line=$(cat shasums256.txt | grep ${latest_version_name})

declare -r hash_sum=$(echo ${hash_sum_line} | awk -F' ' '{print $1}')

echo "${hash_sum}  ${latest_version_name}" | sha256sum --check --ignore-missing 

mv ${latest_version_name} ${name}

rm shasums256.txt

```

To run it:

```bash

./prometheus-what-active-users-exporter [flags]

```

Help on flags:

```bash

./prometheus-what-active-users-exporter --help

```

## Usage

By default the exporter will start with sensible default values. Configuration can be customized with the following command line flags:

-  --listen.host: `default=127.0.0.1` 

-  --listen.port `default=127.0.0.1`

-  --metrics.endpoint `default=/metrics` 

-  --metrics.prefix `default=what`

-  --metrics.with-timestamp `default=false`

-  --scrape.interval `default=5000` 

:warning: 

There's a tradeoff between detecting every single and possibly very short login vs. putting additional load on your system by querying too often. 

By default, the exporter will query the active sessions every 5s.

**Meaning**: Login sessions that last less than 5s might no be detected by the exporter. Login sessions that last longer than 5s will be stored. 

### Building

```bash

npx pkg --compress GZip --targets node16-linux-x64,node16-alpine-x64,node16-linuxstatic-x64 lib/index.js

```

### Testing

```bash

npm test

```

### TLS and basic authentication

The W exporter does currently not support TLS and basic authentication.

## License

This project is distributed under the MIT license.