Categorygithub.com/semnell/KeepUp
modulepackage
0.0.0-20231227215130-cd8557dd3c38
Repository: https://github.com/semnell/keepup.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
6
Dependents
0
Files
46 SLOC

# README

KeepUp

Go Report Card Tests Docker Builds codebeat badge CodeFactor

KeepUp is a robust and simple-to-use uptime monitoring tool designed to be both lightweight and scalable, with the capability to distribute tasks across multiple workers for efficient handling of requests. Whether you're monitoring a few endpoints or hundreds, KeepUp aims to provide a straightforward and performant solution.

If you find KeepUp useful, consider giving it a star to show your support.

Roadmap

  • Setup Helm: Streamline deployment with Helm charts.
  • Metrics: Provide more metrics.

Features

  • Deadly Simple Config Language: Configure monitoring tasks effortlessly using an intuitive config language.
  • Prometheus Metrics Endpoint: Integration-friendly metrics endpoint for seamless integration into various monitoring systems.
  • Minimal External Dependencies: Relies on Faktory, a single binary job queue, as the only external dependency.
  • Rich Logging: Detailed logging to keep you informed about the monitoring process.

License

This tool is released under the MIT license, providing you with the freedom to use, modify, and distribute it as you see fit. Go ahead, monitor the world, or choose not to—it's up to you.

Is it any good?

We certainly hope so. Your feedback and contributions are always welcome to make KeepUp even better.

Usage

  1. Download the Latest Release:

    • Choose the appropriate release for your OS and architecture (e.g., Linux arm64).

  2. Configuration:

    • Create a config.yaml file (refer to the example in the project's root).
    • Set up the .env file or configure environment variables in your shell.

  3. Options:

    • Run the binary in either standalone or distributed mode.

Standalone Mode

  • Execute the binary without any arguments to run in standalone mode.

Distributed Mode

  • The binary supports two modes in a distributed setup: server and worker.

Server

  • Run the binary with the correct .env values and the server argument.

Worker

  • Run the binary with the correct .env values and the worker argument.

In most setups, it's recommended to run the server on a single machine and distribute workers across multiple machines. Note that running the server multiple times is not allowed due to unique Prometheus metrics and the server's exclusive ability to add new jobs to the queue.

# Packages

Package server Handles all server-side logic.
Package utils contains helper functions and structs.
Package worker This file contains the worker code that is responsible for handeling all jobs.