Skip to content

UNICORN Monitoring API Service

Jump to bottom Edit New page
Oliver Zehentleitner edited this page Jul 5, 2019 · 25 revisions

Description

With binance_websocket_api_manager.start_monitoring_api() you can start a restful API service to report the status of the UNICORN Binance WebSocket API Manager to a monitoring system inclusive performance metrics.

The ICINGA/Nagios check_command 'check_unicorn_monitoring_api' for the UNICORN Monitoring Rest API can connect to this restful API, collect the data and deliver it to the ICINGA/Nagios system.

Read the Howto: Monitoring UNICORN Binance WebSocket API Manager with ICINGA2 to learn, how you can connect your application with ICINGA2.

Technical

Status

OK, WARNING, CRITICAL or UNKOWN

  • WARNING: on restarts, available updates (UNICORN Binance WebSocket API and UnicornFy)
  • CRITICAL: crashed streams
  • UNKOWN: the check_command is not able to connect to the monitoring API services

Perfdata

  • average receives per second since last status check
  • average speed per second since last status check
  • total received bytes since start
  • total received length since start
  • stream_buffer length
  • stream_buffer items
  • reconnects
  • uptime

icinga2-demo

Parameter

Use binance_websocket_api_manager.start_monitoring_api(warn_on_update=False) to disable the WARNING status on available updates.

UNICORN Binance WebSocket API and all other tools of the UNICORN Binance Suite are open source projects which welcomes contributions which can be anything from simple documentation fixes and reporting dead links to new features. To contribute follow this guide.

Add a custom sidebar
Clone this wiki locally