Skip to content

Added pprof profiling to monitor heap memory #318

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rutul25 wants to merge 16 commits into
base: master
Choose a base branch
from
Open

Added pprof profiling to monitor heap memory #318

Show file tree
Hide file tree
Changes from 14 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
2732aff
Added pprof profiling to monitor heap memory
rutul25 Mar 9, 2022
890412a
lint check improvement
rutul25 Mar 9, 2022
ff61064
added port for pprof
rutul25 Mar 9, 2022
3cdd82f
wip
rutul25 Mar 9, 2022
0f10480
kafka client configs
Mar 25, 2022
faecdaf
Introduce batch and report configs
Mar 29, 2022
ec318d7
Restrict channel size
Apr 4, 2022
58bdf45
Enable batch producer
Apr 4, 2022
b3385f6
Remove duplicate key
Apr 4, 2022
b7efb6a
Remove batch producer mode
Apr 5, 2022
9571cc1
Change debug level
Apr 5, 2022
9a7a49e
Remove debug logs
Apr 5, 2022
41dddd8
Increase channel size
Apr 5, 2022
f510472
lastest master
akashgoyal96 Jul 4, 2022
e1b36af
Merge branch 'master' of github.com:razorpay/metro into pprof-testing
akashgoyal96 Jul 5, 2022
59a641b
Merge branch 'master' into pprof-testing
Jul 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion build/docker/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ WORKDIR /app
RUN apk add --update --no-cache dumb-init su-exec ca-certificates curl
RUN mkdir -p /app/public

EXPOSE 8081 8082 8083 8084 3000
EXPOSE 8081 8082 8083 8084 3000 8080

RUN chmod +x entrypoint.sh probe.sh
ENTRYPOINT ["/app/entrypoint.sh", "metro"]
20 changes: 19 additions & 1 deletion cmd/service/metro/metro.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ import (
configreader "github.com/razorpay/metro/pkg/config"
"github.com/razorpay/metro/pkg/encryption"
"github.com/razorpay/metro/pkg/logger"

"net/http"

// blank import added for testing.
_ "net/http/pprof"

@github-actions github-actions Bot Jul 4, 2022

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [golangci] reported by reviewdog 🐶
G108: Profiling endpoint is automatically exposed on /debug/pprof (gosec)

)

const (
Expand All @@ -39,7 +44,7 @@ func isValidComponent(component string) bool {
}

// Init initializes all modules (logger, tracing, config, metro component)
func Init(_ context.Context, env string, componentName string) {
func Init(ctx context.Context, env string, componentName string) {
// componentName validation
ok := isValidComponent(componentName)
if !ok {
Expand Down Expand Up @@ -69,6 +74,8 @@ func Init(_ context.Context, env string, componentName string) {

err = boot.InitMonitoring(env, appConfig.App, appConfig.Sentry, appConfig.Tracing)

setPprofProfiles(ctx, componentName)

if err != nil {
log.Fatalf("error in setting up monitoring : %v", err)
}
Expand Down Expand Up @@ -119,3 +126,14 @@ func Run(ctx context.Context) {

logger.Ctx(ctx).Infow("stopped metro")
}

// sets up pprof profile for perfomance monitoring

@github-actions github-actions Bot Jul 4, 2022

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [golangci] reported by reviewdog 🐶
perfomance is a misspelling of performance (misspell)

func setPprofProfiles(ctx context.Context, componentName string) {
logger.Ctx(ctx).Infow("initialising pprof profiles")

@github-actions github-actions Bot Jul 4, 2022

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [golangci] reported by reviewdog 🐶
initialising is a misspelling of initializing (misspell)

go func() {
myMux := http.DefaultServeMux
if err := http.ListenAndServe("localhost:8080", myMux); err != nil {

@semgrep-app semgrep-app Bot Mar 9, 2022

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Found an HTTP server without TLS. Use 'http.ListenAndServeTLS' instead. See https://golang.org/pkg/net/http/#ListenAndServeTLS for more information.

🔴 Fix or ignore this finding to merge your pull request.
🙈 From go.lang.security.audit.net.use-tls.use-tls.

logger.Ctx(ctx).Fatalw("Error when starting or running %v pprof http server: %v", componentName, err)
}
}()
}