The highest tagged major version is v2.

status

package

v1.3.0 Latest Latest Go to latest Published: Aug 13, 2021 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/bar-counter/monitor

Links

Open Source Insights

Documentation ¶

Constants ¶

View Source

const (
	B  = 1
	KB = 1024 * B
	MB = 1024 * KB
	GB = 1024 * MB
)

Variables ¶

This section is empty.

Functions ¶

func CPUCheck ¶

func CPUCheck(c *gin.Context)

@Summary /status/cpu @Description HealthCheck CPUCheck checks the cpu usage. @Tags status @Success 200 "CPU OK server run ok" @failure 429 "CPU WARNING need check" @failure 500 "CPU CRITICAL must check" @Router /status/cpu [get]

func DiskCheck ¶

func DiskCheck(c *gin.Context)

@Summary /status/disk @Description HealthCheck DiskCheck checks the disk usage. @Tags status @Accept application/json @Produce application/json @Success 200 {object} status.Disk "value in monitor.status.Disk DISK OK less than 80% use, 80% to 90% is WARNING" @failure 429 {object} status.Disk "value in monitor.status.Disk DISK need check after 90%" @failure 500 "DISK CRITICAL must check!" @Router /status/disk [get]

func HealthCheck ¶

func HealthCheck(c *gin.Context)

@Summary /status/health @Description HealthCheck shows OK as the ping-pong result. @Tags status @Success 200 "OK" @Router /status/health [get]

func RAMCheck ¶

func RAMCheck(c *gin.Context)

@Summary /status/ram @Description HealthCheck RAMCheck checks the disk usage. @Tags status @Accept application/json @Produce application/json @Success 200 {object} status.RAM "value in monitor.status.RAM OK less than 80% use, 80% to 95% is WARNING" @failure 429 {object} status.RAM "value in monitor.status.RAM need check after 95%" @failure 500 "RAM CRITICAL must check!" @Router /status/ram [get]

Types ¶

type Disk ¶

type Disk struct {
	Info        string `json:"info,omitempty"`
	UsedMB      int    `json:"used_mb,omitempty"`
	UsedGB      int    `json:"used_gb,omitempty"`
	TotalMB     int    `json:"total_mb,omitempty"`
	TotalGB     int    `json:"total_gb,omitempty"`
	UsedPercent int    `json:"used_percent,omitempty"`
}

type RAM ¶

type RAM struct {
	Info        string `json:"info,omitempty"`
	UsedMB      int    `json:"used_mb,omitempty"`
	UsedGB      int    `json:"used_gb,omitempty"`
	TotalMB     int    `json:"total_mb,omitempty"`
	TotalGB     int    `json:"total_gb,omitempty"`
	UsedPercent int    `json:"used_percent,omitempty"`
}

Source Files ¶

View all Source files

status.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL