What's Changed

• Escape SLA status text for compatibility with notification services s… by @samanhappy in https://github.com/megaease/easeprobe/pull/472
• log error when meet invalid json by @suchen-sci in https://github.com/megaease/easeprobe/pull/473
• Avoid random websocket test failures by waiting for http server to start by @samanhappy in https://github.com/megaease/easeprobe/pull/474
• fix BastionMap, improve log and some other by @suchen-sci in https://github.com/megaease/easeprobe/pull/475
• log notify error with request body by @suchen-sci in https://github.com/megaease/easeprobe/pull/476
• Fix ssh timeout by @suchen-sci in https://github.com/megaease/easeprobe/pull/483
• upgrade to go 1.21 by @samanhappy in https://github.com/megaease/easeprobe/pull/507
• specify macos-13 runner for test by @samanhappy in https://github.com/megaease/easeprobe/pull/521
• fix tls metrics by @suchen-sci in https://github.com/megaease/easeprobe/pull/520
• chore: fix document indentation by @samanhappy in https://github.com/megaease/easeprobe/pull/522
• fix multi failure notify by @suchen-sci in https://github.com/megaease/easeprobe/pull/524
• fix: metric EaseProbe_ping_loss Add by mistake by @fangpsh in https://github.com/megaease/easeprobe/pull/533
• fix: wrong default TimeFormat by @ionling in https://github.com/megaease/easeprobe/pull/549
• Make linger configurable by @proditis in https://github.com/megaease/easeprobe/pull/557
• add option to print output when meet error by @suchen-sci in https://github.com/megaease/easeprobe/pull/560

New Contributors

• @fangpsh made their first contribution in https://github.com/megaease/easeprobe/pull/533
• @ionling made their first contribution in https://github.com/megaease/easeprobe/pull/549

Full Changelog: https://github.com/megaease/easeprobe/compare/v2.1.2...v2.2.1

Change Logs

Features

• Add constant labels for the metrics @qdongxu in https://github.com/megaease/easeprobe/pull/386
• Add Websocket prober @qdongxu in https://github.com/megaease/easeprobe/pull/411

Documents

• Fix YunPian link @icpd in https://github.com/megaease/easeprobe/pull/409
• Update YunPian link @jiacheo in https://github.com/megaease/easeprobe/pull/433
• Fix manual typo @suchen-sci in https://github.com/megaease/easeprobe/pull/439
• Fix Kubernetes deployment typo @LokiWager in https://github.com/megaease/easeprobe/pull/441

Bug-fixing

• Set timeout for kafka client connection @suchen-sci in https://github.com/megaease/easeprobe/pull/455
• Make DingTalk notify always produce valid json @suchen-sci in https://github.com/megaease/easeprobe/pull/469

Full Changelog: https://github.com/megaease/easeprobe/compare/v2.1.1...v2.1.2

Change Logs

Features

• Optimize the ordering of status display in SLA report by @yunyouu in https://github.com/megaease/easeprobe/pull/381
• Add endpoint label to metrics by @Zhang21 in https://github.com/megaease/easeprobe/pull/382

Non-Functional

• Optimize code by @testwill in https://github.com/megaease/easeprobe/pull/383 and https://github.com/megaease/easeprobe/pull/384

Documents

• Fix broken links in manual by @Shawyeok in https://github.com/megaease/easeprobe/pull/350

Bug-fixing

• Split long message for Telegram bot by @samanhappy in https://github.com/megaease/easeprobe/pull/365
• Fix json schema by @samanhappy in https://github.com/megaease/easeprobe/pull/389

Full Changelog: https://github.com/megaease/easeprobe/compare/v2.1.0...v2.1.1

Change Logs

Features

• feat: Introducing the Level Trigger Mode by @haoel in https://github.com/megaease/easeprobe/pull/315
• feat: Auto-restart if the configuration file changed by @haoel in https://github.com/megaease/easeprobe/pull/332
• Add Helm charts release workflow by @samanhappy in https://github.com/megaease/easeprobe/pull/292, https://github.com/megaease/easeprobe/pull/307, https://github.com/megaease/easeprobe/pull/308
• Add the docker-compose deployment by @haoel in https://github.com/megaease/easeprobe/pull/331

Non-Functional

• upgrade to go 1.20 by @haoel in https://github.com/megaease/easeprobe/pull/343, https://github.com/megaease/easeprobe/pull/347
• chore(deps): replace go-ping with pro-bing by @haoqixu in https://github.com/megaease/easeprobe/pull/294

Documents

• Reconstructing the user manual by @haoel in https://github.com/megaease/easeprobe/pull/305
• fix the link error in README.md by @haoel in https://github.com/megaease/easeprobe/pull/313
• fix typo by @lostsquirrel in https://github.com/megaease/easeprobe/pull/316, by @haoel in
  https://github.com/megaease/easeprobe/pull/329
• Correct the document and json scheme by @haoel in https://github.com/megaease/easeprobe/pull/346

Bug-fixing

• refactor: avoid copying mutex by @haoqixu in https://github.com/megaease/easeprobe/pull/296
• fix: use buffered os.Signal channel as argument to signal.Notify by @haoqixu in https://github.com/megaease/easeprobe/pull/295
• Fix the version bug by @haoel in https://github.com/megaease/easeprobe/pull/310

Security

• Fix XSS attack bug by @haoel in https://github.com/megaease/easeprobe/pull/291
• Fix the SQL Injection by @haoel in https://github.com/megaease/easeprobe/pull/330

New Contributors

• @haoqixu made their first contribution in https://github.com/megaease/easeprobe/pull/294
• @lostsquirrel made their first contribution in https://github.com/megaease/easeprobe/pull/316

Full Changelog: https://github.com/megaease/easeprobe/compare/v2.0.1...v2.1.0

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

Change Logs

Features

• Optimizing and adding new SLA Prometheus metrics by @haoel in https://github.com/megaease/easeprobe/pull/272

Documents

• Add EaseProbe deployment guide by @haoel in https://github.com/megaease/easeprobe/pull/274
• Add Helm chart by @samanhappy in https://github.com/megaease/easeprobe/pull/284
• Fix the TLS YAML format error in Manual by @haoel in https://github.com/megaease/easeprobe/pull/289

Bug-fixing

• bug-fixing: PostgreSQL failed to check if the server wasn't turned on the SSL by @haoel in https://github.com/megaease/easeprobe/pull/286

Security Upgrade

• Bump golang.org/x/net from 0.5.0 to 0.7.0 by @dependabot in https://github.com/megaease/easeprobe/pull/287

Full Changelog: https://github.com/megaease/easeprobe/compare/v2.0.0...v2.0.1

Change Logs

Features

• Enhance email notification: add an SSL option by @xiaoxuanzi in https://github.com/megaease/easeprobe/pull/245
• support ping (ICMP) probe by @haoel in https://github.com/megaease/easeprobe/pull/251
• Add load average to host probe by @haoel in https://github.com/megaease/easeprobe/pull/253
• send the expression value if evaluation is false by @haoel in https://github.com/megaease/easeprobe/pull/252

Documents

• Fix the invalid link of Benchmark.md by @xiaoxuanzi in https://github.com/megaease/easeprobe/pull/248
• Update Roadmap Document & other trivial works by @haoel in https://github.com/megaease/easeprobe/pull/250

New Contributors

• @xiaoxuanzi made their first contribution in https://github.com/megaease/easeprobe/pull/245

Full Changelog: https://github.com/megaease/easeprobe/compare/v1.9.0...v2.0.0

Changed Logs

Feature

Major Features

• Support RingCentral webhook by @onyas in https://github.com/megaease/easeprobe/pull/217
• Support multiple yaml config files by @samanhappy in https://github.com/megaease/easeprobe/pull/218
• Support the failure/success threshold for probe by @haoel in https://github.com/megaease/easeprobe/pull/233
• Support Minutely/Hourly SLA reports by @proditis in https://github.com/megaease/easeprobe/pull/236
• Add EASEPROBE_TIME to shell env by @zhzy0077 in https://github.com/megaease/easeprobe/pull/232
• Add a command to generate JSON Schema by @haoel in https://github.com/megaease/easeprobe/pull/213

