Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/giannisalinetti/metrics-go
https://github.com/giannisalinetti/metrics-go
Last synced: 11 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/giannisalinetti/metrics-go
- Owner: giannisalinetti
- License: apache-2.0
- Created: 2018-08-11T15:58:31.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-08-12T13:49:04.000Z (over 6 years ago)
- Last Synced: 2024-10-28T06:50:14.553Z (about 2 months ago)
- Language: Go
- Size: 12.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Metrics-go: a minimal tool for memory metrics collection
Metrics-go is a lab project to investigate on the **runtime** package
features.
The project idea started from this article:
The initial basic idea was extended with the usage of separate goroutines to
get and print the output, an interface for future expand of the package and a demo
main funcion.
The main program just runs a stub function that prints a simple message on
standard output long with the metrics in a simple log format.
The main program can handle the metrics in a separate file:
```
$ go run main.go -o /tmp/metrics.log
Starting memory stats collector.
Doing some crazy stuff to entertain you...
Doing some crazy stuff to entertain you...
Doing some crazy stuff to entertain you...
Doing some crazy stuff to entertain you...
Doing some crazy stuff to entertain you...
Stopping stats printer.
Stopping memory stats collector.
$ cat /tmp/metrigs.log
2018/08/12 15:38:41 {"Alloc":83888,"TotalAlloc":83888,"Sys":1740800,"Mallocs":214,"Frees":2,"LiveObjects":212,"PauseTotalNs":0,"NumGC":0,"NumGoroutine":3}
2018/08/12 15:38:42 {"Alloc":106232,"TotalAlloc":106232,"Sys":1740800,"Mallocs":352,"Frees":24,"LiveObjects":328,"PauseTotalNs":0,"NumGC":0,"NumGoroutine":3}
2018/08/12 15:38:43 {"Alloc":107336,"TotalAlloc":107336,"Sys":1740800,"Mallocs":360,"Frees":24,"LiveObjects":336,"PauseTotalNs":0,"NumGC":0,"NumGoroutine":3}
2018/08/12 15:38:44 {"Alloc":108248,"TotalAlloc":108248,"Sys":1740800,"Mallocs":366,"Frees":24,"LiveObjects":342,"PauseTotalNs":0,"NumGC":0,"NumGoroutine":3}
2018/08/12 15:38:45 {"Alloc":109160,"TotalAlloc":109160,"Sys":1740800,"Mallocs":372,"Frees":24,"LiveObjects":348,"PauseTotalNs":0,"NumGC":0,"NumGoroutine":3}
```
If called without arguments the program uses **os.Stdout** as default output:
```
$ go run main.go
Starting memory stats collector.
Doing some crazy stuff to entertain you...
2018/08/11 17:53:19 {"Alloc":82968,"TotalAlloc":82968,"Sys":1740800,"Mallocs":202,"Frees":2,"LiveObjects":200,"PauseTotalNs":0,"NumGC":0,"NumGoroutine":3}
Doing some crazy stuff to entertain you...
2018/08/11 17:53:20 {"Alloc":105568,"TotalAlloc":105568,"Sys":1740800,"Mallocs":342,"Frees":24,"LiveObjects":318,"PauseTotalNs":0,"NumGC":0,"NumGoroutine":3}
Doing some crazy stuff to entertain you...
2018/08/11 17:53:21 {"Alloc":106480,"TotalAlloc":106480,"Sys":1740800,"Mallocs":348,"Frees":24,"LiveObjects":324,"PauseTotalNs":0,"NumGC":0,"NumGoroutine":3}
Doing some crazy stuff to entertain you...
2018/08/11 17:53:22 {"Alloc":107392,"TotalAlloc":107392,"Sys":1740800,"Mallocs":354,"Frees":24,"LiveObjects":330,"PauseTotalNs":0,"NumGC":0,"NumGoroutine":3}
Doing some crazy stuff to entertain you...
2018/08/11 17:53:23 {"Alloc":108304,"TotalAlloc":108304,"Sys":1740800,"Mallocs":360,"Frees":24,"LiveObjects":336,"PauseTotalNs":0,"NumGC":0,"NumGoroutine":3}
Stopping stats printer.
Stopping memory stats collector.
```
The package can be easily included in custom code for more exciting tests.
### TODO
- Adopt the **logrus** package
- Add tests in the package
### Author
Gianni Salinetti