UNICORN Monitoring API Service

Description

With binance_websocket_api_manager.start_monitoring_api() you can start a restful API service (example_monitoring.py) on http://127.0.0.1:64201/status/icinga/ to report the status of the UNICORN Binance WebSocket API Manager to a monitoring system inclusive performance metrics. The check_command has the opportunity to send its version to the monitoring API via http://127.0.0.1:64201/status/icinga/0.1.0 to receive update infos.

The ICINGA/Nagios check_command 'check_lucit_collector.py' for the UNICORN Monitoring API can connect to this restful API service, 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.

Module documentation

Technical

Status

OK, WARNING, CRITICAL or UNKOWN

• WARNING:
  • restarts_last_hour_of_stream_x >= 3
  • available updates
    • UNICORN Binance WebSocket API
    • UnicornFy
    • check_lucit_collector.py'
• CRITICAL:
  • restarts_last_hour_of_stream_x >= 10
  • crashed streams
• UNKOWN: the check_command is not able to connect to the monitoring API services

Perfdata

• average_receives_per_second
• current_receiving_speed_per_second
• total_received_length
• total_received_size
• stream_buffer_size
• stream_buffer_length
• reconnects
• uptime_days

Parameter

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

Examples:

• example_monitoring.py