FT Device Network Service Documentation
Introduction
The FT Device Network Service is a Spring Boot application designed to collect, process, and store network-related data from devices. It provides real-time data ingestion via MQTT and efficient data storage using ClickHouse.
Documentation Structure
-
Installation & Deployment — Docker Compose deployment, prerequisites, environment configuration, and troubleshooting.
-
Architecture Overview — component diagram
-
-
Database Configuration – Details about the ClickHouse database configuration, repositories, and data models.
-
Architecture Documentation – Comprehensive overview of the system design and components.
-
Asynchronous Processing – Information about thread pools, async task execution, and performance optimization.
-
Logging Configuration – Details on logging configuration, appenders, and device-specific logging.
-
API Documentation – Comprehensive guide to the service’s REST API endpoints and usage.
Quick Start
-
Clone the repository
-
Configure environment variables
-
Start the application — see Installation & Deployment
-
Access the API documentation at
http://localhost:8383/api/swagger-ui.html
Key Features
-
Real-time data ingestion via MQTT
-
Efficient data storage using ClickHouse
-
RESTful API for data access
-
Parallel data processing
-
Configurable task execution
-
Health monitoring and metrics
-
Swagger API documentation
Support
For support and issues, please contact the development team or create an issue in the project repository.