EaseProbe

A simple, standalone, and lightweight tool that can do health/status checking, written in Go.

Programming language: Go

License: Apache License 2.0

Tags: Utilities    

README

EaseProbe

EaseProbe is a simple, standalone, and lightweight tool that can do health/status checking, written in Go.

[](docs/overview.png)

Table of Contents

• 1. Introduction
  • 1.1 Probe
  • 1.2 Notification
  • 1.3 Report & Metrics
• 2. Getting Started
  • 2.1 Build
  • 2.2 Configure
  • 2.3 Run
• 3. User Manual
• 4. Benchmark
• 5. Contributing
• 6. Community
• 7. License

1. Introduction

EaseProbe is designed to do three kinds of work - Probe, Notify, and Report.

1.1 Probe

EaseProbe supports a variety of methods to perform its probes such as:

• HTTP. Checking the HTTP status code, Support mTLS, HTTP Basic Auth, and can set the Request Header/Body. ( [HTTP Probe Configuration](./docs/Manual.md#71-http-probe-configuration) )
• TCP. Check whether a TCP connection can be established or not. ( [TCP Probe Configuration](./docs/Manual.md#72-tcp-probe-configuration) )
• Shell. Run a Shell command and check the result. ( [Shell Command Probe Configuration](./docs/Manual.md#73-shell-command-probe-configuration) )
• SSH. Run a remote command via SSH and check the result. Support the bastion/jump server ([SSH Command Probe Configuration](./docs/Manual.md#74-ssh-command-probe-configuration))
• TLS. Connect to a given port using TLS and (optionally) validate for revoked or expired certificates ( [TLS Probe Configuration](./docs/Manual.md#75-tls-probe-configuration) )
• Host. Run an SSH command on a remote host and check the CPU, Memory, and Disk usage. ( [Host Load Probe](./docs/Manual.md#76-host-resource-usage-probe-configuration) )
• Client. The following native clients are supported. They all supports the mTLS and the data checking, please refer to [Native Client Probe Configuration](./docs/Manual.md#77-native-client-probe-configuration)
  • MySQL. Connect to a MySQL server and run the SHOW STATUS SQL.
  • Redis. Connect to a Redis server and run the PING command.
  • Memcache. Connect to a Memcache server and run the version command or validate a given key/value pair.
  • MongoDB. Connect to a MongoDB server and perform a ping.
  • Kafka. Connect to a Kafka server and perform a list of all topics.
  • PostgreSQL. Connect to a PostgreSQL server and run SELECT 1 SQL.
  • Zookeeper. Connect to a Zookeeper server and run get / command.

1.2 Notification

EaseProbe supports notification delivery to the following:

• Slack. Using Slack Webhook for notification delivery
• Discord. Using Discord Webhook for notification delivery
• Telegram. Using Telegram Bot for notification delivery
• Teams. Support the Microsoft Teams notification delivery
• Email. Support email notification delivery to one or more email addresses
• AWS SNS. Support the AWS Simple Notification Service
• WeChat Work. Support Enterprise WeChat Work notification delivery
• DingTalk. Support the DingTalk notification delivery
• Lark. Support the Lark(Feishu) notification delivery
• SMS. SMS notification delivery with support for multiple SMS service providers
  • Twilio
  • Vonage(Nexmo)
  • YunPain
• Log. Write the notification into a log file or syslog.
• Shell. Run a shell command to deliver the notification (see [example](resources/scripts/notify/notify.sh))
• RingCentral. Using RingCentral Webhook for notification delivery

Note:

1) The notification is Edge-Triggered Mode, this means that these notifications are triggered when the status changes.

2) Windows platforms do not support syslog as notification method.

Check the [Notification Configuration](./docs/Manual.md#78-notification-configuration) to see how to configure it.

1.3 Report & Metrics

EaseProbe supports the following report and metrics:

• SLA Report Notify. EaseProbe would send the daily, weekly, or monthly SLA report using the defined notify: methods.
• SLA Live Report. The EaseProbe would listen on the 0.0.0.0:8181 port by default. By accessing this service you will be provided with live SLA report either as HTML at http://localhost:8181/ or as JSON at http://localhost:8181/api/v1/sla
• SLA Data Persistence. The SLA data will be persisted in $CWD/data/data.yaml by default. You can configure this path by editing the settings section of your configuration file.

For more information, please check the [Global Setting Configuration](./docs/Manual.md#79-global-setting-configuration)

• Prometheus Metrics. The EaseProbe would listen on the 8181 port by default. By accessing this service you will be provided with Prometheus metrics at http://easeprobe:8181/metrics.

The metrics are prefixed with easeprobe_ and are documented in [Prometheus Metrics Exporter](./docs/Manual.md#6-prometheus-metrics-exporter)

2. Getting Started

You can get started with EaseProbe, by any of the following methods:

• Download the release for your platform from https://github.com/megaease/easeprobe/releases
• Use the available EaseProbe docker image docker run -it megaease/easeprobe
• Build easeprobe from sources

2.1 Build

Compiler Go 1.18+ (Generics Programming Support), checking the Go Installation to see how to install Go on your platform.

Use make to build and produce the easeprobe binary file. The executable is produced under the build/bin directory.

$ make

2.2 Configure

Read the [User Manual](./docs/Manual.md) for detailed instructions on how to configure all EaseProbe parameters.

Create a configuration file (eg. $CWD/config.yaml) using the configuration template at ./resources/config.yaml, which includes the complete list of configuration parameters.

The following simple configuration example can be used to get started:

http: # http probes
  - name: EaseProbe Github
    url: https://github.com/megaease/easeprobe
notify:
  log:
    - name: log file # local log file
      file: /var/log/easeprobe.log
settings:
  probe:
    timeout: 30s # the time out for all probes
    interval: 1m # probe every minute for all probes

You can check the [EaseProbe JSON Schema](./docs/Manual.md#81-easeprobe-json-schema) section to use a JSON Scheme file to make your life easier when you edit the configuration file.

2.3 Run

You can run the following command to start EaseProbe once built

$ build/bin/easeprobe -f config.yaml

• -f configuration file or URL or path for multiple files which will be auto merged into one. Can also be achieved by setting the environment variable PROBE_CONFIG
• -d dry run. Can also be achieved by setting the environment variable PROBE_DRY

3. User Manual

For detailed instructions and features please refer to the [User Manual](./docs/Manual.md)

4. Benchmark

We have performed an extensive benchmark on EaseProbe. For the benchmark results please refer to - [Benchmark Report](./docs/Benchmark.md)

5. Contributing

If you're interested in contributing to the project, please spare a moment to read our [CONTRIBUTING Guide](./docs/CONTRIBUTING.md)

6. Community

• Join Slack Workspace for requirements, issues, and development.
• MegaEase on Twitter

7. License

EaseProbe is under the Apache 2.0 license. See the [LICENSE](./LICENSE) file for details.