{ "componentChunkName": "component---src-templates-issues-tsx", "path": "/issues/143", "result": {"data":{"issuesJson":{"id":"9dd32058-809f-50d8-ab3e-2a6e13a22ebe","title":"megaease/easeprobe: 一个部署简单，易于配置，强大高效的服务健康检测告警工具，支持多种协议。","number":143,"bodyHTML":"
\n



\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Reposmegaease/easeprobe
Views\"views\"
Stars\"stars\"
Forks\"forks\"
License\"license\"
UpdatedAt\"last-commit\"
CreatedAt\"create-at\"
\n\n

\"\"

\n\n
\n

EaseProbe

\n

\"Go
\n\"codecov\"
\n\"Build\"
\n\"GitHub
\n\"Join

\n

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

\n

\"\"

\n

Table of Contents

\n\n

1. Introduction

\n

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

\n

1.1 Probe

\n

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

\n\n

1.2 Notification

\n

EaseProbe supports notification delivery to the following:

\n\n
\n

Note:

\n
    \n
  1. \n

    The notification is Edge-Triggered Mode by default, if you want to config it as Level-Triggered Mode with different interval and max notification, please refer to the manual - Alerting Interval.

    \n
    2. \n
  2. \n

    Windows platforms do not support syslog as notification method.

    \n
    3. \n
\n
\n

Check the Notification Manual to see how to configure it.

\n

1.3 Report & Metrics

\n

EaseProbe supports the following report and metrics:

\n\n

For more information, please check the Global Setting Configuration

\n\n

The metrics are prefixed with easeprobe_ and are documented in Prometheus Metrics Exporter

\n

2. Getting Started

\n

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

\n\n

2.1 Build

\n

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

\n

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

\n
$ make
\n

2.2 Configure

\n

Read the User Manual for detailed instructions on how to configure all EaseProbe parameters.

\n

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

\n

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

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

You can check the EaseProbe JSON Schema section to use a JSON Scheme file to make your life easier when you edit the configuration file.

\n

2.3 Run

\n

You can run the following command to start EaseProbe once built

\n
$ build/bin/easeprobe -f config.yaml
\n\n

3. Deployment

\n

EaseProbe can be deployed by Systemd, Docker, Docker-Compose, & Kubernetes.

\n

You can find the details in Deployment Guide

\n

4. User Manual

\n

For detailed instructions and features please refer to the User Manual

\n

5. Benchmark

\n

We have performed an extensive benchmark on EaseProbe. For the benchmark results please refer to - Benchmark Report

\n

6. Contributing

\n

If you're interested in contributing to the project, please spare a moment to read our CONTRIBUTING Guide

\n

7. Community

\n\n

8. License

\n

EaseProbe is under the Apache 2.0 license. See the LICENSE file for details.

","updatedAt":"2025-05-21T15:56:10Z","upvoteCount":null,"author":{"login":"eryajf","avatarUrl":"https://avatars.githubusercontent.com/u/33259379?u=e4a4090a38ac2473aaed4ef9945233636776c6c3&v=4","url":"https://github.com/eryajf"},"category":null,"labels":{"edges":[{"node":{"name":"更多","color":"25B472"}},{"node":{"name":"Notification","color":"b5f820"}},{"node":{"name":"megaease","color":"ce9988"}}]},"comments":{"edges":[]}}},"pageContext":{"number":143,"previous":{"title":"earthly/earthly: 超级简单的构建框架，具有快速、可重复的构建和即时熟悉的语法 - 就像 Dockerfile 和 Makefile 的结合体。","number":142},"next":{"title":"chaos-zhu/easynode: 一个简易的个人 Linux 服务器 ssh 管理面板 ( WEBSSH, WEBSFTP)","number":144}}}, "staticQueryHashes": ["151096407","2861350382"]}