Welcome to the ServerMonPy Documentation

Getting Started

Welcome to ServerMonPy, a powerful Python tool designed for monitoring SSH server usage and performance. Whether you're a system administrator or a developer, ServerMonPy provides valuable insights into your SSH-enabled servers, helping you keep an eye on critical server metrics and ensuring optimal performance.

Getting started with ServerMonPy is a breeze. Follow these simple steps to start monitoring your SSH servers:

1. Installation

Begin by installing ServerMonPy using pip, Python's package manager. Open your terminal and run:

pip install ServerMonPy

2. Command Line Interface

ServerMonPy comes with a user-friendly command-line interface (CLI). To get a quick overview of available options, run:

ServerMonPy --help

Explore the various subcommands and options to tailor ServerMonPy to your monitoring needs.

3. Basic Usage

Monitor your SSH server by simply running the following command:

ServerMonPy monitor

This will initiate real-time monitoring and display vital statistics such as CPU usage, memory utilization, network I/O, and more.

4. Advanced Configuration

ServerMonPy is highly customizable. You can specify the target server, monitor interval, and output format to suit your preferences. Dive into the documentation to learn how to configure ServerMonPy for your specific use case.

5. Stay Informed

Stay informed about your server's health and performance. ServerMonPy will continuously update you on your server's vital statistics. Use this data to proactively address issues and optimize server resources.

Congratulations! You are now ready to harness the power of ServerMonPy to monitor your SSH servers effectively. Dive into the detailed documentation for more in-depth information and advanced usage scenarios.

What is SSH (Secure Shell)?

SSH, or Secure Shell, is a cryptographic network protocol that provides a secure and encrypted method for remote communication between computers over an unsecured network, such as the internet. It is widely used for secure remote administration of servers and secure file transfers.

SSH ensures the confidentiality and integrity of data transmitted over a network, making it an essential tool for secure server management and data exchange. It achieves this through several key features:

  • Encryption: SSH encrypts data transmitted between the client and the server, protecting it from eavesdropping and interception.
  • Authentication: SSH uses various authentication methods, including password-based authentication and public key authentication, to verify the identity of the user or system.
  • Secure Channels: SSH creates secure channels for different types of communication, such as interactive shell sessions and file transfers.
  • Port Forwarding: SSH allows for secure port forwarding, enabling users to access services on remote servers securely.

SSH is commonly used by system administrators, developers, and anyone who needs to securely access and manage remote servers and devices. It is an indispensable tool for maintaining the confidentiality and integrity of sensitive data in a networked environment.

SSH is widely supported on various operating systems and is the go-to choice for remote server management in the world of IT and cybersecurity.

How to Setup SSH

Setting up SSH (Secure Shell) is a crucial step in securing remote access to your server. SSH provides a secure method for connecting to your server over a network. This guide will walk you through the process of setting up SSH on your server and configuring it for secure and convenient access.

Step 1: Server Preparation

Before setting up SSH, ensure that you have access to your server with administrative privileges. If you don't have direct access, make sure you have a user account with administrative rights.

Step 2: Check SSH Availability

Most modern Linux distributions come with SSH pre-installed. To check if SSH is installed, open your terminal and run:

ssh -V

If SSH is not installed, you can typically install it using your package manager. For example, on Ubuntu, you can run:

sudo apt-get install openssh-server

Step 3: Configure SSH

SSH can be configured using the SSH server configuration file, typically located at /etc/ssh/sshd_config. You can edit this file using a text editor like nano or vi. Ensure that the following settings are configured securely:

  • Disable root login: Set PermitRootLogin to no.
  • Use strong authentication: Consider using public key authentication alongside password authentication.
  • Limit login attempts: Set MaxAuthTries to a reasonable value to prevent brute-force attacks.
  • Restrict user access: Use AllowUsers or AllowGroups to specify which users or groups can access SSH.
  • Enable firewall rules: Open port 22 (default SSH port) in your firewall to allow SSH traffic.

Step 4: Restart SSH Service

After making changes to the SSH configuration file, restart the SSH service to apply the settings:

sudo systemctl restart ssh

Step 5: Test SSH Connection

Test the SSH connection to ensure it's working as expected. Use the following command to connect to your server:

ssh username@server_ip_or_hostname

Replace username with your username and server_ip_or_hostname with your server's IP address or hostname.

Step 6: Secure SSH Keys (Optional)

Consider using SSH key pairs for authentication. This provides an extra layer of security by eliminating the need for passwords.

That's it! You've successfully set up SSH on your server. You can now securely access your server remotely using SSH, and it's recommended to follow best practices to keep your SSH configuration secure.

ServerMonPy Command Line Interface

The ServerMonPy command-line interface (CLI) is a powerful tool for monitoring and gathering information about SSH server usage and performance. It allows system administrators and developers to remotely assess the health and status of SSH-enabled servers. Below, we'll explore the key features and commands available in ServerMonPy.

Features:

  • Real-time Monitoring: ServerMonPy provides real-time monitoring of SSH server statistics, including CPU usage, memory usage, network I/O, and more.
  • Easy-to-Use: The CLI is designed for simplicity and ease of use, making it accessible to both novice and experienced users.
  • Customizable Output: Users can customize the output format and choose specific metrics to display, tailoring the tool to their needs.
  • Secure Authentication: ServerMonPy supports secure authentication methods, ensuring that only authorized users can access server statistics.
  • Cross-Platform: The tool is compatible with various operating systems, making it versatile for different server environments.

Commands:

