flags

type ExitCode int

type Exporter interface {
	sdktrace.SpanExporter

	Start(ctx context.Context) error
}

type ExporterType string

type Flags struct {
	Log         FlagsLogs `embed:""                         prefix:"log-"`
	HTTPAddress string    `default:"127.0.0.1:7071"         help:"Address to bind HTTP server to."`
	Version     bool      `help:"Show application version."`

	EnvironmentType string   `help:"The type of environment."`
	MachineID       string   `help:"The machine ID."`
	IncludeEnvVar   []string `help:"Environment variables to include in the profile."`

	// The go tracer is disabled by default because Parca symbolizes native Go
	// frames server-side from uploaded debuginfo, and doing it in both places
	// wastes agent CPU. Turn it on when the backend has no symbolizer: the
	// upstream interpreter reads gopclntab out of the binary and resolves
	// function, file and line in-agent, so frames arrive named with no
	// debuginfo upload at all.
	SymbolizeGo bool `` /* 215-byte string literal not displayed */

	OtelTags string `default:"" help:"Otel tags to attach to all traces."`
	Tracers  string `default:"all" help:"Tracers to enable."`

	Node          string `` /* 155-byte string literal not displayed */
	ConfigPath    string `default:""                          help:"Path to config file."`
	MemlockRlimit uint64 `` /* 216-byte string literal not displayed */

	// pprof.
	MutexProfileFraction int `default:"0" help:"Fraction of mutex profile samples to collect."`
	BlockProfileRate     int `default:"0" help:"Sample rate for block profile."`

	Profiling      FlagsProfiling      `embed:"" prefix:"profiling-"`
	Metadata       FlagsMetadata       `embed:"" prefix:"metadata-"`
	LocalStore     FlagsLocalStore     `embed:"" prefix:"local-store-"`
	RemoteStore    FlagsRemoteStore    `embed:"" prefix:"remote-store-"`
	Debuginfo      FlagsDebuginfo      `embed:"" prefix:"debuginfo-"`
	Symbolizer     FlagsSymbolizer     `embed:"" prefix:"symbolizer-"`
	OTLP           FlagsOTLP           `embed:"" prefix:"otlp-"`
	ObjectFilePool FlagsObjectFilePool `embed:"" prefix:"object-file-pool-"`

	ClockSyncInterval time.Duration `default:"3m" help:"How frequently to synchronize with the realtime clock."`

	DWARFUnwinding         FlagsDWARFUnwinding `embed:""        prefix:"dwarf-unwinding-"`
	PythonUnwindingDisable bool                `default:"false" help:"[deprecated] Disable Python unwinder."`
	RubyUnwindingDisable   bool                `default:"false" help:"[deprecated] Disable Ruby unwinder."`
	JavaUnwindingDisable   bool                `default:"true"  help:"[deprecated] Disable Java unwinder."`

	InstrumentCudaLaunch bool `default:"true" help:"instrument calls to cudaLaunchKernel."`

	AnalyticsOptOut bool `default:"false" help:"Opt out of sending anonymous usage statistics."`

	Telemetry FlagsTelemetry `embed:"" prefix:"telemetry-"`
	Hidden    FlagsHidden    `embed:"" hidden:""           prefix:""`

	BPF FlagsBPF `embed:"" prefix:"bpf-"`

	OfflineMode     FlagsOfflineMode `embed:"" prefix:"offline-mode-"`
	OffCPUThreshold float64          `default:"0" help:"The probability (0.0-1.0) of off-CPU event being recorded."`

	EnableOOMProf       bool `default:"false" help:"Enable OOMProf profiling integration."`
	EnableOOMProfAllocs bool `default:"false" help:"Enable OOMProf alloc counts."`

	MergeGpuProfiles bool `` /* 325-byte string literal not displayed */

	GpuMetrics FlagsGpuMetrics `embed:"" prefix:"gpu-metrics-"`

	GpuNvtx FlagsGpuNvtx `embed:"" prefix:"gpu-nvtx-"`

	// OTLPLogging is a pointer so "unset" can follow the profile format; see
	// SendLogs.
	OTLPLogging *bool `` /* 243-byte string literal not displayed */

	ProbeConfigFile string `` /* 236-byte string literal not displayed */
}

