Skip to content

Latest commit

 

History

History
258 lines (157 loc) · 6.98 KB

README.md

File metadata and controls

258 lines (157 loc) · 6.98 KB
Raw

Overview

Bisq-watcher is a customizable monitoring tool for the Bisq application, built with Node.js and compatible with Windows, Linux, and macOS. It allows you to set up a watcher to monitor your Bisq application on your computer.

Bisq-watcher consists of three core components:

  • File Watcher: Monitors the main bisq log file bisq.log.
  • Log Processor: Parses and extracts relevant log data based on predefined rules.
  • Logger: Sends notifications via multiple transports, including console, file, and Telegram.

Whether you need real-time trade updates on Telegram or just want to keep an eye on the logs, bisq-watcher has you covered.

Screenshot example of console output:

Table of Contents

Installation

Prerequisites

Ensure that Bisq-watcher runs on the same computer as your Bisq application. You'll need Node.js installed.

Node.js

Repository Cloning

  • Before cloning the repository, make sure Git is installed on your system. If not, download and install it from the official Git website.

  • Clone bisq-watcher repository:

git clone https://github.com/dutu/bisq-watcher
cd bisq-watcher
  • Checkout the latest release:
git checkout v0.1.0
  • Install dependencies:
npm install

Configuration

App Configuration

  • Make a copy of the bisq-watcher.config.sample.mjs file and rename it to bisq-watcher.config.mjs.

  • Edit bisq-watcher.config.mjs to customize your watcher settings, including console logging, file logging, and Telegram integration.

    In particular, make sure: logFile specifies the correct location of the main Bisq log file bisq.log. See Bisq data directory default locations.

For advanced configurations and all available options, refer to the JSDoc comments within app.config.sample.mjs file.

Telegram Integration

To enable Telegram-based log notifications:

Getting API Token

  • Open Telegram and search for the "BotFather" bot.

  • Start a chat and use the /newbot command to create a new bot.

  • Follow BotFather's prompts to name your bot.

  • After creating the bot, you'll receive an API token. Note this token for use in bisq-watcher.config.mjs.

Getting Chat ID

  • Add your new bot to a Telegram chat or group.

  • Send a test message in the chat.

  • Replace YOUR_API_TOKEN in the following URL and open it in a web browser:

https://api.telegram.org/botYOUR_API_TOKEN/getUpdates

  • Look for the chat object in the returned JSON, your chat ID will be the value of id within that object.

Update bisq-watcher.config.mjs

  • Update bisq-watcher.config.mjs with the Telegram bot configuration:
{
  ...,
  loggerConfig: [
    ...,
    {
      type: 'telegram',
      apiToken: 'YOUR_API_TOKEN',
      chatId: 'YOUR_CHAT_ID',
      enabled: true,
      sendToTelegram: true
    }
  ]
}

Replace YOUR_API_TOKEN and YOUR_CHAT_ID with the actual values you obtained earlier.

Usage

Starting the Application

  • To run the bisq-watcher, use:
npm start

Notification Testing

By default, bisq-watcher monitors new events added to the main Bisq logfile, bisq.log. However, for testing purposes, you can enable a debug flag called atStartProcessEntireLogFile.

Setting atStartProcessEntireLogFile to true in the configuration file bisq-watcher.config.mjs will instruct bisq-watcher to process the entire bisq.log file. Notifications will be sent as the logfile is read and parsed.

This feature is useful for testing and validating notifications without waiting for new events to occur in real-time.

Running the application using Docker

  • Installing Docker
curl -sSL https://get.docker.com | sh
  • Installing docker compose
DOCKER_CONFIG=${DOCKER_CONFIG:-$HOME/.docker}
mkdir -p $DOCKER_CONFIG/cli-plugins
curl -SL https://github.com/docker/compose/releases/download/v2.20.3/docker-compose-linux-x86_64 -o $DOCKER_CONFIG/cli-plugins/docker-compose

chmod +x $DOCKER_CONFIG/cli-plugins/docker-compose
sudo chmod +x /usr/local/lib/docker/cli-plugins/docker-compose
  • Checking docker compose version:
$ docker compose version
Docker Compose version v2.20.3
  • Run the docker compose up command to start the services.
docker compose up -d
  • Checking logs
docker compose logs -f

Running the application using PM2

PM2 is a daemon process manager that helps keep your application running 24/7. PM2 can be used and configured to restart your application after unexpected machine restarts. Bisq-watcher is designed to work seamlessly with PM2.

  • Install PM2 globally:
npm install -g pm2
  • Use PM2 to start the application:
pm2 start bisq-watcher
  • View console output:
pm2 logs bisq-watcher
  • To stop the application:
pm2 stop bisq-watcher

Setting Up Multiple Watchers

If you need to monitor two Bisq instances on the same computer, follow these steps:

  • Create a second copy of bisq-watcher.config.sample.mjs and give it a different name, e.g. bisq-watcher2.config.mjs

  • Edit bisq-watcher2.config.mjs to configure the second watcher.

  • Start the second watcher:

npm start -- --config bisq-watcher2.config.mjs
  • To start the second watcher with PM2:
pm2 start bisq-watcher2.config.mjs

Contributions

Bisq-watcher is an actively developed, and contributions are welcome.

While the application is still in its early stages, it currently includes rules for trading and dispute notifications. We are continuously working on expanding the set of rules to enhance the monitoring capabilities.

If you would like to contribute by adding more rules to enable additional notifications, please consider opening an issue or submitting a pull request. You can find the rule definitions in the server/rules folder.

Versioning and Changelog

This project adheres to Semantic Versioning.

For the versions available and changes made in each version, see the Releases on this repository.