Skip to content
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.

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

Remove pprofextension, moved to contrib #3911

Merged
merged 1 commit into from
Aug 27, 2021
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
6 changes: 3 additions & 3 deletions cmd/otelcol/config.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extensions:
pprof:
endpoint: 0.0.0.0:1777
memory_ballast:
size_mib: 512
zpages:
endpoint: 0.0.0.0:55679

Expand Down Expand Up @@ -31,4 +31,4 @@ service:
processors: [batch]
exporters: [logging]

extensions: [pprof, zpages]
extensions: [memory_ballast, zpages]
6 changes: 3 additions & 3 deletions examples/local/otel-config.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extensions:
pprof:
endpoint: 0.0.0.0:1777
memory_ballast:
size_mib: 512
zpages:
endpoint: 0.0.0.0:55679

Expand Down Expand Up @@ -34,4 +34,4 @@ service:
processors: [memory_limiter, batch]
exporters: [logging]

extensions: [pprof, zpages]
extensions: [memory_ballast, zpages]
79 changes: 2 additions & 77 deletions extension/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ performance profile.

Supported service extensions (sorted alphabetically):

- [Health Check](healthcheckextension/README.md)
- [Performance Profiler](pprofextension/README.md)
- [Memory Ballast](ballastextension/README.md)
- [zPages](zpagesextension/README.md)

The [contributors
Expand All @@ -29,79 +28,5 @@ will be shutdown. The ordering is determined in the `extensions` tag under the
service:
# Extensions specified below are going to be loaded by the service in the
# order given below, and shutdown on reverse order.
extensions: [health_check, pprof, zpages]
extensions: [memory_ballast, zpages]
```

# Extensions

## <a name="health_check"></a>Health Check
Health Check extension enables an HTTP url that can be probed to check the
status of the OpenTelemetry Collector. This extension can be used as a
liveness and/or readiness probe on Kubernetes.

The following settings are required:

- `port` (default = 13133): What port to expose HTTP health information.

Example:

```yaml
extensions:
health_check:
```

The full list of settings exposed for this exporter is documented [here](healthcheckextension/config.go)
with detailed sample configurations [here](healthcheckextension/testdata/config.yaml).

## <a name="pprof"></a>Performance Profiler

Performance Profiler extension enables the golang `net/http/pprof` endpoint.
This is typically used by developers to collect performance profiles and
investigate issues with the service.

The following settings are required:

- `endpoint` (default = localhost:1777): The endpoint in which the pprof will
be listening to.
- `block_profile_fraction` (default = 0): 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 = 0): Fraction of mutex contention
events that are profiled. A value <= 0 disables profiling. See
https://golang.org/pkg/runtime/#SetMutexProfileFraction for details.

The following settings can be optionally configured:

- `save_to_file`: File name to save the CPU profile to. The profiling starts when the
Collector starts and is saved to the file when the Collector is terminated.

Example:

```yaml
extensions:
pprof:
```

The full list of settings exposed for this exporter are documented [here](pprofextension/config.go)
with detailed sample configurations [here](pprofextension/testdata/config.yaml).

## <a name="zpages"></a>zPages

Enables an extension that serves zPages, an HTTP endpoint that provides live
data for debugging different components that were properly instrumented for such.
All core exporters and receivers provide some zPages instrumentation.

The following settings are required:

- `endpoint` (default = localhost:55679): Specifies the HTTP endpoint that serves
zPages.

Example:

```yaml
extensions:
zpages:
```

The full list of settings exposed for this exporter are documented [here](zpagesextension/config.go)
with detailed sample configurations [here](zpagesextension/testdata/config.yaml).
32 changes: 0 additions & 32 deletions extension/pprofextension/README.md

This file was deleted.

51 changes: 0 additions & 51 deletions extension/pprofextension/config.go

This file was deleted.

56 changes: 0 additions & 56 deletions extension/pprofextension/config_test.go

This file was deleted.

17 changes: 0 additions & 17 deletions extension/pprofextension/doc.go

This file was deleted.

58 changes: 0 additions & 58 deletions extension/pprofextension/factory.go

This file was deleted.

52 changes: 0 additions & 52 deletions extension/pprofextension/factory_test.go

This file was deleted.

Loading