Skip to content

Latest commit

 

History

History
153 lines (104 loc) · 4.25 KB

server-monitoring-agent.md

File metadata and controls

153 lines (104 loc) · 4.25 KB
icon
eyes

Server monitoring agent

To collect hardware information from your servers, you need Capture, a server monitoring agent for Checkmate. Capture receives requests from Checkmate (server), and sends necessary infrastructure status data.

Capture is a hardware monitoring agent that collects hardware information from the host machine and exposes it through a RESTful API. The agent is designed to be lightweight and easy to use.

Capture is only available for Linux.

Docker Installation

Docker installation is recommended for running the Capture. Please see the Docker run flags section for more information.

Pull the image from the registry and then run it with one command.

docker run -v /etc/os-release:/etc/os-release:ro \
    -p 59232:59232 \
    -e API_SECRET=REPLACE_WITH_YOUR_SECRET \
    -d \
    ghcr.io/bluewave-labs/capture:latest

If you don't want to pull the image, you can build and run it locally.

docker buildx build -f Dockerfile -t capture .
docker run -v /etc/os-release:/etc/os-release:ro \
    -p 59232:59232 \
    -e API_SECRET=REPLACE_WITH_YOUR_SECRET \
    -d \
    capture:latest

Docker run flags

Before running the container, please make sure to replace the REPLACE_WITH_YOUR_SECRET with your own secret.

! You need to put this secret to Checkmate's infrastructure monitoring dashboard

  • -v /etc/os-release:/etc/os-release:ro to get platform information correctly
  • -p 59232:59232 to expose the port 59232
  • -d to run the container in detached mode
  • -e API_SECRET=REPLACE_WITH_YOUR_SECRET to set the API secret
  • (optional) -e GIN_MODE=release/debug to switch between release and debug mode
docker run -v /etc/os-release:/etc/os-release:ro \
    -p 59232:59232 \
    -e API_SECRET=REPLACE_WITH_YOUR_SECRET \
    -d \
    ghcr.io/bluewave-labs/capture:latest

System Installation

Pre-built Binaries

You can download the pre-built binaries from the GitHub Releases page.

Recommended installation path is /usr/local/bin.

Do not forget to make the binary executable.

chmod +x /usr/local/bin/capture

Go Package

You can install the Capture using the go install command.

go install github.com/bluewave-labs/capture/cmd/capture@latest

Build from Source

You can build the Capture from the source code.

Prerequisites

  • Git is essential for cloning the repository.
  • Go is required to build the project.
  • Just is optional but recommended for building the project with pre-defined commands.

Steps

  1. Clone the repository

    git clone [email protected]:bluewave-labs/capture

  2. Change the directory

    cd capture

  3. Build the Capture

    just build

    or

    go build -o dist/capture ./cmd/capture/

  4. Run the Capture

    ./dist/capture

Environment Variables

Configure the capture with the following environment variables:

Variable Description Required/Optional Type Default Value Accepted Values
API_SECRET The secret key for the API Required string - Any string value
PORT The port that the Capture listens on Optional integer 59232 0 - 65535
GIN_MODE The mode of the Gin framework Optional string system -> debug
docker -> release		 release, debug

Example

Please make sure to replace the default your_secret with your own secret.

! You need to put this secret to Checkmate's infrastructure monitoring dashboard

PORT = your_port
API_SECRET = your_secret
GIN_MODE = release/debug
# API_SECRET is required
API_SECRET=your_secret GIN_MODE=release ./capture

# Minimal required configuration
API_SECRET=your_secret ./dist/capture