Oct 15, 2024 · Oct 14, 2024
diff --git a/main.go b/main.go
 //go:generate go run github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs

 func main() {
 servePprof()
 plugin.Serve(&plugin.ServeOpts{
 ProviderFunc: provider.New,
 })
diff --git a/pprof_unix.go b/pprof_unix.go
 //go:build !windows

 package main

 import (
 "net"
 "net/http"
 "net/http/pprof"
 "os"
 )

 // servePprof starts an HTTP server running the pprof goroutine handler on a local unix domain socket. As described in
 // https://github.com/coder/coder/issues/14726 it appears this process is sometimes hanging, unable to exit cleanly,
 // and this prevents additional Coder builds that try to reinstall this provider.  A goroutine dump should allow us to
 // determine what is hanging.
 //
 // This function is best-effort, and just returns early if we fail to set up the directory/listener. We don't want to
 // block the normal functioning of the provider.
 func servePprof() {
 // Coder runs terraform in a per-build subdirectory of the work directory.  The per-build subdirectory uses a
 // generated name and is deleted at the end of a build, so we want to place our unix socket up one directory level
 // in the provisionerd work directory, so we can connect to it from provisionerd.
 err := os.Mkdir("../.coder", 0o700)
 if err != nil && !os.IsExist(err) {
 return
 }

 // remove the old file, if it exists. It's probably from the last run of the provider
 if err = os.Remove("../.coder/pprof"); err != nil && !os.IsNotExist(err) {
 return
 }
 l, err := net.Listen("unix", "../.coder/pprof")
 if err != nil {
 return
 }
 mux := http.NewServeMux()
 mux.Handle("/debug/pprof/goroutine", pprof.Handler("goroutine"))
 srv := http.Server{Handler: mux}
 go srv.Serve(l)
 // We just leave the server and domain socket up forever. Go programs exit when the `main()` function returns, so
 // this won't block exiting, and it ensures the pprof server stays up for the entire lifetime of the provider.
 }
diff --git a/pprof_windows.go b/pprof_windows.go
 //go:build windows

 package main

 // servePprof is not supported on Windows
 func servePprof() {}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -11,6 +11,7 @@ import (
		//go:generate go run github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs

		func main() {
		servePprof()
		plugin.Serve(&plugin.ServeOpts{
		ProviderFunc: provider.New,
		})
Expand Down
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,42 @@
		//go:build !windows

		package main

		import (
		"net"
		"net/http"
		"net/http/pprof"
		"os"
		)

		// servePprof starts an HTTP server running the pprof goroutine handler on a local unix domain socket. As described in
		// https://github.com/coder/coder/issues/14726 it appears this process is sometimes hanging, unable to exit cleanly,
		// and this prevents additional Coder builds that try to reinstall this provider. A goroutine dump should allow us to
		// determine what is hanging.
		//
		// This function is best-effort, and just returns early if we fail to set up the directory/listener. We don't want to
		// block the normal functioning of the provider.
		func servePprof() {
		// Coder runs terraform in a per-build subdirectory of the work directory. The per-build subdirectory uses a
		// generated name and is deleted at the end of a build, so we want to place our unix socket up one directory level
		// in the provisionerd work directory, so we can connect to it from provisionerd.
		err := os.Mkdir("../.coder", 0o700)
		if err != nil && !os.IsExist(err) {
		return
		}

		// remove the old file, if it exists. It's probably from the last run of the provider
		if err = os.Remove("../.coder/pprof"); err != nil && !os.IsNotExist(err) {
		return
		}
		l, err := net.Listen("unix", "../.coder/pprof")
		if err != nil {
		return
		}
		mux := http.NewServeMux()
		mux.Handle("/debug/pprof/goroutine", pprof.Handler("goroutine"))
		srv := http.Server{Handler: mux}
		go srv.Serve(l)
		// We just leave the server and domain socket up forever. Go programs exit when the `main()` function returns, so
		// this won't block exiting, and it ensures the pprof server stays up for the entire lifetime of the provider.
		}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,6 @@
		//go:build windows

		package main

		// servePprof is not supported on Windows
		func servePprof() {}