feat(update): internal handlers

Author: CodeMeAPixel

README.md

@@ -2,65 +2,66 @@
 
 [![Visit Nodebyte](https://nodebyte.host/banner.png)](https://nodebyte.host)
 
-**SysCapture** is an open source hardware monitoring agent that collects vital system information and exposes it via a RESTful API.  
-**Note:** SysCapture is currently available only on **Linux**.
+**SysCapture** is an open source hardware monitoring agent that collects vital system information and exposes it via a RESTful API for easy integration with monitoring services like Prometheus.  
+
+> **Note:** SysCapture is currently available only on **Linux**.
 
 ---
 
 ## Features
 
-- **Hardware Monitoring:** Collects CPU, memory, disk, and host details.
-- **RESTful API:** Easily retrieve metrics using HTTP endpoints.
-- **Lightweight:** Designed to run with minimal system overhead.
-- **Open Source:** Extend and customize to suit your needs.
+- **Hardware Monitoring:** Captures CPU, memory, disk, and host details.
+- **RESTful API:** Retrieve metrics quickly via HTTP endpoints.
+- **Lightweight:** Minimal system overhead.
+- **Extensible:** Fully open source, allowing for customization.
 
 ---
 
-## System Installation
+## Installation
 
-### Pre-built Binaries
+### Using Pre-built Binaries (Recommended)
 
-We highly recommend using our pre-built binaries to get started quickly. Simply download the appropriate binary for your platform from the [GitHub Releases](https://github.com/nodebytehosting/syscapture/releases) page.
+Download the latest release for your platform from the [GitHub Releases](https://github.com/nodebytehosting/syscapture/releases) page. This is the easiest way to get started.
 
 ### Go Package Installation
 
-You can also install SysCapture using Go:
+Alternatively, you can install SysCapture via Go:
 
 ```shell
 go install github.com/nodebytehosting/syscapture/cmd/syscapture@latest
 ```
 
 ---
 
-## Environment Variables
+## Configuration
 
-Configure SysCapture using the following environment variables:
+SysCapture requires a few environment variables to run correctly. Configure these in your shell or within your service manager:
 
 | Variable     | Description                                  | Required/Optional |
 | ------------ | -------------------------------------------- | ----------------- |
 | `PORT`       | Port on which SysCapture listens             | Optional          |
 | `API_SECRET` | Secret key used for API authentication       | **Required**      |
 | `GIN_MODE`   | Operating mode for the Gin framework         | Optional          |
 
-> **Important:** Replace `your_secret` with a strong, secure secret. This secret must also be configured in Checkmate’s infrastructure monitoring dashboard for proper integration.
+> **Important:** Replace `your_secret` with a strong, secure secret. This key must match the configuration in Checkmate’s infrastructure monitoring dashboard.
 
 ### Example Configuration
 
-Set the environment variables in your shell (adjust values as needed):
+Set the environment variables as needed:
 
 ```shell
 export API_SECRET=your_secret
 export GIN_MODE=release
-export PORT=your_port   # Optional: defaults to 59232 if not set
+export PORT=your_port   # Defaults to 59232 if not set
 ```
 
-To run SysCapture with minimal configuration:
+To run SysCapture:
 
 ```shell
 API_SECRET=your_secret ./syscapture
 ```
 
-Or with a full configuration:
+Or, for a full configuration:
 
 ```shell
 API_SECRET=your_secret GIN_MODE=release PORT=your_port ./syscapture
@@ -70,21 +71,21 @@ API_SECRET=your_secret GIN_MODE=release PORT=your_port ./syscapture
 
 ## Running as a systemd Service
 
-For a more robust local setup, you can run SysCapture as a systemd service to ensure it starts on boot and automatically restarts if it fails.
+For a robust and continuously running setup, deploy SysCapture as a systemd service.
 
-#### Sample systemd Service File
+### Sample systemd Service File
 
-Create a file at `/etc/systemd/system/syscapture.service` with the following content (be sure to update paths and usernames as needed):
+Create a file at `/etc/systemd/system/syscapture.service` with the following content (update paths and usernames as needed):
 
 ```ini
 [Unit]
 Description=SysCapture Monitoring Agent
 After=network.target
 
 [Service]
-User=your_username       # Change this to your local username
-Group=your_username      # Change this accordingly
-ExecStart=/path/to/syscapture   # Replace with the full path to your binary
+User=your_username       # Replace with your local username
+Group=your_username      # Replace with your local group
+ExecStart=/full/path/to/syscapture   # Full path to the SysCapture binary
 Restart=always
 Environment="API_SECRET=your_secret"
 Environment="GIN_MODE=release"
@@ -94,56 +95,51 @@ Environment="PORT=59232"
 WantedBy=multi-user.target
 ```
 
-#### Setup Steps
+### Setup Steps
 
-1. **Copy the service file:**  
-   Save the above configuration to `/etc/systemd/system/syscapture.service`.
+1. **Copy the Service File:**  
+   Save the above content to `/etc/systemd/system/syscapture.service`.
 
-2. **Reload systemd configuration:**
+2. **Reload systemd:**
 
     ```shell
     sudo systemctl daemon-reload
     ```
 
-3. **Enable the service:**
+3. **Enable and Start the Service:**
 
     ```shell
     sudo systemctl enable syscapture
-    ```
-
-4. **Start the service:**
-
-    ```shell
     sudo systemctl start syscapture
     ```
 
-5. **Check the service status:**
+4. **Check Service Status:**
 
     ```shell
     sudo systemctl status syscapture
     ```
 
-This setup ensures that SysCapture runs continuously in the background, even after reboots.
+This configuration ensures SysCapture runs continuously in the background and restarts automatically if it fails or after a reboot.
 
 ---
 
 ## API Documentation
 
-SysCapture’s API is documented using the OpenAPI specification.  
-View the complete [OpenAPI Spec](https://github.com/nodebytehosting/syscapture/blob/master/openapi.yml) for details on endpoints and usage.
+SysCapture’s API is fully documented via the OpenAPI specification.  
+See the complete [OpenAPI Spec](https://github.com/nodebytehosting/syscapture/blob/master/openapi.yml) for details on endpoints and usage.
 
 ---
 
 ## Contributing
 
-Contributions are welcome! To get started:
+Contributions are welcome! To contribute:
 
 1. Fork the repository.
-2. Create a new branch: `git checkout -b feature/your-feature`.
-3. Commit your changes: `git commit -m 'Add feature'`.
-4. Push to the branch: `git push origin feature/your-feature`.
+2. Create a new branch (`git checkout -b feature/your-feature`).
+3. Commit your changes (`git commit -m 'Add feature'`).
+4. Push the branch (`git push origin feature/your-feature`).
 5. Open a pull request.
 
-Please follow the project's coding conventions and include tests for your changes when applicable.
+Please follow our coding conventions and include tests where applicable.
 
 ---

internal/handler/health.go

@@ -1,9 +1,16 @@
 package handler
 
 import (
-	"github.com/gin-gonic/gin"
+    "net/http"
+
+    "github.com/gin-gonic/gin"
 )
 
+// Health responds with a JSON object indicating the service status.
+// It can be used as a basic health check endpoint.
 func Health(c *gin.Context) {
-	c.JSON(200, "OK")
-}
+    c.JSON(http.StatusOK, gin.H{
+        "status":  "ok",
+        "message": "Service is healthy",
+    })
+}

internal/handler/metrics.go

@@ -1,42 +1,51 @@
 package handler
 
 import (
+	"net/http"
+
 	"github.com/gin-gonic/gin"
 	"github.com/nodebytehosting/syscapture/internal/metric"
 )
 
+// handleMetricResponse writes the appropriate HTTP status and JSON response.
+// If one or more errors are present, it uses HTTP StatusMultiStatus (207).
 func handleMetricResponse(c *gin.Context, metrics metric.Metric, errs []metric.CustomErr) {
-	statusCode := 200
-	if len(errs) > 0 {
-		statusCode = 207
-	}
-	c.JSON(statusCode, metric.APIResponse{
-		Data:   metrics,
-		Errors: errs,
-	})
+    statusCode := http.StatusOK
+    if len(errs) > 0 {
+        statusCode = http.StatusMultiStatus
+    }
+    c.JSON(statusCode, metric.APIResponse{
+        Data:   metrics,
+        Errors: errs,
+    })
 }
 
+// Metrics aggregates all system metrics and sends the response.
 func Metrics(c *gin.Context) {
-	metrics, metricsErrs := metric.GetAllSystemMetrics()
-	handleMetricResponse(c, metrics, metricsErrs)
+    metrics, metricsErrs := metric.GetAllSystemMetrics()
+    handleMetricResponse(c, metrics, metricsErrs)
 }
 
+// MetricsCPU returns CPU metrics.
 func MetricsCPU(c *gin.Context) {
-	cpuMetrics, metricsErrs := metric.CollectCPUMetrics()
-	handleMetricResponse(c, cpuMetrics, metricsErrs)
+    cpuMetrics, metricsErrs := metric.CollectCPUMetrics()
+    handleMetricResponse(c, cpuMetrics, metricsErrs)
 }
 
+// MetricsMemory returns memory metrics.
 func MetricsMemory(c *gin.Context) {
-	memoryMetrics, metricsErrs := metric.CollectMemoryMetrics()
-	handleMetricResponse(c, memoryMetrics, metricsErrs)
+    memoryMetrics, metricsErrs := metric.CollectMemoryMetrics()
+    handleMetricResponse(c, memoryMetrics, metricsErrs)
 }
 
+// MetricsDisk returns disk metrics.
 func MetricsDisk(c *gin.Context) {
-	diskMetrics, metricsErrs := metric.CollectDiskMetrics()
-	handleMetricResponse(c, diskMetrics, metricsErrs)
+    diskMetrics, metricsErrs := metric.CollectDiskMetrics()
+    handleMetricResponse(c, diskMetrics, metricsErrs)
 }
 
+// MetricsHost returns host information metrics.
 func MetricsHost(c *gin.Context) {
-	hostMetrics, metricsErrs := metric.GetHostInformation()
-	handleMetricResponse(c, hostMetrics, metricsErrs)
-}
+    hostMetrics, metricsErrs := metric.GetHostInformation()
+    handleMetricResponse(c, hostMetrics, metricsErrs)
+}