Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bygui86/multi-profile
Multi-profiling support package for Go
https://github.com/bygui86/multi-profile
Last synced: about 2 months ago
JSON representation
Multi-profiling support package for Go
- Host: GitHub
- URL: https://github.com/bygui86/multi-profile
- Owner: bygui86
- License: apache-2.0
- Created: 2020-10-02T08:52:26.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2020-10-14T16:00:46.000Z (about 4 years ago)
- Last Synced: 2024-06-21T00:17:42.074Z (7 months ago)
- Language: Go
- Size: 80.1 KB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# multi-profile
[](https://pkg.go.dev/github.com/bygui86/multi-profile)
[](https://github.com/bygui86/multi-profile/actions)
Multi-profiling support package for Go.
This project was inspired by [pkg/profile](https://github.com/pkg/profile) but there is a fundamental difference:
multi-profile offers the possibility to start multiple profiling at the same time.
## Installation
```shell script
go get github.com/bygui86/multi-profile
```
## Usage
Enabling profiling in your application is as simple as one line at the top of your main function.
For example:
```go
package main
import "github.com/bygui86/multi-profile/v2"
func main() {
defer profile.CPUProfile(&profile.Config{}).Start().Stop()
// ...
}
```
Using profile specific method, you can create the kind of profiling you want giving a Config as input.
```go
package main
import "github.com/bygui86/multi-profile/v2"
func main() {
defer profile.CPUProfile(&profile.Config{}).Start().Stop()
defer profile.MemProfile(&profile.Config{}).Start().Stop()
defer profile.GoroutineProfile(&profile.Config{}).Start().Stop()
// ...
}
```
`(i)️ INFO` see [examples](examples/) folder for all available profiles and samples.
`/!\ WARN` if not using `EnableInterruptHook` option (see below) ALWAYS remember to defer `Stop()` function,
otherwise the profile won't stop and flush to file properly.
## Options
`(i)️️ INFO` see [examples](examples/) for all usage samples.
### Path
You can customize the path in which a profile file is going to be written.
Use field `Path` and `UseTempPath` in the Config.
### Interruption hook
You can enable an interruption hook that runs a new goroutine waiting for interruption signals (syscall.SIGTERM,
syscall.SIGINT and os.Interrupt). If one of those signals arrives, the profiling packages stop the Profile and flushes
results to file. Enabling this option, you can avoid deferring Stop() function in the main.
Use `EnableInterruptHook` field in the Config.
### Quiet mode
You can suppress all logs.
Use field `Quiet` in the Config.
### Closer function
You can call a function right after stopping the profiling.
Use `CloserHook` field in the Config.
### Panic in case of profile failure
Per default the profile won't cause a panic in case of failure, it will simply log the error. In case you want to panic the whole application just set `PanicIfFail` to true in the Config.
## Contributing
I welcome pull requests, bug fixes and issue reports.
To propose an extensive change, please discuss it first by opening an issue.
## Thanks
- [pkg/profile](https://github.com/pkg/profile) for the base idea
- [shields.io](https://shields.io) for providing badges