type FlagsBPF struct {
	VerboseLogging        bool   `help:"Enable verbose BPF logging from eBPF code to ebpf trace_pipe."`
	LogTracePipe          bool   `help:"Copy bpf trace_pipe to info logging."`
	EventsBufferSize      uint32 `default:"8192"                     help:"Size in pages of the events buffer."`
	MapScaleFactor        int    `` /* 284-byte string literal not displayed */
	CUPTIEventScaleFactor int    `` /* 361-byte string literal not displayed */
	VerifierLogLevel      uint32 `default:"0" help:"Log level of the eBPF verifier output (0,1,2). Default is 0."`
	VerifierLogSize       int    `default:"0" help:"[deprecated] Unused."`
}

type FlagsDWARFUnwinding struct {
	Disable bool `help:"[deprecated] Do not unwind using .eh_frame information."`
	Mixed   bool `default:"true"                                    help:"[deprecated] Unwind using .eh_frame information and frame pointers."`
}

type FlagsDebuginfo struct {
	FlagsGRPC `` /* 226-byte string literal not displayed */

	Directories           []string      `default:"/usr/lib/debug" help:"Ordered list of local directories to search for debuginfo files."`
	TempDir               string        `default:"/tmp"           help:"The local directory path to store the interim debuginfo files."`
	Strip                 bool          `` /* 151-byte string literal not displayed */
	Compress              bool          `default:"false"          help:"Compress debuginfo files' DWARF sections before uploading."`
	UploadDisable         bool          `default:"false"          help:"Disable debuginfo collection and upload."`
	UploadMaxParallel     int           `default:"25"             help:"The maximum number of debuginfo upload requests to make in parallel."`
	UploadTimeoutDuration time.Duration `default:"2m"             help:"The timeout duration to cancel upload requests."`
	UploadCacheDuration   time.Duration `default:"5m"             help:"The duration to cache debuginfo upload responses for."`
	DisableCaching        bool          `default:"false"          help:"Disable caching of debuginfo."`
	UploadQueueSize       uint32        `` /* 141-byte string literal not displayed */
}

type FlagsGRPC struct {
	Address            string `help:"gRPC address to send requests to. ${address_help}"`
	BearerToken        string `help:"Bearer token to authenticate with store." env:"${bearer_token_env}"`
	BearerTokenFile    string `help:"File to read bearer token from to authenticate with store."`
	Insecure           bool   `help:"Send gRPC requests via plaintext instead of TLS."`
	InsecureSkipVerify bool   `help:"Skip TLS certificate verification."`

	RPCUnaryTimeout time.Duration `default:"5m" help:"Maximum timeout window for unary gRPC requests including retries."`

	GRPCMaxCallRecvMsgSize   int               `default:"33554432" help:"The maximum message size the client can receive."`
	GRPCMaxCallSendMsgSize   int               `default:"33554432" help:"The maximum message size the client can send."`
	GRPCStartupBackoffTime   time.Duration     `default:"1m" help:"The time between failed gRPC requests during startup phase."`
	GRPCConnectionTimeout    time.Duration     `default:"3s" help:"The timeout duration for gRPC connection establishment."`
	GRPCMaxConnectionRetries uint32            `default:"5" help:"The maximum number of retries to establish a gRPC connection."`
	GRPCHeaders              map[string]string `help:"Additional gRPC headers to send with each request (key=value pairs)."`

	ClientCert string `help:"Client certificate for mTLS"`
	ClientKey  string `help:"Client key for mTLS"`
}

type FlagsGpuMetrics struct {
	Disable        bool          `` /* 154-byte string literal not displayed */
	ExportInterval time.Duration `default:"10s"   help:"How frequently collected GPU metrics are batched and exported over OTLP."`
}

type FlagsGpuNvtx struct {
	Disable        bool    `default:"false" help:"Don't forward NVTX annotations from instrumented CUDA processes."`
	MaxSpansPerSec float64 `` /* 153-byte string literal not displayed */
}

type FlagsHidden struct {
	AllowRunningAsNonRoot             bool `` /* 152-byte string literal not displayed */
	AllowRunningInNonRootPIDNamespace bool `` /* 152-byte string literal not displayed */

	ForcePanic bool `default:"false" help:"Panics the agent in a goroutine to test that telemetry works." hidden:""`

	IgnoreUnsafeKernelVersion bool `` /* 127-byte string literal not displayed */

	RateLimitUnwindInfo         uint32 `default:"50" hidden:""`
	RateLimitProcessMappings    uint32 `default:"50" hidden:""`
	RateLimitRefreshProcessInfo uint32 `default:"50" hidden:""`
	RateLimitRead               uint32 `default:"50" hidden:""`
}

type FlagsLocalStore struct {
	Directory string `help:"The local directory to store the profiling data."`
}

