Merge pull request #1504 from kakkoyun/add_flag_to_disable_jit_sym

symbolizer: Add flag to disable JIT symbolization

Author: javierhonduco

Makefile

@@ -123,7 +123,7 @@ $(OUT_BIN_DEBUG): libbpf $(filter-out *_test.go,$(GO_SRC)) go/deps | $(OUT_DIR)
 
 .PHONY: build-dyn
 build-dyn: $(OUT_BPF) libbpf
-	$(GO_ENV) CGO_CFLAGS="$(CGO_CFLAGS_DYN)" CGO_LDFLAGS="$(CGO_LDFLAGS_DYN)" $(GO) build $(SANITIZERS) $(GO_BUILD_FLAGS) -o $(OUT_DIR)/parca-agent-dyn ./cmd/parca-agent
+	$(GO_ENV) CGO_CFLAGS="$(CGO_CFLAGS_DYN)" CGO_LDFLAGS="$(CGO_LDFLAGS_DYN)" $(GO) build $(SANITIZERS) $(GO_BUILD_FLAGS) -o $(OUT_DIR)/parca-agent ./cmd/parca-agent
 
 $(OUT_BIN_EH_FRAME): go/deps
 	find dist -exec touch -t 202101010000.00 {} +
@@ -312,9 +312,10 @@ internal/pprof:
 	rm -rf tmp
 
 # other artifacts:
-$(OUT_DIR)/help.txt: $(OUT_BIN)
+$(OUT_DIR)/help.txt:
 	# The default value of --node is dynamic and depends on the current host's name
 	# so we replace it with something static.
+	rm -f tmp/help.txt
 	$(OUT_BIN) --help | sed 's/--node=".*" */--node="hostname"           /' >$@
 
 DOC_VERSION := "latest"

README.md

@@ -61,7 +61,8 @@ Flags:
       --log-format="logfmt"        Configure if structured logging as JSON or as
                                    logfmt
       --http-address=":7071"       Address to bind HTTP server to.
-      --node="hostname"           The name of the node that the process is
+      --node="hostname"           
+                                   The name of the node that the process is
                                    running on. If on Kubernetes, this must match
                                    the Kubernetes node name.
       --config-path=""             Path to config file.
@@ -115,6 +116,7 @@ Flags:
       --debuginfo-upload-timeout-duration=2m
                                    The timeout duration to cancel upload
                                    requests.
+      --symbolizer-jit-disable     Disable JIT symbolization.
       --dwarf-unwinding-disable    Do not unwind using .eh_frame information.
       --dwarf-unwinding-use-polling
                                    Poll procfs to generate the unwind

cmd/parca-agent/main.go

@@ -107,6 +107,7 @@ type flags struct {
 	LocalStore     FlagsLocalStore     `embed:"" prefix:"local-store-"`
 	RemoteStore    FlagsRemoteStore    `embed:"" prefix:"remote-store-"`
 	Debuginfo      FlagsDebuginfo      `embed:"" prefix:"debuginfo-"`
+	Symbolizer     FlagsSymbolizer     `embed:"" prefix:"symbolizer-"`
 	DWARFUnwinding FlagsDWARFUnwinding `embed:"" prefix:"dwarf-unwinding-"`
 
 	Hidden FlagsHidden `embed:"" prefix:"" hidden:""`
@@ -158,6 +159,11 @@ type FlagsDebuginfo struct {
 	UploadTimeoutDuration time.Duration `default:"2m" help:"The timeout duration to cancel upload requests."`
 }
 
+// FlagsSymbolizer contains flags to configure symbolization.
+type FlagsSymbolizer struct {
+	JITDisable bool `kong:"help='Disable JIT symbolization.'"`
+}
+
 // FlagsDWARFUnwinding contains flags to configure DWARF unwinding.
 type FlagsDWARFUnwinding struct {
 	Disable    bool `kong:"help='Do not unwind using .eh_frame information.'"`
@@ -473,6 +479,7 @@ func run(logger log.Logger, reg *prometheus.Registry, flags flags) error {
 				perf.NewCache(logger),
 				ksym.NewKsymCache(logger, reg),
 				vdsoCache,
+				flags.Symbolizer.JITDisable,
 			),
 			process.NewMappingFileCache(logger),
 			objectfile.NewCache(20, flags.Profiling.Duration),

pkg/symbol/symbol.go

@@ -40,15 +40,19 @@ type PerfCache interface {
 type Symbolizer struct {
 	logger log.Logger
 
+	disableJIT bool
+
 	perfCache PerfCache
 	ksymCache SymbolCache
 	vdsoCache *vdso.Cache
 }
 
-func NewSymbolizer(logger log.Logger, perfCache PerfCache, ksymCache SymbolCache, vdsoCache *vdso.Cache) *Symbolizer {
+func NewSymbolizer(logger log.Logger, perfCache PerfCache, ksymCache SymbolCache, vdsoCache *vdso.Cache, disableJIT bool) *Symbolizer {
 	return &Symbolizer{
 		logger: logger,
 
+		disableJIT: disableJIT,
+
 		perfCache: perfCache,
 		ksymCache: ksymCache,
 		vdsoCache: vdsoCache,
@@ -90,6 +94,11 @@ func (s *Symbolizer) Symbolize(prof *profiler.Profile) error {
 		}
 	}
 
+	// JIT symbolization is disabled, so we can skip the rest.
+	if s.disableJIT {
+		return result.ErrorOrNil()
+	}
+
 	pid := prof.ID.PID
 	userJITedFunctions, err := s.resolveJITedFunctions(pid, prof.UserLocations)
 	if err != nil {