Skip to content
Closed
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/attempt_to_convert_pprof.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: new_component

# 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: Implement receiving pprof data and converting it to profile data

# 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: []
2 changes: 1 addition & 1 deletion pkg/translator/pprof/pprof_to_profiles.go
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ type lookupTables struct {
lastStackTableIdx int32
}

func convertPprofToPprofile(src *profile.Profile) (*pprofile.Profiles, error) {
func ConvertPprofToPprofile(src *profile.Profile) (*pprofile.Profiles, error) {
if err := src.CheckValid(); err != nil {
return nil, fmt.Errorf("%w: %w", err, errPprofInvalid)
}
Expand Down
2 changes: 1 addition & 1 deletion pkg/translator/pprof/pprof_to_profiles_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ func TestConvertPprofToPprofile(t *testing.T) {
p, err := profile.Parse(bytes.NewBuffer(inbytes))
require.NoError(t, err)

pprofile, err := convertPprofToPprofile(p)
pprofile, err := ConvertPprofToPprofile(p)
switch {
case errors.Is(err, tc.expectedError):
// The expected error equals the returned error,
Expand Down
19 changes: 18 additions & 1 deletion receiver/pprofreceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,21 @@
[development]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/component-stability.md#development
<!-- end autogenerated section -->

TODO
This receiver interprets pprof profiles.

Note this receiver is incompatible with the pprof extension.

The receiver will capture pprof information from the collector itself or a remote Go program exposing an endpoint.
Comment thread
atoulme marked this conversation as resolved.

Collector
```yaml
receivers:
pprof:
```

Collector with remote endpoint:
```yaml
receivers:
pprof:
endpoint: "http://localhost:6060/debug/pprof/profile?seconds=1"
```
18 changes: 17 additions & 1 deletion receiver/pprofreceiver/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,24 @@

package pprofreceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/pprofreceiver"

import "go.opentelemetry.io/collector/config/confighttp"
import (
"time"

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

type Config struct {
confighttp.ClientConfig `mapstructure:",squash"`

// CollectionInterval sets how frequently profiles should be collected.
CollectionInterval time.Duration `mapstructure:"collection_interval"`

// 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"`

// 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"`
}
30 changes: 13 additions & 17 deletions receiver/pprofreceiver/factory.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ package pprofreceiver // import "github.com/open-telemetry/opentelemetry-collect

import (
"context"
"errors"
"time"

"go.opentelemetry.io/collector/component"
"go.opentelemetry.io/collector/config/confighttp"
Expand All @@ -25,25 +25,21 @@ func NewFactory() receiver.Factory {

func createDefaultConfig() component.Config {
return &Config{
ClientConfig: confighttp.NewDefaultClientConfig(),
ClientConfig: confighttp.NewDefaultClientConfig(),
CollectionInterval: 10 * time.Second,
}
}

func createProfilesReceiver(
context.Context,
receiver.Settings,
component.Config,
xconsumer.Profiles,
_ context.Context,
set receiver.Settings,
cfg component.Config,
c xconsumer.Profiles,
) (xreceiver.Profiles, error) {
return &rcvr{}, errors.New("not implemented")
}

type rcvr struct{}

func (rcvr) Start(context.Context, component.Host) error {
return nil
}

func (rcvr) Shutdown(context.Context) error {
return nil
return &pprofReceiver{
consumer: c,
telemetrySettings: set.TelemetrySettings,
config: cfg.(*Config),
done: make(chan struct{}),
}, nil
}
72 changes: 72 additions & 0 deletions receiver/pprofreceiver/factory_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

package pprofreceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/pprofreceiver"
import (
"net/http"
_ "net/http/pprof" //nolint:gosec // #nosec G108
"testing"
"time"

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"go.opentelemetry.io/collector/component/componenttest"
"go.opentelemetry.io/collector/consumer/consumertest"
"go.opentelemetry.io/collector/receiver/receivertest"
"go.opentelemetry.io/collector/receiver/xreceiver"
"go.uber.org/zap"
)

func TestStartStop(t *testing.T) {
f := NewFactory().(xreceiver.Factory)
profilesConsumer := new(consumertest.ProfilesSink)
set := receivertest.NewNopSettings(f.Type())
var err error
set.Logger, err = zap.NewDevelopment()
require.NoError(t, err)
cfg := f.CreateDefaultConfig().(*Config)
cfg.CollectionInterval = 1 * time.Second
r, err := f.CreateProfiles(t.Context(), set, cfg, profilesConsumer)
require.NoError(t, err)
err = r.Start(t.Context(), componenttest.NewNopHost())
require.NoError(t, err)
require.EventuallyWithT(t, func(tt *assert.CollectT) {
require.NotEmpty(tt, profilesConsumer.AllProfiles())
}, 5*time.Second, 100*time.Millisecond, "failed to receive data from pprof receiver")
err = r.Shutdown(t.Context())
require.NoError(t, err)
}

func TestStartStopRemote(t *testing.T) {
server := &http.Server{
ReadTimeout: 1 * time.Second,
Addr: "localhost:6060",
Handler: http.DefaultServeMux,
}
go func() {
err := server.ListenAndServe()
assert.ErrorIs(t, err, http.ErrServerClosed, "server closed")
}()
defer func() {
assert.NoError(t, server.Shutdown(t.Context()))
}()

f := NewFactory().(xreceiver.Factory)
profilesConsumer := new(consumertest.ProfilesSink)
set := receivertest.NewNopSettings(f.Type())
var err error
set.Logger, err = zap.NewDevelopment()
require.NoError(t, err)
cfg := f.CreateDefaultConfig().(*Config)
cfg.CollectionInterval = 1 * time.Second
cfg.Endpoint = "http://localhost:6060/debug/pprof/profile?seconds=1"
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Will there be some configuration validation to make sure cfg.CollectionInterval does not conflicts with interval configured in cft.Endpoint.

In this test they are the same:

  • cfg.CollectionInterval = 1 * time.Second
  • cfg.Endpoint = "http://localhost:6060/debug/pprof/profile?seconds=1"

What is the expected behaviour if cfg.CollectionInterval << cfg.Endpoint interval?
iirc the default interval for the /debug/pprof/profile endpoint is 30 seconds.

r, err := f.CreateProfiles(t.Context(), set, cfg, profilesConsumer)
require.NoError(t, err)
err = r.Start(t.Context(), componenttest.NewNopHost())
require.NoError(t, err)
require.EventuallyWithT(t, func(tt *assert.CollectT) {
require.NotEmpty(tt, profilesConsumer.AllProfiles())
}, 5*time.Second, 100*time.Millisecond, "failed to receive data from pprof receiver")
err = r.Shutdown(t.Context())
require.NoError(t, err)
}
49 changes: 28 additions & 21 deletions receiver/pprofreceiver/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -3,71 +3,76 @@ module github.com/open-telemetry/opentelemetry-collector-contrib/receiver/pprofr
go 1.24.0

require (
github.com/google/pprof v0.0.0-20251114195745-4902fdda35c8
github.com/open-telemetry/opentelemetry-collector-contrib/pkg/translator/pprof v0.145.0
github.com/stretchr/testify v1.11.1
go.opentelemetry.io/collector/component v1.51.0
go.opentelemetry.io/collector/component/componenttest v0.145.0
go.opentelemetry.io/collector/config/confighttp v0.145.0
go.opentelemetry.io/collector/config/confighttp v0.140.0
go.opentelemetry.io/collector/confmap v1.51.0
go.opentelemetry.io/collector/consumer/consumertest v0.145.0
go.opentelemetry.io/collector/consumer/xconsumer v0.145.0
go.opentelemetry.io/collector/pdata/pprofile v0.145.0
go.opentelemetry.io/collector/receiver v1.51.0
go.opentelemetry.io/collector/receiver/receivertest v0.145.0
go.opentelemetry.io/collector/receiver/xreceiver v0.145.0
go.uber.org/goleak v1.3.0
go.uber.org/zap v1.27.1
golang.org/x/sync v0.19.0
)

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/foxboron/go-tpm-keyfiles v0.0.0-20250903184740-5d135037bd4d // 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/go-tpm v0.9.7 // 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.3 // indirect
github.com/klauspost/compress v1.18.1 // 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
github.com/knadh/koanf/v2 v2.3.2 // indirect
github.com/mitchellh/copystructure v1.2.0 // indirect
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.23 // indirect
github.com/pierrec/lz4/v4 v4.1.22 // 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.51.0 // indirect
go.opentelemetry.io/collector/config/configauth v1.51.0 // indirect
go.opentelemetry.io/collector/config/configcompression v1.51.0 // indirect
go.opentelemetry.io/collector/config/configmiddleware v1.51.0 // indirect
go.opentelemetry.io/collector/config/confignet v1.51.0 // indirect
go.opentelemetry.io/collector/config/configopaque v1.51.0 // indirect
go.opentelemetry.io/collector/config/configoptional v1.51.0 // indirect
go.opentelemetry.io/collector/config/configtls v1.51.0 // indirect
go.opentelemetry.io/collector/confmap/xconfmap v0.145.0 // indirect
go.opentelemetry.io/collector/client v1.46.0 // indirect
go.opentelemetry.io/collector/config/configauth v1.46.0 // indirect
go.opentelemetry.io/collector/config/configcompression v1.46.0 // indirect
go.opentelemetry.io/collector/config/configmiddleware v1.46.0 // indirect
go.opentelemetry.io/collector/config/configopaque v1.46.0 // indirect
go.opentelemetry.io/collector/config/configoptional v1.46.0 // indirect
go.opentelemetry.io/collector/config/configtls v1.46.0 // indirect
go.opentelemetry.io/collector/confmap/xconfmap v0.140.0 // indirect
go.opentelemetry.io/collector/consumer v1.51.0 // indirect
go.opentelemetry.io/collector/consumer/consumererror v0.145.0 // indirect
go.opentelemetry.io/collector/extension/extensionauth v1.51.0 // indirect
go.opentelemetry.io/collector/extension/extensionmiddleware v0.145.0 // indirect
go.opentelemetry.io/collector/extension/extensionauth v1.46.0 // indirect
go.opentelemetry.io/collector/extension/extensionmiddleware v0.140.0 // indirect
go.opentelemetry.io/collector/featuregate v1.51.0 // indirect
go.opentelemetry.io/collector/internal/componentalias v0.145.0 // indirect
go.opentelemetry.io/collector/pdata v1.51.0 // indirect
go.opentelemetry.io/collector/pdata/pprofile v0.145.0 // indirect
go.opentelemetry.io/collector/pipeline v1.51.0 // indirect
go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.63.0 // indirect
go.opentelemetry.io/otel v1.39.0 // indirect
go.opentelemetry.io/otel/metric v1.39.0 // indirect
go.opentelemetry.io/otel v1.40.0 // indirect
go.opentelemetry.io/otel/metric v1.40.0 // indirect
go.opentelemetry.io/otel/sdk v1.39.0 // indirect
go.opentelemetry.io/otel/sdk/metric v1.39.0 // indirect
go.opentelemetry.io/otel/trace v1.39.0 // indirect
go.opentelemetry.io/otel/trace v1.40.0 // indirect
go.uber.org/multierr v1.11.0 // indirect
go.uber.org/zap v1.27.1 // indirect
go.yaml.in/yaml/v3 v3.0.4 // indirect
golang.org/x/crypto v0.47.0 // indirect
golang.org/x/net v0.49.0 // indirect
Expand All @@ -84,3 +89,5 @@ retract (
v0.76.1
v0.65.0
)

replace github.com/open-telemetry/opentelemetry-collector-contrib/pkg/translator/pprof => ../../pkg/translator/pprof
Loading
Loading