gosh

README

Go Statistics Handler

About

• This Repository is provided following functions.
  • Go runtime statistics struct.
  • Go runtime statistics API handler.
  • Go runtime measure method.

Install

$ go get -u github.com/osamingo/gosh

Usage

Example

package main

import (
	"log"
	"net/http"

	"github.com/osamingo/gosh"
)

func main() {

	mux := http.NewServeMux()
	mux.Handle("/healthz", gosh.NewStatisticsHandler())

	if err := http.ListenAndServe(":8080", mux); err != nil {
		log.Fatalln(err)
	}
}

Output

$ curl "localhost:8080/healthz" | jq .
{
  "timestamp": 1527317620,
  "go_version": "go1.10.2",
  "go_os": "darwin",
  "go_arch": "amd64",
  "cpu_num": 8,
  "goroutine_num": 6,
  "gomaxprocs": 8,
  "cgo_call_num": 1,
  "memory_alloc": 422272,
  "memory_total_alloc": 422272,
  "memory_sys": 3084288,
  "memory_lookups": 6,
  "memory_mallocs": 4720,
  "memory_frees": 71,
  "stack_inuse": 491520,
  "heap_alloc": 422272,
  "heap_sys": 1605632,
  "heap_idle": 401408,
  "heap_inuse": 1204224,
  "heap_released": 0,
  "heap_objects": 4649,
  "gc_next": 4473924,
  "gc_last": 0,
  "gc_num": 0,
  "gc_per_second": 0,
  "gc_pause_per_second": 0,
  "gc_pause": []
}

License

Released under the MIT License.

Documentation

Index

• func NewStatisticsHandler() http.Handler
• type Statistics
• type StatisticsHandler
  • func (sh *StatisticsHandler) MeasureRuntime() Statistics
  • func (sh *StatisticsHandler) ServeHTTP(w http.ResponseWriter, _ *http.Request)

Examples

• NewStatisticsHandler

Functions

func NewStatisticsHandler

func NewStatisticsHandler() http.Handler

NewStatisticsHandler returns new StatisticsHandler.

Example

package main

import (
	"encoding/json"
	"fmt"
	"log"
	"net/http"
	"net/http/httptest"
	"os"

	"github.com/osamingo/gosh"
)

func main() {

	const path = "/healthz"

	mux := http.NewServeMux()
	mux.Handle(path, gosh.NewStatisticsHandler())

	srv := httptest.NewServer(mux)
	defer srv.Close()

	resp, err := http.Get(srv.URL + path)
	if err != nil {
		log.Fatalln(err)
	}
	defer func() {
		if err := resp.Body.Close(); err != nil {
			fmt.Println(err)
			os.Exit(1)
		}
	}()

	if resp.StatusCode != http.StatusOK {
		fmt.Println("unexpect status code:", resp.StatusCode)
		os.Exit(1)
	}

	var s gosh.Statistics
	if err := json.NewDecoder(resp.Body).Decode(&s); err != nil {
		fmt.Println(err)
		os.Exit(1)
	}

	fmt.Printf("status_code: %d, has_gorutine: %t", resp.StatusCode, s.GoroutineNum > 0)

}

Output:
status_code: 200, has_gorutine: true

Types

type Statistics

type Statistics struct {
	Timestamp        int64     `json:"timestamp"`
	GoVersion        string    `json:"go_version"`
	GoOS             string    `json:"go_os"`
	GoArch           string    `json:"go_arch"`
	CPUNum           int       `json:"cpu_num"`
	GoroutineNum     int       `json:"goroutine_num"`
	Gomaxprocs       int       `json:"gomaxprocs"`
	CgoCallNum       int64     `json:"cgo_call_num"`
	MemoryAlloc      uint64    `json:"memory_alloc"`
	MemoryTotalAlloc uint64    `json:"memory_total_alloc"`
	MemorySys        uint64    `json:"memory_sys"`
	MemoryLookups    uint64    `json:"memory_lookups"`
	MemoryMallocs    uint64    `json:"memory_mallocs"`
	MemoryFrees      uint64    `json:"memory_frees"`
	StackInuse       uint64    `json:"stack_inuse"`
	HeapAlloc        uint64    `json:"heap_alloc"`
	HeapSys          uint64    `json:"heap_sys"`
	HeapIdle         uint64    `json:"heap_idle"`
	HeapInuse        uint64    `json:"heap_inuse"`
	HeapReleased     uint64    `json:"heap_released"`
	HeapObjects      uint64    `json:"heap_objects"`
	GCNext           uint64    `json:"gc_next"`
	GCLast           uint64    `json:"gc_last"`
	GCNum            uint32    `json:"gc_num"`
	GCPerSecond      float64   `json:"gc_per_second"`
	GCPausePerSecond float64   `json:"gc_pause_per_second"`
	GCPause          []float64 `json:"gc_pause"`
}

A Statistics has runtime information.

type StatisticsHandler

type StatisticsHandler struct {
	// contains filtered or unexported fields
}

A StatisticsHandler provides runtime information handler.

func (*StatisticsHandler) MeasureRuntime

func (sh *StatisticsHandler) MeasureRuntime() Statistics

MeasureRuntime accesses runtime information.

func (*StatisticsHandler) ServeHTTP

func (sh *StatisticsHandler) ServeHTTP(w http.ResponseWriter, _ *http.Request)

ServeHTTP implements http.Handler interface.