From deb28da3845485245dd58100b38fb17061ee09c6 Mon Sep 17 00:00:00 2001 From: "minquan.chen" Date: Thu, 7 Jul 2022 22:17:38 +0800 Subject: [PATCH 1/2] [docs] Add status header for pprof --- extension/pprofextension/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/extension/pprofextension/README.md b/extension/pprofextension/README.md index d69bcf1bc769..90cfa96c0473 100644 --- a/extension/pprofextension/README.md +++ b/extension/pprofextension/README.md @@ -1,5 +1,10 @@ # Performance Profiler +| Status | | +| ------------------------ |----------------------| +| Stability | [beta] | +| Distributions | [contrib] | + 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. @@ -30,3 +35,6 @@ extensions: The full list of settings exposed for this exporter are documented [here](./config.go) with detailed sample configurations [here](./testdata/config.yaml). + +[beta]:https://github.com/open-telemetry/opentelemetry-collector#beta +[contrib]:https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib From 045d9ccb9d783a4b50a457de320f3e2f36015722 Mon Sep 17 00:00:00 2001 From: Murphy Chen Date: Fri, 8 Jul 2022 10:57:21 +0800 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Alex Boten --- extension/pprofextension/README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/extension/pprofextension/README.md b/extension/pprofextension/README.md index 90cfa96c0473..2ad955ace00d 100644 --- a/extension/pprofextension/README.md +++ b/extension/pprofextension/README.md @@ -1,9 +1,9 @@ # Performance Profiler -| Status | | -| ------------------------ |----------------------| -| Stability | [beta] | -| Distributions | [contrib] | +| Status | | +| ------------------------ |-------------------| +| Stability | [beta] | +| Distributions | [core], [contrib] | Performance Profiler extension enables the golang `net/http/pprof` endpoint. This is typically used by developers to collect performance profiles and @@ -38,3 +38,4 @@ with detailed sample configurations [here](./testdata/config.yaml). [beta]:https://github.com/open-telemetry/opentelemetry-collector#beta [contrib]:https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib +[core]:https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol