Skip to main content

ServiceRadar Introduction

ServiceRadar is a distributed network monitoring system designed for infrastructure and services in hard-to-reach places or constrained environments. It provides real-time monitoring of internal services with cloud-based alerting capabilities, ensuring you stay informed even during network or power outages.

What is ServiceRadar?​

ServiceRadar offers:

  • Real-time monitoring of internal services
  • Cloud-based alerting capabilities
  • Continuous monitoring during network or power outages
  • Distributed architecture for scalability and reliability
  • SNMP integration for network device monitoring
  • Specialized monitoring for specific node types (e.g., Dusk Network)
  • Secure communication with mTLS support
  • Modern web UI with dashboard visualization
  • User authentication with local login support
  • JWT-based session management
  • KV Store for dynamic configuration
  • External system integration via Sync service
  • API key authentication for internal communications
What you'll need
  • Linux-based system (Ubuntu/Debian recommended)
  • Root or sudo access
  • Basic understanding of network services
  • Target services to monitor

Key Components​

ServiceRadar consists of several main components:

  1. Agent - Runs on monitored hosts, provides service status through gRPC
  2. Poller - Coordinates monitoring activities, can run anywhere in your network
  3. Core Service - Receives reports from pollers, provides API, and sends alerts
  4. Web UI - Provides a modern dashboard interface with Nginx as a reverse proxy
  5. KV Store - Provides dynamic configuration capabilities using NATS JetStream
  6. Sync Service - Integrates with external inventory and security systems

For a detailed explanation of the architecture, please see the Architecture page.

Security Features​

ServiceRadar is designed with security in mind:

  1. mTLS Authentication - Secure communication between components using mutual TLS
  2. User Authentication - Local user login with bcrypt password hashing
  3. JWT Session Management - Secure, expirable tokens for web sessions
  4. API Key Authentication - Secure API access for the web interface
  5. Role-Based Access - Different components have different security roles
  6. CORS Configuration - Control which domains can access your API
  7. Nginx Reverse Proxy - Secure web access with configurable firewall rules

For more details, see the TLS Security and Authentication Configuration documentation.

Getting Started​

Navigate through our documentation to get ServiceRadar up and running:

  1. Installation Guide - Install ServiceRadar components
  2. Configuration Basics - Configure your ServiceRadar deployment
  3. TLS Security - Secure your ServiceRadar communications
  4. Authentication Configuration - Set up user authentication
  5. Web UI Configuration - Set up the web interface and dashboard
  6. KV Store Configuration - Configure dynamic configuration store
  7. Sync Service Configuration - Integrate with external systems
  8. Architecture - Understand the system architecture
  9. Custom Checkers - Create custom checkers for specific services

Or jump straight to the Installation Guide to get started with ServiceRadar.