Documentation

Everything you need to monitor, troubleshoot, and optimize your infrastructure.

⌘K

Quick Start

Get up and running in 5 minutes with our installation guide.

Core Concepts

Understand metrics, traces, logs, and how they work together.

API Reference

Complete API documentation with examples and SDKs.

Installation

Install the ServerWatch agent on your servers to start collecting metrics, traces, and logs. The agent is lightweight (less than 1% CPU overhead) and runs on Linux, Windows, and macOS.

1. Install the Agent

Run the following command to install the agent:

$ curl -sSL https://install.serverwatch.io | bash

2. Configure Your API Key

Add your API key to the configuration file:

# /etc/serverwatch/config.yaml
api_key: "YOUR_API_KEY"
hostname: "my-server"
tags:
  - "env:production"
  - "service:api"

3. Start the Agent

Start the agent and enable it on boot:

$ sudo systemctl start serverwatch-agent
$ sudo systemctl enable serverwatch-agent

You're all set!

Data will start appearing in your dashboard within 60 seconds.

API Reference

The ServerWatch API lets you programmatically access your monitoring data and automate common tasks.

GET /api/v1/metrics

Query time-series metrics for any host or container.

POST /api/v1/alerts

Create or update alert configurations.

GET /api/v1/traces

Search and retrieve distributed traces.

GET /api/v1/logs

Query and search log data with full-text search.

Need Help?

Can't find what you're looking for? Our support team is here to help.

Contact Support

Community

Join our community to get help from other ServerWatch users.

Join Discord