README.md: add a section about Go profiling

This commit is contained in:
Aliaksandr Valialkin 2019-08-23 13:36:56 +03:00
parent 98419c00ef
commit dce6079379

View File

@ -88,6 +88,7 @@ Cluster version is available [here](https://github.com/VictoriaMetrics/VictoriaM
- [Monitoring](#monitoring) - [Monitoring](#monitoring)
- [Troubleshooting](#troubleshooting) - [Troubleshooting](#troubleshooting)
- [Backfilling](#backfilling) - [Backfilling](#backfilling)
- [Profiling](#profiling)
- [Roadmap](#roadmap) - [Roadmap](#roadmap)
- [Contacts](#contacts) - [Contacts](#contacts)
- [Community and contributions](#community-and-contributions) - [Community and contributions](#community-and-contributions)
@ -691,6 +692,25 @@ historical data with timestamps from the past, since the cache assumes that the
the current timestamps. Query cache can be enabled after the backfilling is complete. the current timestamps. Query cache can be enabled after the backfilling is complete.
### Profiling
VictoriaMetrics provides handlers for collecting the following [Go profiles](https://blog.golang.org/profiling-go-programs):
- Memory profile. It can be collected with the following command:
```
curl -s http://<victoria-metrics-host>:8428/debug/pprof/heap > mem.pprof
```
- CPU profile. It can be collected with the following command:
```
curl -s http://<victoria-metrics-host>:8428/debug/pprof/profile > cpu.pprof
```
The command for collecting CPU profile waits for 30 seconds before returning.
The collected profiles may be analyzed with [go tool pprof](https://github.com/google/pprof).
## Roadmap ## Roadmap
- [ ] Replication [#118](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/118) - [ ] Replication [#118](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/118)