status-im/go-watchdog
2
0
Fork 0
mirror of https://github.com/status-im/go-watchdog.git synced 2025-01-28 10:14:58 +00:00
Code Issues Projects Releases Wiki Activity

add godocs link to README.

Browse Source
This commit is contained in:
Raúl Kripalani 2020-12-02 00:14:25 +00:00
parent a23c2f6944
commit 2181a740fb
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -2,6 +2,8 @@
> 🐺 A library to curb OOMs by running Go GC according to a user-defined policy. > 🐺 A library to curb OOMs by running Go GC according to a user-defined policy.
[![GoDoc](https://img.shields.io/badge/godoc-reference-5272B4.svg?style=flat-square)](https://godoc.org/github.com/raulk/go-watchdog)
go-watchdog runs a singleton memory watchdog. It takes system and heap memory go-watchdog runs a singleton memory watchdog. It takes system and heap memory
readings periodically, and feeds them to a user-defined policy to determine readings periodically, and feeds them to a user-defined policy to determine
whether GC needs to run immediately. whether GC needs to run immediately.
@ -10,7 +12,7 @@ This library ships with two policies out of the box:
* watermarks policy: runs GC at configured watermarks of system or heap memory * watermarks policy: runs GC at configured watermarks of system or heap memory
utilisation. utilisation.
* adaptive: runs GC when the current usage surpasses a dynamically-set * adaptive policy: runs GC when the current usage surpasses a dynamically-set
threshold. threshold.
You can easily build a custom policy tailored to the allocation patterns of your You can easily build a custom policy tailored to the allocation patterns of your