Web Statistic Tab

User Guide for the Network Statistics Management System

Welcome to the User Guide for the Network Statistics Management System, a sophisticated tool designed for real-time monitoring and management of network traffic statistics. This guide provides comprehensive information to effectively interact with the system using its extensive features, making it ideal for network administrators and security operations centers.

System Overview #

The Network Statistics Management System offers a robust solution for collecting, analyzing, and reporting network statistics. It interfaces through RESTful APIs and leverages Redis for efficient data storage and retrieval, facilitating seamless interactions with real-time network data.

Key Features #

1. Statistics Retrieval:

   • Retrieve real-time statistics related to network traffic, including packets, bytes, alerts, and protocol-specific data.

   • Usage: Send a GET request to /stats to receive comprehensive network statistics in JSON format.

2. Packet Statistics:

   • Access detailed statistics on network packets, including total packets and breakdown by protocols (TCP, UDP, ICMP).

   • Usage: Issue a GET request to /stats/pkts to retrieve packet statistics.

3. Alert Statistics:

   • Obtain statistics on security alerts generated by the network monitoring system.

   • Usage: Access through /stats/alerts to fetch alert statistics.

4. Resource Utilization:

   • Monitor resource utilization such as CPU and memory usage of the network monitoring system.

   • Usage: Use endpoints /stats/cpu, /stats/vm, and /stats/pm for CPU, virtual memory, and physical memory statistics respectively.

5. Historical Data Analysis:

   • Analyze historical data for trends and patterns with time-labeled data points.

   • Usage: Navigate to /stats/histogram to get historical data in a histogram format.

6. Suricata Process Check:

   • Check the operational status of the Suricata network monitoring process.

   • Usage: Send a GET request to /check/suricata to verify if Suricata is running.

7. Configuration File Last Modified Date:

   • Determine when the configuration file for the network monitor was last modified.

   • Usage: Access /file/date to retrieve the last modified date of the configuration file.

CORS Support #

• All HTTP responses include CORS (Cross-Origin Resource Sharing) headers, enabling integration into diverse client environments across different domains.

Error Handling #

• The system is designed to handle errors gracefully, providing meaningful error messages in the HTTP response to aid debugging and integration efforts.

Configuration and Setup #

• System configuration is managed through a configuration file (config++.conf), which includes settings for Redis connections and other system parameters.

Retrieving and Saving Reports #

• The system allows for the retrieval and saving of detailed statistical reports. This can be accessed through specific API endpoints that interface with Redis to store or retrieve serialized JSON data.

Integration Tips #

• Ensure that your client application is configured to handle JSON responses effectively, as all data exchanged with the backend is in JSON format.

• Utilize the provided CORS headers if the API is consumed from web applications hosted on different domains.

This user guide aims to equip you with the knowledge to utilize the Network Statistics Management System efficiently. Whether for enhancing network performance monitoring, security analysis, or administrative reporting, the system provides a powerful toolkit for detailed network statistics management.