Bug-fixings

• Fix the link error in README.md, and slightly refine the sentence by @haoel in https://github.com/megaease/easeprobe/pull/211
• bug-fixing: http probe report the unsupported document type by @haoel in https://github.com/megaease/easeprobe/pull/235
• fix the timezone for the SLA Report by @haoel in https://github.com/megaease/easeprobe/pull/237
• Remove Slack's hard-coded channel name to fix the old "incoming webhook" channel not found error. by @haoel in https://github.com/megaease/easeprobe/pull/238

Non-Functional

• Add JSON schema update GitHub action by @haoel in https://github.com/megaease/easeprobe/pull/214
• Using go 1.19 to run a unit test by @haoel in https://github.com/megaease/easeprobe/pull/227
• Using retry loop to remove the temp dir by @haoel in https://github.com/megaease/easeprobe/pull/228
• Embed git tags as Version into Go binary, so the EaseProbe version would be generated automatically. by @haoel in https://github.com/megaease/easeprobe/pull/238

New Contributors

• @onyas made their first contribution in https://github.com/megaease/easeprobe/pull/217
• @zhzy0077 made their first contribution in https://github.com/megaease/easeprobe/pull/232

Full Changelog: https://github.com/megaease/easeprobe/compare/v1.8.0...v1.9.0

Changed Logs

Features

Major Features

• Support the XPath/RegExp Data Extractor and Expression Evaluation for HTTP Probe by @haoel in https://github.com/megaease/easeprobe/pull/192
• Support Dingtalk notification for sign secret by @samanhappy in https://github.com/megaease/easeprobe/pull/190 https://github.com/megaease/easeprobe/pull/191
• Support proxy config and env vars for HTTP, TCP and TLS Probers by @haoel in https://github.com/megaease/easeprobe/pull/194
• Support customized host header by @xiaomao87 in https://github.com/megaease/easeprobe/pull/198

Bug-fixings

• fix some typos by @cuishuang in https://github.com/megaease/easeprobe/pull/180
• change log.Fatal to log.Error to make subsequent os.Exit executable by @Abirdcfly in https://github.com/megaease/easeprobe/pull/189
• Fix the go 1.19 build error by @haoel in https://github.com/megaease/easeprobe/pull/196

Non-Functional

• Add more test cases by @haoel in https://github.com/megaease/easeprobe/pull/197, https://github.com/megaease/easeprobe/pull/199 and https://github.com/megaease/easeprobe/pull/200
• Refactoring the README.md by @haoel in https://github.com/megaease/easeprobe/pull/210

New Contributors

• @cuishuang made their first contribution in https://github.com/megaease/easeprobe/pull/180
• @Abirdcfly made their first contribution in https://github.com/megaease/easeprobe/pull/189
• @samanhappy made their first contribution in https://github.com/megaease/easeprobe/pull/190
• @xiaomao87 made their first contribution in https://github.com/megaease/easeprobe/pull/198

Full Changelog: https://github.com/megaease/easeprobe/compare/v1.7.0...v1.8.0

Changed Logs

Features

Major Features

• Support regexp output check for http/shell/ssh probe by @haoel in https://github.com/megaease/easeprobe/pull/169
• Support MySQL/Redis/MongoDB/PostgreSQL/Zookeeper Native Client to check the data by @haoel in https://github.com/megaease/easeprobe/pull/171
• Support the proxy for HTTP probe and can customize the User-Agent by @haoel in https://github.com/megaease/easeprobe/pull/177
• Add HTTP Probe trace time metrics by @haoel in https://github.com/megaease/easeprobe/pull/150
• Add the passphrase config for HTTPS private key by @zhangjunjie6b in https://github.com/megaease/easeprobe/pull/174
• Add more query filter options for SLA HTML and JSON API by @haoel in https://github.com/megaease/easeprobe/pull/152 & https://github.com/megaease/easeprobe/pull/158
• Support time zone configuration by @haoel in https://github.com/megaease/easeprobe/pull/167

