Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
27 changes: 27 additions & 0 deletions .chloggen/pprof_port.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Use this changelog template to create an entry for release notes.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: enhancement

# The name of the component, or a single word describing the area of concern, (e.g. receiver/filelog)
component: receiver/pprof

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Read pprof data from HTTP remote endpoints or the collector itself

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
issues: [38260]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:

# If your change doesn't affect end users or the exported elements of any package,
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
# Optional: The change log or logs in which this entry should be included.
# e.g. '[user]' or '[user, api]'
# Include 'user' if the change is relevant to end users.
# Include 'api' if there is a change to a library API.
# Default: '[user]'
change_logs: []
13 changes: 12 additions & 1 deletion receiver/pprofreceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!-- status autogenerated section -->
# Pprof Receiver

The Pprof Receiver collects profiles from files specified with a glob pattern.
The Pprof Receiver collects profiles from files specified with a glob pattern, from a remote endpoint or the running collector.


| Status | |
Expand All @@ -19,6 +19,10 @@ The Pprof Receiver collects profiles from files specified with a glob pattern.
- `include` (required): The glob path for files to watch
- `collection_interval` (default = `1m`): The interval at which metrics are emitted by this receiver.
- `initial_delay` (default = `1s`): defines how long this receiver waits before starting.
- `block_profile_fraction` (default = `1`): (self scraper only) Fraction of blocking events that are profiled.
A value <= 0 disables profiling. See https://golang.org/pkg/runtime/#SetBlockProfileRate for details.
- `mutex_profile_fraction` (default = `1`): (self scraper only) Fraction of mutex contention events that are profiled.
A value <= 0 disables profiling. See https://golang.org/pkg/runtime/#SetMutexProfileFraction for details.

### Example

