nemo
/
prometheus-act-exporter
mirror of https://github.com/captn3m0/prometheus-act-exporter.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
99 Commits 2 Branches 23 Tags 590 KiB
JavaScript 88.8%
Shell 6.6%
Dockerfile 4.6%
Go to file
dependabot[bot] b1a0e117df Bump puppeteer-core from 10.2.0 to 10.4.0 
Bumps [puppeteer-core](https://github.com/puppeteer/puppeteer) from 10.2.0 to 10.4.0.
- [Release notes](https://github.com/puppeteer/puppeteer/releases)
- [Changelog](https://github.com/puppeteer/puppeteer/blob/main/CHANGELOG.md)
- [Commits](https://github.com/puppeteer/puppeteer/compare/v10.2.0...v10.4.0)

---
updated-dependencies:
- dependency-name: puppeteer-core
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
 		2021-09-28 12:22:14 +05:30
.github Update dependabot.yml 2021-07-03 22:28:18 +05:30
hooks Update Dockerfile to include labels 2018-07-01 03:24:35 +05:30
.dockerignore Prepare for npm publish 2018-06-04 13:23:04 +05:30
.editorconfig [deps] Bumps puppeteer to 1.8 2019-03-14 08:07:19 +05:30
.gitignore Initial commit 2018-06-03 02:07:29 +05:30
.npmignore Prepare for npm publish 2018-06-04 13:23:04 +05:30
CHANGELOG.md Version Bump 2021-08-12 10:11:24 +05:30
COPYING Updates LICENSE date 2019-06-21 01:41:48 +05:30
Dockerfile Version Bump 2021-08-12 10:11:24 +05:30
METRICS.md Adds documentation and drops `usage` from total_bytes metrics 2018-07-01 03:13:48 +05:30
README.md [docs] Improve README 2021-08-12 10:21:55 +05:30
SECURITY.md Multiple changes for v3 2021-07-03 23:04:24 +05:30
index.js Multiple changes for v3 2021-07-03 23:04:24 +05:30
package-lock.json Bump puppeteer-core from 10.2.0 to 10.4.0 2021-09-28 12:22:14 +05:30
package.json Version Bump 2021-08-12 10:11:24 +05:30
prom.js Adds documentation and drops `usage` from total_bytes metrics 2018-07-01 03:13:48 +05:30
server.js Multiple changes for v3 2021-07-03 23:04:24 +05:30

README.md

prometheus-act-exporter

Docker Image Version (latest semver) Docker Image Size (latest semver) npm version License: WTFPL PRs Welcome

Exposes your current ACT FUP usage as prometheus metrics. Scrapes the data from the ACT Portal website by using puppeteer. This only supports ACT Fibernet in India.

  • Supports flexibytes
  • Reports aggregate metrics as well
  • Only tested for ACT Bangalore connections.

Metrics

Sample:

# HELP act_fup_live_usage_bytes ACT live usage in bytes (precision GB)
# TYPE act_fup_live_usage_bytes gauge
act_fup_live_usage_bytes 0

# HELP act_fup_live_total_bytes ACT live usage in bytes (precision GB)
# TYPE act_fup_live_total_bytes gauge
act_fup_live_total_bytes 800000000

# HELP act_fup_flexibytes_usage_bytes ACT flexibytes usage in bytes (precision GB)
# TYPE act_fup_flexibytes_usage_bytes gauge
act_fup_flexibytes_usage_bytes 102580000

# HELP act_fup_flexibytes_total_bytes ACT flexibytes usage in bytes (precision GB)
# TYPE act_fup_flexibytes_total_bytes gauge
act_fup_flexibytes_total_bytes 100000000

# HELP act_fup_aggregate_usage_bytes ACT aggregate usage in bytes (precision GB)
# TYPE act_fup_aggregate_usage_bytes gauge
act_fup_aggregate_usage_bytes 102580000

# HELP act_fup_aggregate_total_bytes ACT aggregate usage in bytes (precision GB)
# TYPE act_fup_aggregate_total_bytes gauge
act_fup_aggregate_total_bytes 900000000

Using as a npm package

Install it with npm i prometheus-act-exporter.

const act = require("prometheus-act-exporter");
let m = await act.getUsage();
// Returns
// {
//   live: { usedBytes: 0, totalBytes: 800000000 },
//   flexibytes: { usedBytes: 102580000, totalBytes: 100000000 },
//   aggregate: { usedBytes: 102580000, totalBytes: 900000000 }
// }
// calculations made assuming ACT is using SI GB (exactly 1 billion bytes)

Configuration

You can pass the following environment variables:

  1. PROXY_SERVER: Use a proxy server to connect to ACT. Use a socks5 proxy, since ACT returns a 403 if you try to use a CONNECT proxy. export PROXY_SERVER="socks5://10.8.0.14:1080"
  2. CHROME_BIN: Set Chrome/Chromium executable path. Helpful if you have chromium already installed and don't want puppeteer to download it again. You can set PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=1 before running npm install to disable puppeteer's chromium download.
  3. DISABLE_HEADLESS: If set, chrome will not launch in headless mode.

Usage

Docker

If running via Docker, here are some simple cookbook configurations:

docker run -it -p 3000:3000 -e captn3m0/prometheus-act-exporter

Run a simple test server locally in debug mode and test it on http://localhost:3000/metrics

LICENSE

This is licensed under WTFPL. See COPYING file for the full text.