ServerMonPy offers a range of commands to gather and display server statistics:

  • ServerMonPy status: Provides an overview of the server's current status, including CPU and memory usage.
  • ServerMonPy network: Displays network-related statistics, such as bytes sent and received.
  • ServerMonPy memory: Reports on memory usage, including available and used memory.
  • ServerMonPy processes: Lists the active processes on the server.
  • ServerMonPy users: Shows a list of connected users and their activities.

Getting Started:

To use ServerMonPy, follow these steps:

  1. Install ServerMonPy using pip: pip install ServerMonPy
  2. Run ServerMonPy with the desired command: ServerMonPy status, ServerMonPy network, etc.
  3. Review the real-time server statistics provided by the tool.

ServerMonPy simplifies the process of monitoring and maintaining SSH servers, ensuring optimal performance and security. Whether you're managing a single server or a network of servers, ServerMonPy is a valuable addition to your toolkit.

Changelog

Welcome to the changelog for ServerMonPy! This section provides a detailed history of changes, updates, and improvements made to the ServerMonPy tool over time.

Version 1.0.0 (Release Date: July 1, 2023)

This is the initial release of ServerMonPy, offering powerful server monitoring capabilities for SSH-enabled servers.

Version 1.1.0 (Release Date: August 15, 2023)

In this update, we've introduced new features and enhancements:

  • Added real-time CPU utilization tracking for improved performance monitoring.
  • Enhanced memory usage statistics to include cached memory information.
  • Improved network I/O tracking with detailed sent and received data.

Version 1.2.0 (Release Date: September 30, 2023)

This release focuses on usability and stability:

  • Implemented a user-friendly command-line interface (CLI) for easier interaction.
  • Added support for custom monitoring intervals, allowing users to specify update frequencies.
  • Fixed various bugs and issues reported by our community members.

Version 1.3.0 (Release Date: November 15, 2023)

In this update, we're introducing exciting new capabilities:

  • Enhanced server discovery to support multiple SSH servers on the same host.
  • Added a powerful search feature for quickly finding specific server statistics.
  • Improved documentation with detailed usage examples and installation instructions.

Thank you for using ServerMonPy and providing valuable feedback. We're committed to delivering an exceptional monitoring experience, and we look forward to your continued support.

Installation

Installing ServerMonPy is a straightforward process that allows you to quickly get started with monitoring SSH server performance. This section provides step-by-step instructions for installing ServerMonPy on your system.

Prerequisites

Before you begin the installation, ensure that you have the following prerequisites:

  • A Python environment: ServerMonPy is a Python tool, so you need to have Python installed on your system. You can download Python from the official Python website (https://www.python.org/downloads/).
  • Pip: Pip is the Python package manager, and it's used to install external Python packages. Most Python installations come with pip pre-installed, but you can check by running pip --version in your terminal.
  • SSH-enabled server: To use ServerMonPy, you need access to an SSH-enabled server that you want to monitor. You should have the server's hostname or IP address, a valid username, and password or SSH key for authentication.

Installation Steps

Follow these steps to install ServerMonPy:

  1. Open a terminal or command prompt on your local machine.
  2. Use pip to install ServerMonPy by running the following command:
pip install ServerMonPy

This command will download and install ServerMonPy and its dependencies.

Verification

To verify the installation, you can run the following command:

ServerMonPy --version

If the installation was successful, this command will display the installed version of ServerMonPy.

Getting Started

Once you have ServerMonPy installed, you can proceed to the Getting Started section to learn how to use it to monitor your SSH-enabled servers.

Usage

ServerMonPy is a versatile Python tool designed to provide comprehensive monitoring of SSH server usage and performance. Whether you are a system administrator managing multiple servers or a curious user wanting to gain insights into your server's behavior, ServerMonPy can be a valuable addition to your toolkit.

With ServerMonPy, you can effortlessly monitor key server metrics, including:

  • CPU Usage: ServerMonPy measures the CPU utilization of your SSH server, helping you identify performance bottlenecks and anomalies.
  • Memory Usage: Gain insights into your server's memory consumption, including total, available, and used memory, as well as memory usage percentages.
  • Network I/O: ServerMonPy tracks network input and output, making it easy to spot unusual network activity or bandwidth usage.
  • Swap Usage: Keep an eye on your server's swap memory usage to prevent memory-related issues.

Using ServerMonPy is a straightforward process:

  1. Install ServerMonPy by running pip install ServerMonPy.
  2. Once installed, you can run the tool with a simple command: ServerMonPy. By default, it will connect to the local SSH server on port 22. You can specify a different hostname or IP address as an argument.
  3. ServerMonPy will then start monitoring the selected SSH server and display real-time updates on your terminal. You can stop monitoring by pressing 'q'.

ServerMonPy is highly customizable, allowing you to adjust monitoring intervals and parameters to suit your specific needs. You can also integrate it into your own scripts or monitoring solutions to automate server performance checks.

Whether you are troubleshooting server issues, optimizing resource usage, or simply curious about your server's behavior, ServerMonPy provides the data you need to make informed decisions and keep your SSH server running smoothly.

Get started with ServerMonPy GUI on Windows by following these easy steps:

ServerMonPy For Windows:

Follow these steps to install ServerMonPy on your Windows machine:

  1. Click the Download Now button to download the ServerMonPy installer for Windows.
  2. Run the downloaded installer (ServerMonPy_Setup.exe).
  3. Follow the on-screen instructions to complete the installation.
  4. Once installed, launch ServerMonPy from the Start menu or desktop shortcut.
Windows Installation Screenshot

License

Information about the license of ServerMonPy.

View License