Phoenix Monitoring Platform

A flexible and configurable open-source monitoring platform integrating monitoring, alerting, and notification

Live Demo | WeChat | GitCode | Gitee | GitHub

中文 | English

📖 Table of Contents

• Introduction
• Key Features
• Feature Comparison
• System Architecture
• Tech Stack
• Project Structure
• Quick Start
• Client Integration
• Screenshots
• Technical Blog
• Live Demo
• Contributing
• License
• Contact Us
• Donate
• Star History

💡 Introduction

Phoenix is a flexible and configurable open-source monitoring platform designed for monitoring applications, servers, network devices, Docker, databases, networks, TCP ports, and HTTP interfaces. By collecting, aggregating, and analyzing monitoring data in real time, it pushes alert notifications immediately upon detecting anomalies, and provides a visual system for configuration, management, and viewing.

Open source does not mean free of restrictions. Secondary development based on Phoenix is allowed, but the logo, name, and copyright must not be modified.

🏆 G-Star Certification

Phoenix has passed the GitCode G-Star Graduation Project Certification.

✨ Key Features

• 🖥️ Full-Stack Monitoring — One-stop monitoring from applications to infrastructure, see Feature Comparison for details
• ⚡ Real-Time Alerting — Multi-channel notifications + four-level alerting mechanism (INFO/WARN/ERROR/FATAL)
• 🔧 Flexible Configuration — Flexible alert definition engine with dynamically adjustable monitoring strategies
• 🌐 Distributed Architecture — Supports cluster deployment; agents can be deployed on jump servers to bridge network barriers
• 🔒 Data Security — Supports encrypted data transmission to ensure monitoring data security
• 🐳 Containerized Deployment — One-click deployment with Docker / Docker Compose, installation completed in 10 minutes
• 📱 Multi-Platform Support — Web interface supports both desktop and mobile devices
• 🔄 Dynamic Thread Pool — View and modify thread pool parameters at runtime, supporting 7 queue types, 6 rejection policies + SPI extension
• 📡 High Extensibility — Multi-protocol communication architecture, extensible to monitor programs written in other programming languages

🔍 Feature Comparison

Phoenix offers two editions: Open Source (1.x) and Commercial (2.x). The open source edition includes core monitoring capabilities, suitable for personal learning and small projects. The commercial edition extends with Docker monitoring, network device management, online diagnostics, dynamic thread pool, slow SQL monitoring, enterprise notification channels, business exception log collection, and other advanced features, suitable for enterprise production environments.

💰 Marks indicate commercial edition exclusive paid features.

📮 Get Commercial Edition: To obtain a commercial license or learn more details, please refer to the 《Commercial Pricing Plan》 or contact the author (WeChat: pifengeclipse). For more contact methods, see Contact Us.

🏗️ System Architecture

🛠️ Tech Stack

📦 Project Structure

phoenix (Monitoring Platform)
├── phoenix-common (Common Modules)
│   ├── phoenix-common-core                   -- Core common: thread pool, data models, utilities, encryption/decryption
│   ├── phoenix-common-netty                  -- Netty communication: WebSocket, persistent connections, reconnection
│   └── phoenix-common-web                    -- Web common: REST API infrastructure
├── phoenix-client (Client SDK)
│   ├── phoenix-client-core                   -- Core: data collection, heartbeat, business instrumentation
│   ├── phoenix-client-spring-boot-starter    -- Spring Boot auto-configuration
│   └── phoenix-client-spring-mvc-integrator  -- Spring MVC adapter
├── phoenix-agent                             -- Agent: server/Docker/SNMP data collection
├── phoenix-server                            -- Server: data processing, alert engine, configuration distribution
├── phoenix-ui                                -- Visual UI: web management interface
├── doc                                       -- Documentation: architecture diagrams, screenshots, DB scripts, deployment scripts, technical blog
└── mvn                                       -- Maven packaging scripts

🚀 Quick Start

One-click installation: complete automated setup in 10 minutes
Minimum resource requirements: 1 CPU core / 2 GB RAM / 5 GB disk

Docker Installation (Recommended)

Software dependency: Docker 20.10.14+

bash -c "$(curl -fsSL https://gitee.com/monitoring-platform/phoenix/raw/master/doc/Docker/install.sh)"

Docker Compose Installation

Software dependency: Docker Compose 2.0.0+

bash -c "$(curl -fsSL https://gitee.com/monitoring-platform/phoenix/raw/master/doc/DockerCompose/install.sh)"

Install Agent (Required for Server Monitoring)

bash -c "$(curl -fsSL https://gitee.com/monitoring-platform/phoenix/raw/master/doc/Docker/phoenix-agent/install_agent.sh)"

Configuration Guide

phoenix-server configuration: 1. Copy application-prod.yml from the source directory phoenix-server/src/main/resources/ 2. Place it in /data/phoenix/phoenix-server/config/ 3. Edit the file to configure email and other alert channels 4. Restart the phoenix-server container

phoenix-agent configuration: 1. Copy monitoring-prod.properties from the source directory phoenix-agent/src/main/resources/ 2. Place it in /data/phoenix/phoenix-agent/config/ 3. Set monitoring.comm.http.url to http://<server-ip>:16000/phoenix-server 4. Restart the phoenix-agent container

After installation, visit: http://<ui-ip>/phoenix-ui/index, default accounts: admin / admin123, guest / guest123

📥 Client Integration

Latest stable version on Maven Central: 1.2.7.RELEASE

Plain Java application:

<dependency>
    <groupId>com.gitee.pifeng</groupId>
    <artifactId>phoenix-client-core</artifactId>
    <version>1.2.7.RELEASE</version>
</dependency>

Spring Boot application:

<dependency>
    <groupId>com.gitee.pifeng</groupId>
    <artifactId>phoenix-client-spring-boot-starter</artifactId>
    <version>1.2.7.RELEASE</version>
</dependency>

Spring MVC application:

<dependency>
    <groupId>com.gitee.pifeng</groupId>
    <artifactId>phoenix-client-spring-mvc-integrator</artifactId>
    <version>1.2.7.RELEASE</version>
</dependency>

📸 Screenshots

🏠 Home Overview

🖥️ Server Monitoring

☕ Application Monitoring

🗄️ Database Monitoring

🌐 Network / TCP / HTTP Monitoring

🐳 Docker Monitoring

🗺️ Topology Map

🔔 Alert Management

⚙️ System Management

📚 Technical Blog

Over 60+ in-depth technical articles (continuously updated), covering architecture design and core implementation