Skip to content

Commit

Permalink
[docs] add status header for ballast/zpages (open-telemetry#5435)
Browse files Browse the repository at this point in the history
  • Loading branch information
Alex Boten authored May 26, 2022
1 parent 601d2e9 commit 79b7835
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 2 deletions.
9 changes: 9 additions & 0 deletions extension/ballastextension/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Memory Ballast

| Status | |
| ------------------------ | ----------------- |
| Stability | [beta] |
| Distributions | [core], [contrib] |

Memory Ballast extension enables applications to configure memory ballast for the process. For more details see:
- [Go memory ballast blogpost](https://web.archive.org/web/20210929130001/https://blog.twitch.tv/en/2019/04/10/go-memory-ballast-how-i-learnt-to-stop-worrying-and-love-the-heap-26c2462549a2/)
- [Golang issue related to this](https://github.com/golang/go/issues/23044)
Expand Down Expand Up @@ -41,3 +46,7 @@ extensions:
memory_ballast:
size_in_percentage: 20
```
[beta]: https://github.com/open-telemetry/opentelemetry-collector-contrib#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
10 changes: 8 additions & 2 deletions extension/zpagesextension/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# zPages

| Status | |
| ------------------------ | ----------------- |
| Stability | [beta] |
| Distributions | [core], [contrib] |

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 zPage instrumentation.
Expand Down Expand Up @@ -70,5 +75,6 @@ that are properly instrumented. For example when using gRPC

Example URL: http://localhost:55679/debug/rpcz



[beta]: https://github.com/open-telemetry/opentelemetry-collector-contrib#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

0 comments on commit 79b7835

Please sign in to comment.