Monobank Exporter

This application exports Prometheus metrics for Monobank.

Full API documentation can be found here: Monobank open API

Functionality

Publish currencies metrics
Publish a client's balance and credit limit for each card as metrics
You can use your name differently from that stored in the bank
basic auth to the metrics endpoint

API limitations:

You can receive information about a client once per a minute
Information about currencies refreshes once per 5 minutes

Quickstart:

Create a docker-compose file
fill in a config file
setup your Prometheus instance to scrape metrics
run docker-compose up -d

Metrics

Metric name	Description
monobank_balance	Show the current balance for each card
monobank_jars	Show current list of jars
monobank_credit_limit	Show the current credit limit for each card
monobank_currencies_buy	Shows currencies rate for buy
monobank_currencies_sell	Shows currencies rate for sell
monobank_currencies_cross	Shows currencies rate for cross

Metrics names can be overridden in the metrics config section. You can provide any name for these metrics. Here is the example with names as default.

metrics:
  balance: "monobank_balance"
  jars: "monobank_jars"
  creditLimit: "monobank_credit_limit"
  currenciesBuy: "monobank_currencies_buy"
  currenciesSell: "monobank_currencies_sell"
  currenciesCross: "monobank_currencies_cross"

monobank-exporter usage

minimal request time for client info is 2 minutes
minimal request time for currencies info is 10 minutes
use HTTP or HTTPS for webhook only
/webhook ending is mandatory
basic auth is not required. it can be added from the config

Currency metrics will be provisioned in any case.
The client's metrics will be provisioned only in the case of the existing token.
Webhook will be set only in case of a valid URL (HTTP or HTTPS doesn't matter).

Logs

logs are shown at the console and written to file /etc/monobank-exporter/logs/monobank-exporter.log
Serilog is used as a logger. Settings are defined in the /etc/monobank-exporter/appsettings.json file. You can override these settings.
Documentation can be found here: Serilog.Settings.Configuration

Examples

Docker-compose with the image from Docker Hub

version: '3.1'

services:
  exporter:
    image: thegarmr/monobank-exporter:latest
    container_name: monobank-exporter
    restart: always
    volumes:
      - ./monobank-exporter.yml:/etc/monobank-exporter/monobank-exporter.yml
      - ./logs:/etc/monobank-exporter/logs

Docker-compose with the image from Docker Hub with Grafana and Prometheus

You can find this example in the Example folder
Clone the repository to your local folder
git clone https://github.com/TheGarmr/monobank-exporter.git

Go to the folder with sources
cd monobank-exporter/Example

Edit monobank-exporter.yml in the root folder (you can find an example below)

Compose up!
docker-compose up -d

Docker-compose with images from sources

Clone the repository to your local folder
git clone https://github.com/TheGarmr/monobank-exporter.git

Go to the folder with sources
cd monobank-exporter