Expand All @@ -29,3 +33,10 @@ receivers:
collection_interval: 10s
initial_delay: 1s
```

Collector with remote endpoint:
```yaml
receivers:
pprof:
endpoint: "http://localhost:6060/debug/pprof/profile?seconds=1"
```
23 changes: 23 additions & 0 deletions receiver/pprofreceiver/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,36 @@
package pprofreceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/pprofreceiver"

import (
"errors"

"go.opentelemetry.io/collector/config/confighttp"
"go.opentelemetry.io/collector/scraper/scraperhelper"
)

// Config defines the configuration for the pprof receiver.
type Config struct {
scraperhelper.ControllerConfig `mapstructure:",squash"`
confighttp.ClientConfig `mapstructure:",squash"`

// Include is the glob pattern for pprof files to scrape.
Include string `mapstructure:"include"`

// Self-scraper only:
// Fraction of blocking events that are profiled. A value <= 0 disables
// profiling. See https://golang.org/pkg/runtime/#SetBlockProfileRate for details.
BlockProfileFraction int `mapstructure:"block_profile_fraction"`

// Self-scraper only:
// Fraction of mutex contention events that are profiled. A value <= 0
// disables profiling. See https://golang.org/pkg/runtime/#SetMutexProfileFraction
// for details.
MutexProfileFraction int `mapstructure:"mutex_profile_fraction"`
}

func (c *Config) Validate() error {
if c.Include != "" && c.Endpoint != "" {
return errors.New("either include or endpoint must be specified")
}

return nil
}
7 changes: 7 additions & 0 deletions receiver/pprofreceiver/config.schema.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,15 @@
description: Config defines the configuration for the pprof receiver.
type: object
properties:
block_profile_fraction:
description: 'Self-scraper only: Fraction of blocking events that are profiled. A value <= 0 disables profiling. See https://golang.org/pkg/runtime/#SetBlockProfileRate for details.'
type: integer
include:
description: Include is the glob pattern for pprof files to scrape.
type: string
mutex_profile_fraction:
description: 'Self-scraper only: Fraction of mutex contention events that are profiled. A value <= 0 disables profiling. See https://golang.org/pkg/runtime/#SetMutexProfileFraction for details.'
type: integer
allOf:
- $ref: go.opentelemetry.io/collector/scraper/scraperhelper.controller_config
- $ref: go.opentelemetry.io/collector/config/confighttp.client_config
9 changes: 5 additions & 4 deletions receiver/pprofreceiver/factory.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,10 @@ func createDefaultConfig() component.Config {
scraperCfg.CollectionInterval = 10 * time.Second

return &Config{
ControllerConfig: scraperCfg,
Include: "",
ControllerConfig: scraperCfg,
Include: "",
BlockProfileFraction: 1,
MutexProfileFraction: 1,
}
}

Expand All @@ -48,12 +50,11 @@ func createProfilesReceiver(
metadata.Type,
func() component.Config { return &Config{} },
xscraper.WithProfiles(func(_ context.Context, set scraper.Settings, _ component.Config) (xscraper.Profiles, error) {
ps := newScraper(rCfg, receiver.Settings{
return newScraper(rCfg, receiver.Settings{
ID: set.ID,
TelemetrySettings: set.TelemetrySettings,
BuildInfo: settings.BuildInfo,
})
return xscraper.NewProfiles(ps.scrape, xscraper.WithStart(ps.start))
}, metadata.ProfilesStability),
)

Expand Down
24 changes: 24 additions & 0 deletions receiver/pprofreceiver/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ require (
github.com/stretchr/testify v1.11.1
go.opentelemetry.io/collector/component v1.53.1-0.20260312104527-c74f90fe3922
go.opentelemetry.io/collector/component/componenttest v0.147.1-0.20260312104527-c74f90fe3922
go.opentelemetry.io/collector/config/confighttp v0.147.1-0.20260312104527-c74f90fe3922
go.opentelemetry.io/collector/confmap v1.53.1-0.20260312104527-c74f90fe3922
go.opentelemetry.io/collector/consumer/consumertest v0.147.1-0.20260312104527-c74f90fe3922
go.opentelemetry.io/collector/consumer/xconsumer v0.147.1-0.20260312104527-c74f90fe3922
Expand All @@ -28,13 +29,19 @@ require (
require (
github.com/cespare/xxhash/v2 v2.3.0 // indirect
github.com/davecgh/go-spew v1.1.1 // indirect
github.com/felixge/httpsnoop v1.0.4 // indirect
github.com/foxboron/go-tpm-keyfiles v0.0.0-20251226215517-609e4778396f // indirect
github.com/fsnotify/fsnotify v1.9.0 // indirect
github.com/go-logr/logr v1.4.3 // indirect
github.com/go-logr/stdr v1.2.2 // indirect
github.com/go-viper/mapstructure/v2 v2.5.0 // indirect
github.com/gobwas/glob v0.2.3 // indirect
github.com/golang/snappy v1.0.0 // indirect
github.com/google/go-tpm v0.9.8 // indirect
github.com/google/uuid v1.6.0 // indirect
github.com/hashicorp/go-version v1.8.0 // indirect
github.com/json-iterator/go v1.1.12 // indirect
github.com/klauspost/compress v1.18.4 // indirect
github.com/klauspost/cpuid/v2 v2.2.10 // indirect
github.com/knadh/koanf/maps v0.1.2 // indirect
github.com/knadh/koanf/providers/confmap v1.0.0 // indirect
Expand All @@ -43,24 +50,41 @@ require (
github.com/mitchellh/reflectwalk v1.0.2 // indirect
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
github.com/modern-go/reflect2 v1.0.3-0.20250322232337-35a7c28c31ee // indirect
github.com/pierrec/lz4/v4 v4.1.26 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
github.com/rs/cors v1.11.1 // indirect
github.com/zeebo/xxh3 v1.1.0 // indirect
go.opentelemetry.io/auto/sdk v1.2.1 // indirect
go.opentelemetry.io/collector/client v1.53.1-0.20260312104527-c74f90fe3922 // indirect
go.opentelemetry.io/collector/config/configauth v1.53.1-0.20260312104527-c74f90fe3922 // indirect
go.opentelemetry.io/collector/config/configcompression v1.53.1-0.20260312104527-c74f90fe3922 // indirect
go.opentelemetry.io/collector/config/configmiddleware v1.53.1-0.20260312104527-c74f90fe3922 // indirect
go.opentelemetry.io/collector/config/confignet v1.53.1-0.20260312104527-c74f90fe3922 // indirect
go.opentelemetry.io/collector/config/configopaque v1.53.1-0.20260312104527-c74f90fe3922 // indirect
go.opentelemetry.io/collector/config/configoptional v1.53.1-0.20260312104527-c74f90fe3922 // indirect
go.opentelemetry.io/collector/config/configtls v1.53.1-0.20260312104527-c74f90fe3922 // indirect
go.opentelemetry.io/collector/confmap/xconfmap v0.147.1-0.20260312104527-c74f90fe3922 // indirect
go.opentelemetry.io/collector/consumer v1.53.1-0.20260312104527-c74f90fe3922 // indirect
go.opentelemetry.io/collector/consumer/consumererror v0.147.1-0.20260312104527-c74f90fe3922 // indirect
go.opentelemetry.io/collector/extension/extensionauth v1.53.1-0.20260312104527-c74f90fe3922 // indirect
go.opentelemetry.io/collector/extension/extensionmiddleware v0.147.1-0.20260312104527-c74f90fe3922 // indirect
go.opentelemetry.io/collector/featuregate v1.53.1-0.20260312104527-c74f90fe3922 // indirect
go.opentelemetry.io/collector/internal/componentalias v0.147.1-0.20260312104527-c74f90fe3922 // indirect
go.opentelemetry.io/collector/pdata v1.53.1-0.20260312104527-c74f90fe3922 // indirect
go.opentelemetry.io/collector/pipeline v1.53.1-0.20260312104527-c74f90fe3922 // indirect
go.opentelemetry.io/collector/pipeline/xpipeline v0.147.1-0.20260312104527-c74f90fe3922 // indirect
go.opentelemetry.io/collector/receiver/receiverhelper v0.147.1-0.20260312104527-c74f90fe3922 // indirect
go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.67.0 // indirect
go.opentelemetry.io/otel v1.42.0 // indirect
go.opentelemetry.io/otel/metric v1.42.0 // indirect
go.opentelemetry.io/otel/sdk v1.42.0 // indirect
go.opentelemetry.io/otel/sdk/metric v1.42.0 // indirect
go.opentelemetry.io/otel/trace v1.42.0 // indirect
go.yaml.in/yaml/v3 v3.0.4 // indirect
golang.org/x/crypto v0.48.0 // indirect
golang.org/x/net v0.51.0 // indirect
golang.org/x/sys v0.41.0 // indirect
golang.org/x/text v0.34.0 // indirect
google.golang.org/genproto/googleapis/rpc v0.0.0-20251222181119-0a764e51fe1b // indirect
google.golang.org/grpc v1.79.2 // indirect
google.golang.org/protobuf v1.36.11 // indirect
Expand Down
Loading
Loading