type FlagsLogs struct {
	Level  string `default:"info"   enum:"error,warn,info,debug" help:"Log level."`
	Format string `default:"logfmt" enum:"logfmt,json"           help:"Configure if structured logging as JSON or as logfmt"`
}

type FlagsMetadata struct {
	Discovery                  string            `` /* 217-byte string literal not displayed */
	ExternalLabels             map[string]string `help:"Label(s) to attach to all profiles."`
	ContainerRuntimeSocketPath string            `help:"The filesystem path to the container runtimes socket. Leave this empty to use the defaults."`

	DisableCaching       bool `default:"false" help:"[deprecated] Disable caching of metadata."`
	EnableProcessCmdline bool `` /* 142-byte string literal not displayed */

	DisableCPULabel        bool `default:"false" help:"Disable adding the cpu label to profiling data."`
	DisableThreadIDLabel   bool `default:"false" help:"Disable adding the thread_id label to profiling data."`
	DisableThreadCommLabel bool `default:"false" help:"Disable adding the thread_comm label to profiling data."`
}

type FlagsOTLP struct {
	Address  string `help:"The endpoint to send the agent's own OTLP traces to."`
	Exporter string `default:"grpc" enum:"grpc,http,stdout" help:"The OTLP exporter to use."`
}

type FlagsObjectFilePool struct {
	EvictionPolicy string `` /* 286-byte string literal not displayed */
	Size           int    `` /* 226-byte string literal not displayed */
}

type FlagsOfflineMode struct {
	StoragePath      string        `` /* 182-byte string literal not displayed */
	RotationInterval time.Duration `default:"10m" help:"[deprecated] How often to rotate and compress the offline mode log."`
	Upload           bool          `help:"[deprecated] Run the uploader for data written in offline mode."`
}

type FlagsProfiling struct {
	Duration             time.Duration `default:"5s"                                help:"The agent profiling duration to use. Leave this empty to use the defaults."`
	LabelTTL             time.Duration `default:"10m"                               help:"The interval at which the agent will refresh the labels of a tid."`
	CPUSamplingFrequency int           `` /* 131-byte string literal not displayed */

	PerfEventBufferPollInterval       time.Duration `default:"250ms" help:"[deprecated] The interval at which the perf event buffer is polled for new events."`
	PerfEventBufferProcessingInterval time.Duration `default:"100ms" help:"[deprecated] The interval at which the perf event buffer is processed."`
	PerfEventBufferWorkerCount        int           `default:"4"     help:"[deprecated] The number of workers that process the perf event buffer."`

	ProbabilisticInterval  time.Duration `default:"1m" help:"Time interval for which probabilistic profiling will be enabled or disabled."`
	ProbabilisticThreshold uint          `` /* 321-byte string literal not displayed */

	EnableErrorFrames bool `default:"false" help:"Enable collection of error frames."`
}

type FlagsRemoteStore struct {
	FlagsGRPC `embed:"" set:"bearer_token_env=PARCA_BEARER_TOKEN" set:"address_help=Sends profiles and, by default, symbols."`

	BatchWriteInterval time.Duration `` /* 130-byte string literal not displayed */
	RPCLoggingEnable   bool          `default:"false" help:"[deprecated] Enable gRPC logging."`

	// Format selects the wire encoding profiles are sent in. It supersedes
	// --use-v2-schema, which was a bool when there were only two encodings.
	Format string `` /* 253-byte string literal not displayed */

	// Compression applies to the OTLP profiles export. The arrow paths carry
	// their own compression inside the IPC payload (v2 uses LZ4), so adding a
	// transport codec on top of them would compress twice.
	//
	// gzip only, because it is the one compressor grpc-go ships on both sides,
	// so every OTLP receiver can decompress it. A codec the receiver has not
	// installed fails at the first flush with "Decompressor is not installed
	// for grpc-encoding <name>", and at the volumes the agent sends -- tens of
	// KiB/s -- a better ratio is not worth a flag value that works against some
	// receivers and not others.
	Compression string `` /* 155-byte string literal not displayed */

	UseV2Schema bool `` /* 218-byte string literal not displayed */
}

type FlagsSymbolizer struct {
	JITDisable bool `help:"[deprecated] Disable JIT symbolization."`
}

type FlagsTelemetry struct {
	DisablePanicReporting bool  `default:"false"`
	StderrBufferSizeKb    int64 `default:"4096"`
}

type NoopExporter struct{}

type SamplerType string