Enhancement

• Enhancement: Equally distributing starts the probers. by @haoel in https://github.com/megaease/easeprobe/pull/157 & @proditis in https://github.com/megaease/easeprobe/pull/160
• set the SO_LINGER=0 to TCP, HTTP, TLS, SSH probe by @haoel in https://github.com/megaease/easeprobe/pull/159

Non-Functional

• EaseProbe Benchmark Test Report by @haoel in https://github.com/megaease/easeprobe/pull/161

Bug fixing

• Fix the concurrent map access crashing problem by @haoel in https://github.com/megaease/easeprobe/pull/162
• Fix Lark(Feishu) notifications don't work by @xhkyyy in https://github.com/megaease/easeprobe/pull/170

Trivial

• Using the default const value replace the hard code by @haoel in https://github.com/megaease/easeprobe/pull/151
• Add an example config.yaml in Getting Start by @haoel in https://github.com/megaease/easeprobe/pull/164
• Slightly optimizing the log and adding a few unit test cases by @haoel in https://github.com/megaease/easeprobe/pull/168
• Change the getInt() and getFloat() to generic function by @haoel in https://github.com/megaease/easeprobe/pull/173

New Contributors

• @xhkyyy made their first contribution in https://github.com/megaease/easeprobe/pull/170
• @zhangjunjie6b made their first contribution in https://github.com/megaease/easeprobe/pull/174

Full Changelog: https://github.com/megaease/easeprobe/compare/v1.6.0...v1.7.0

Changed Logs

Features

Major Features

• Introduce the Channel to connect the probers and notifiers @haoel in https://github.com/megaease/easeprobe/pull/108
• introduce TLS probe by @tg123 in https://github.com/megaease/easeprobe/pull/110, https://github.com/megaease/easeprobe/pull/139
• Introduce Teams support by @tg123 in https://github.com/megaease/easeprobe/pull/109
• Introduce the Syslog notification by @haoel in https://github.com/megaease/easeprobe/pull/129
• Introduce the Shell notification by @haoel in https://github.com/megaease/easeprobe/pull/130
• Introduce the Memcache client Probe by @proditis in https://github.com/megaease/easeprobe/pull/138
• Support multiple disks usage check for host probe by @haoel in https://github.com/megaease/easeprobe/pull/147

Enhancement

• Add go ver and git SHA to version by @tg123 in https://github.com/megaease/easeprobe/pull/142
• Add an option to disable the HTTPS security checks by @haoel in https://github.com/megaease/easeprobe/pull/145
• Detecting the duplicated name and log the error message by @haoel in https://github.com/megaease/easeprobe/pull/131
• Add env and clean_env for shell notification and probe by @haoel in https://github.com/megaease/easeprobe/pull/136
• Remove probes with fail config by @proditis in https://github.com/megaease/easeprobe/pull/137

Non-Functional

• Add Unit Test Cases by @haoel in https://github.com/megaease/easeprobe/pull/118, https://github.com/megaease/easeprobe/pull/119, https://github.com/megaease/easeprobe/pull/127, https://github.com/megaease/easeprobe/pull/128,
• Add contributing guide by @proditis in https://github.com/megaease/easeprobe/pull/114
• Refactoring the Notify interface to align with the Probe interface by @haoel in https://github.com/megaease/easeprobe/pull/115
• Add the license check in Github Action by @haoel in https://github.com/megaease/easeprobe/pull/112
• Documentation update by by @proditis in https://github.com/megaease/easeprobe/pull/133, @haoel in https://github.com/megaease/easeprobe/pull/132, https://github.com/megaease/easeprobe/pull/140
• disable CGO to build static executable by @hellojukay in https://github.com/megaease/easeprobe/pull/141

Bug fixing

