https://github.com/osamingo/gosh

Provide Go Statistics Handler, Struct, Measure Method
https://github.com/osamingo/gosh

api go golang handler metrics monitoring statistics stats

Last synced: 2 months ago
JSON representation

Provide Go Statistics Handler, Struct, Measure Method

• Host: GitHub
• URL: https://github.com/osamingo/gosh
• Owner: osamingo
• License: mit
• Created: 2018-05-25T08:55:55.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-05-01T16:24:07.000Z (over 1 year ago)
• Last Synced: 2024-07-31T20:52:23.908Z (5 months ago)
• Topics: api, go, golang, handler, metrics, monitoring, statistics, stats
• Language: Go
• Homepage:
• Size: 26.4 KB
• Stars: 36
• Watchers: 0
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-go - gosh - Provide Go Statistics Handler, Struct, Measure Method. (Miscellaneous / Uncategorized)
• zero-alloc-awesome-go - gosh - Provide Go Statistics Handler, Struct, Measure Method. (Miscellaneous / Uncategorized)
• awesome-go - gosh - Go Statistics Handler - ★ 11 (Miscellaneous)
• awesome-go-extra - gosh - 05-25T08:55:55Z|2022-05-04T07:00:29Z| (Microsoft Office / Uncategorized)
• awesome-go-zh - gosh

README

        
# Go Statistics Handler

[![GitHub Actions](https://github.com/osamingo/gosh/workflows/CI/badge.svg?branch=master)](https://github.com/osamingo/gosh/actions?query=workflow%3ACI+branch%3Amaster)

[![codecov](https://codecov.io/gh/osamingo/gosh/branch/master/graph/badge.svg)](https://codecov.io/gh/osamingo/gosh)

[![Go Report Card](https://goreportcard.com/badge/github.com/osamingo/gosh)](https://goreportcard.com/report/github.com/osamingo/gosh)

[![GoDoc](https://godoc.org/github.com/osamingo/gosh?status.svg)](https://godoc.org/github.com/osamingo/gosh)

[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/osamingo/gosh/master/LICENSE)

## About

- The `gosh` is an abbreviation for Go Statistics Handler.

- This Repository is provided following functions.

  - Go runtime statistics struct.

  - Go runtime statistics API handler.

  - Go runtime measure method.

- You can specify the favorite JSON encoder.

  - [`encoding/json`](https://pkg.go.dev/encoding/json/) package.

  - [`goccy/go-json`](https://pkg.go.dev/github.com/goccy/go-json) package.

  - The original package you created, and so on.

## Install

```bash

$ go get github.com/osamingo/gosh@latest

```

## Usage

### Example

```go

package main

import (

	"encoding/json"

	"io"

	"log"

	"net/http"

	"github.com/osamingo/gosh"

)

func main() {

	h, err := gosh.NewStatisticsHandler(func(w io.Writer) gosh.JSONEncoder {

		return json.NewEncoder(w)

	})

	if err != nil {

		log.Fatalln(err)

	}

	mux := http.NewServeMux()

	mux.Handle("/healthz", h)

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

		log.Fatalln(err)

	}

}

```

### Output

```bash

$ 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](https://github.com/osamingo/gosh/blob/master/LICENSE).