Migrate from Standard pprof to Pyroscope for Continuous Profiling (#2830)

* Add migration from standard pprof to pyroscope

* Update examples/golang-push/migrating-from-standard-pprof/README.md

Co-authored-by: Kim Nylander <[email protected]>

* Update examples/golang-push/migrating-from-standard-pprof/README.md

Co-authored-by: Kim Nylander <[email protected]>

* Update examples/golang-push/migrating-from-standard-pprof/README.md

Co-authored-by: Kim Nylander <[email protected]>

* Update examples/golang-push/migrating-from-standard-pprof/README.md

Co-authored-by: Kim Nylander <[email protected]>

* Update examples/golang-push/migrating-from-standard-pprof/README.md

Co-authored-by: Kim Nylander <[email protected]>

* Update README.md

* Update main.go

* Update README.md

* Update examples/golang-push/migrating-from-standard-pprof/README.md

Co-authored-by: Kim Nylander <[email protected]>

* Update examples/golang-push/migrating-from-standard-pprof/README.md

Co-authored-by: Kim Nylander <[email protected]>

* Update README.md

* Update formatting

* Add more benefits to README.md

---------

Co-authored-by: Kim Nylander <[email protected]>

Author: Rperry2174

examples/golang-push/migrating-from-standard-pprof/README.md

@@ -0,0 +1,44 @@
+# Migrating from standard pprof to Pyroscope in a Go application
+
+This README provides a comprehensive guide on migrating from the standard pprof library to Pyroscope in a Go application. The example demonstrates the transition within a detective-themed Go application, enhancing the process of profiling with Pyroscope's advanced capabilities. The actual changes needed to migrate from standard `pprof` to using the Pyroscope SDK is very simple (it extends the standard pprof library with extra functionality and performance improvements).
+
+See link to [source PR here](https://github.com/grafana/pyroscope/pull/2830)
+<img width="1426" alt="image" src="https://github.com/grafana/pyroscope/assets/23323466/f094399a-4a4d-4b47-9f03-5a15b4085fab">
+
+## Changes made
+
+### Pre-Pyroscope setup
+
+Originally in the pre-pyroscope code, the `main.go` file used the standard `net/http/pprof` package for profiling. This setup is common and straightforward but lacks continuous profiling and real-time analysis capabilities.
+
+### Post-Pyroscope migration
+
+In the post-pyroscope code, to leverage the advanced features of Pyroscope, we made the following changes:
+
+1. **Removed Standard pprof Import:** The `_ "net/http/pprof"` import was removed, as Pyroscope replaces its functionality.
+2. **Added Pyroscope SDK:** We installed the Pyroscope module using `go get github.com/grafana/pyroscope-go` and imported it in our `main.go`.
+3. **Configured Pyroscope:** Inside the `main()` function, we set up Pyroscope using the `pyroscope.Start()` method with the following configuration:
+   - Application name and server address.
+   - Logger configuration.
+   - Tags for additional metadata.
+   - Profile types to be captured.
+4. Consider using [godeltaprof](https://pkg.go.dev/github.com/grafana/pyroscope-go/godeltaprof) -- which is an optimized way to do memory profiling more efficiently
+
+## Benefits of using Pyroscope
+
+- **Continuous Profiling:** Pyroscope offers continuous, always-on profiling, allowing real-time performance analysis.
+- **Advanced support:** Support for advanced features such as trace-span profiling, tags/labels, and controlling profiling with code.
+- **Higher efficiency:** Less ressource consumed by sending delta instead of cumulative profiles.
+- **Enhanced Insights:** With Pyroscope, you gain deeper insights into your application's performance, helping to identify and resolve issues more effectively.
+- **Easy Integration:** Migrating to Pyroscope requires minimal changes and provides a more robust profiling solution with little overhead.
+- **Customizable Profiling:** Pyroscope enables more granular control over what gets profiled, offering a range of profiling types.
+
+## Migration guide
+
+To view the exact changes made during the migration, refer to our [pull request](https://github.com/grafana/pyroscope/pull/2830). This PR clearly illustrates the differences and necessary steps to transition from standard pprof to Pyroscope.
+
+## Conclusion
+
+Migrating to Pyroscope SDK in a Go application is a straightforward process that significantly enhances profiling capabilities. By following the steps outlined in this guide and reviewing the provided PR, developers can easily switch from standard pprof to Pyroscope, benefiting from real-time, continuous profiling and advanced performance insights.
+
+

examples/golang-push/migrating-from-standard-pprof/main.go

@@ -3,10 +3,12 @@ package main
 import (
 	"fmt"
 	"net/http"
+	"os"
+	"runtime"
 	"sync"
 	"time"
 
-	_ "net/http/pprof" // Standard way of adding pprof to your server
+	"github.com/grafana/pyroscope-go" // replace "net/http/pprof" with Pyroscope SDK
 )
 
 func busyWork(d time.Duration) {
@@ -47,6 +49,32 @@ func solveMystery(wg *sync.WaitGroup) {
 }
 
 func main() {
+	// Pyroscope configuration
+	runtime.SetMutexProfileFraction(5)
+	runtime.SetBlockProfileRate(5)
+
+	pyroscope.Start(pyroscope.Config{
+		ApplicationName: "detective.mystery.app",
+		ServerAddress:   "https://profiles-prod-001.grafana.net", // if OSS then http://localhost:4040
+		// Optional HTTP Basic authentication
+		BasicAuthUser:     "<User>",     // 900009
+		BasicAuthPassword: "<Password>", // glc_SAMPLEAPIKEY0000000000==
+		Logger:            pyroscope.StandardLogger,
+		Tags:              map[string]string{"hostname": os.Getenv("HOSTNAME")},
+		ProfileTypes: []pyroscope.ProfileType{
+			pyroscope.ProfileCPU,
+			pyroscope.ProfileAllocObjects,
+			pyroscope.ProfileAllocSpace,
+			pyroscope.ProfileInuseObjects,
+			pyroscope.ProfileInuseSpace,
+			pyroscope.ProfileGoroutines,
+			pyroscope.ProfileMutexCount,
+			pyroscope.ProfileMutexDuration,
+			pyroscope.ProfileBlockCount,
+			pyroscope.ProfileBlockDuration,
+		},
+	})
+
 	var wg sync.WaitGroup
 
 	// Server for pprof