• slack notify timeout should not be hard coded by @haoel in https://github.com/megaease/easeprobe/pull/113
• Using DurationStr() format Discord Uptime and DownTime by @haoel in https://github.com/megaease/easeprobe/pull/148

New Contributors

• @tg123 made their first contribution in https://github.com/megaease/easeprobe/pull/109
• @hellojukay made their first contribution in https://github.com/megaease/easeprobe/pull/141

Full Changelog: https://github.com/megaease/easeprobe/compare/v1.5.0...v1.6.0

Change Logs

Features

Functional

• SMS alert services support. Support Twilio, Vonage, and YunPian PR #60
• Support for keyword matching inside the body of HTTP responses PR #80
• Customizable name and icon to be used by notifications PR #79
• Support from-email in yaml if specified PR #96
• Support for using URL as configuration file. PR #97
• Support ?refresh=30s for SLA HTML page. PR #94

Non-Functional

• Persistence of SLA data.yaml. The default behavior for EaseProbe is now to create a file at $CWD/data/data.yaml with SLA details that should persist between restarts. If you don't want that behavior make sure you disable it explicitly. PR #81 #85 #92
• Support to export the metrics to Prometheus. Supports probe status, duration, total, and the metrics for particular probe, like cpu, memory, and disk for host probe. PR #95
• Introduing the easeprobe.pid. The default behavior for EaseProbe is now to create a file at $CWD/easeprobe.pid with the process id number to assist in administering the daemon. PR #75
• Log file rotation. Support EaseProbe log and access log self-rotation and outside rotation (e.g. logrotate) PR #74 #75
• Versionizing the binary, config, data file. PR #100

Bug Fixies & Small Improvements

