golang/go

doc: explain what custom pprof profiles are and why they are useful

Open

#23,144 opened on Dec 14, 2017

View on GitHub
 (1 comment) (5 reactions) (0 assignees)Go (19,008 forks)batch import
DocumentationNeedsFixhelp wanted

Repository metrics

Stars
 (133,883 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Diagnostics page is briefly mentioning custom profiles but failing to give any introduction for those who doesn't know why custom profiles are useful. Explain custom profiles and share a few sample use cases.

Contributor guide

Research direction
Review the Go diagnostics documentation, particularly the section on custom pprof profiles, and write a clear explanation of what they are and why they are useful, with examples.
Tech stack
go
Domain
performance
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Go
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90