• The API URL doesn't work with a / at the end by @proditis in https://github.com/megaease/easeprobe/pull/62
• Correct the $PROBE_CONFIG assignment in entrypoint.sh by @haoel in https://github.com/megaease/easeprobe/pull/86
• EaseProbe exits if the Web Server address is already in use by @haoel in https://github.com/megaease/easeprobe/pull/90
• Content is truncated to send markdown msg on Wecom webhook(#101) by @jordy1024 in https://github.com/megaease/easeprobe/pull/103
• Redirect df stderr to /dev/null and limit to rootfs / by @proditis in https://github.com/megaease/easeprobe/pull/61
• Minor Dockerfile/entrypoint.sh edit and documentation updates by @proditis in https://github.com/megaease/easeprobe/pull/84

Documentation

• Initial roadmap draft by @proditis in https://github.com/megaease/easeprobe/pull/78
• update the roadmap to reflect current plans by @proditis in https://github.com/megaease/easeprobe/pull/107
• update README.md link to host.go by @proditis in https://github.com/megaease/easeprobe/pull/58
• Document changes from #36 by @proditis in https://github.com/megaease/easeprobe/pull/59
• Update the Overview Diagram and Using the Chi as Web Framework by @haoel in https://github.com/megaease/easeprobe/pull/72
• Fix typo in README by @youniverse-zhao in https://github.com/megaease/easeprobe/pull/77
• Fix typo by @Allenxuxu in https://github.com/megaease/easeprobe/pull/67

CI

• Add CI yaml by @Allenxuxu in https://github.com/megaease/easeprobe/pull/68
• Add the code lint tool in CI by @haoel in https://github.com/megaease/easeprobe/pull/71
• CI workflow restore GITHUB_WORKSPACE permissions by @proditis in https://github.com/megaease/easeprobe/pull/106

New Contributors

• @proditis made their first contribution in https://github.com/megaease/easeprobe/pull/58
• @Allenxuxu made their first contribution in https://github.com/megaease/easeprobe/pull/67
• @nullsimon made their first contribution in https://github.com/megaease/easeprobe/pull/60
• @youniverse-zhao made their first contribution in https://github.com/megaease/easeprobe/pull/77
• @SuperK- made their first contribution in https://github.com/megaease/easeprobe/pull/96
• @jordy1024 made their first contribution in https://github.com/megaease/easeprobe/pull/103

Full Changelog: https://github.com/megaease/easeprobe/compare/v1.4.0...v1.5.0

Change Logs

Features

• Add fetch config from the internet by @gelleson in https://github.com/megaease/easeprobe/pull/36
• Add the downtime for recovery notification https://github.com/megaease/easeprobe/pull/44
• Support the SLA Live Report & Add Overview Diagram https://github.com/megaease/easeprobe/pull/51
• Support custom preferred response code for HTTP probe by @douglarek in https://github.com/megaease/easeprobe/pull/53

Release Package

• Support the arm64 docker image https://github.com/megaease/easeprobe/pull/50
• Support the OpenBSD platform https://github.com/megaease/easeprobe/pull/55

Bug Fixings

• MySQL client connection leaks https://github.com/megaease/easeprobe/pull/57

Code Refactory

• remove function configNotifiers useless parameters by @wuqinqiang in https://github.com/megaease/easeprobe/pull/46

New Contributors

• @wuqinqiang made their first contribution in https://github.com/megaease/easeprobe/pull/46
• @douglarek made their first contribution in https://github.com/megaease/easeprobe/pull/53

Full Changelog: https://github.com/megaease/easeprobe/compare/v1.3.0...v1.4.0

Change Logs

Features

• Notify: Support Lark(Feishu) notification. #39
• Notify: Support dingtalk notification. #23
• Probe: Support SSH Probe and support the bastion/jumper #29, #33
• Probe: Support host resource usage probe #40
• Configuration: Support enviornment variables in yaml #34

Bug Fixing

• Fix gorelease problem - add CGO_ENABLED=0 https://github.com/megaease/easeprobe/pull/26
• Fix the null pointer exception when TLS is not configured https://github.com/megaease/easeprobe/pull/31

Code Refertory

• Probe & Notification Abstration #25 #27 #28 #29
• Make function generic by upgrading to Go 1.18 #18
• Refactor the Docker entrypoint.sh #22
• Refactory the Dockerfile #21 #37

New Contributors

• @zhangtaomox made their first contribution in https://github.com/megaease/easeprobe/pull/23
• @muicoder made their first contribution in https://github.com/megaease/easeprobe/pull/31
• @gelleson made their first contribution in https://github.com/megaease/easeprobe/pull/34
• @tigerlee made their first contribution in https://github.com/megaease/easeprobe/pull/39

Full Changelog: https://github.com/megaease/easeprobe/compare/v1.2.0...v1.3.0

Change Logs

• Support Zookeeper Native Client mTLS Probe #8
• Support Telegram Notification #7
• Support AWS SNS Notification #12
• Support WeChat Work Notification #14
• Move the debug option from settings to settings.sla #9

Thanks for @HessTina-YuI and @xiekeyi98 contributing to the Zookeeper probe and WeChat Work notification.

Change Logs

• Support PostgreSQL probe (#3)
• Support Telegram notification. (#7)
• Support the avatar & thumbnail customization for discord notification (#7)
• Add the name and timeout for notification (#7)
• Refactory the notify retry function (#7)

Thanks for @ken8203 contributing the PostgreSQL probe

Release Notes

EaseProbe would do 3 kinds of works - Probe, Notify and Report.

1. Probe - Ease Probe supports the following probing methods:

• HTTP. Checking the HTTP status code, Support mTLS, HTTP Basic Auth, and can set the Request Header/Body.
• TCP. Just simply check the TCP connection can be established or not.
• Shell. Run a Shell command and check the result.)
• Client. Currently, support the following native client. Support the mTLS.
  • MySQL. Connect to the MySQL server and run the SHOW STATUS SQL.
  • Redis. Connect to the Redis server and run the PING command.
  • MongoDB. Connect to MongoDB server and just ping server.
  • Kafka. Connect to Kafka server and list all topics.

2. Notification - EaseProbe supports the following notifications:

• Email. Support multiple email addresses.
• Slack. Using Webhook for notification
• Discord. Using Webhook for notification
• Log File. Write the notification into a log file

3. Report

• SLA Report. EaseProbe would send the daily, weekly or monthly SLA report.