Performance Test and Monitoring Stack Docs - #1163
Open
rendre-greyling wants to merge 6 commits into
Open
rendre-greyling wants to merge 6 commits into
rendre-greyling wants to merge 6 commits into
Conversation
✅ Deploy Preview for kpt-porch ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
rendre-greyling
force-pushed
the
perf-test-docs
branch
from
September 9, 2026 12:06
03e602c to
a7700e9
Compare
Signed-off-by: Rendre Greyling <rendre.greyling@nokia.com>
Signed-off-by: Rendre Greyling <rendre.greyling@nokia.com>
rendre-greyling
force-pushed
the
perf-test-docs
branch
from
September 9, 2026 12:10
a7700e9 to
de9e044
Compare
Signed-off-by: Rendre Greyling <rendre.greyling@nokia.com>
rendre-greyling
marked this pull request as ready for review
September 9, 2026 12:34
rendre-greyling
requested review from
efiacor,
kispaljr,
liamfallon and
mozesl-nokia
as code owners
September 9, 2026 12:34
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
It introduces at least one broken internal link anchor and a metrics-bucket description mismatch that should be corrected before merging.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Adds end-user documentation for Porch’s local performance monitoring stack (Prometheus/Grafana/Jaeger/Pyroscope+Alloy) and the performance test suite, and wires these new guides into the existing deployment/configuration/contributing doc navigation.
Changes:
- Adds new docs for running performance tests and deploying a local monitoring/profiling stack on Kind.
- Expands the OpenTelemetry documentation to include pprof-based profiling configuration and related examples.
- Updates multiple docs index pages and “next steps” sections to link to the new guides.
File summaries
| File | Description |
|---|---|
| docs/content/en/docs/6_configuration_and_deployments/deployments/local-performance-monitoring-deployment.md | New guide for deploying and using the local observability stack. |
| docs/content/en/docs/6_configuration_and_deployments/deployments/local-dev-env-deployment.md | Adds next-step links to monitoring and performance tests. |
| docs/content/en/docs/6_configuration_and_deployments/deployments/catalog-deployment.md | Updates optional config wording for OpenTelemetry to include profiling. |
| docs/content/en/docs/6_configuration_and_deployments/deployments/_index.md | Adds a new section/links describing local performance monitoring. |
| docs/content/en/docs/6_configuration_and_deployments/configurations/opentelemetry.md | Extends OTel docs with profiling (pprof) configuration and richer metrics documentation. |
| docs/content/en/docs/6_configuration_and_deployments/configurations/components/porch-server-config/_index.md | Points readers to OpenTelemetry + the local monitoring stack docs. |
| docs/content/en/docs/6_configuration_and_deployments/configurations/components/porch-controllers-config/_index.md | Minor formatting/whitespace alignment update. |
| docs/content/en/docs/6_configuration_and_deployments/configurations/components/function-runner-config/_index.md | Minor formatting/whitespace alignment update. |
| docs/content/en/docs/6_configuration_and_deployments/configurations/components/_index.md | Adjusts formatting/indentation in the components index. |
| docs/content/en/docs/6_configuration_and_deployments/configurations/_index.md | Updates configuration index to reference profiling and the local monitoring guide. |
| docs/content/en/docs/6_configuration_and_deployments/_index.md | Adds a new top-level link for local performance monitoring. |
| docs/content/en/docs/12_contributing/code-contribution/performance-tests.md | New guide documenting how to run performance/load/soak tests and emit metrics. |
| docs/content/en/docs/12_contributing/code-contribution/development-environment.md | Adds a section linking to performance tests and monitoring. |
| docs/content/en/docs/12_contributing/code-contribution/_index.md | Adds “Related guides” links for development environment and performance tests. |
| docs/content/en/docs/12_contributing/_index.md | Adds quick links to development environment and performance tests under “Code”. |
Review details
- Files reviewed: 12/15 changed files
- Comments generated: 3
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Rendre Greyling <rendre.greyling@nokia.com>
Signed-off-by: Rendre Greyling <rendre.greyling@nokia.com>
liamfallon
approved these changes
Sep 14, 2026
Signed-off-by: Rendre Greyling <rendre.greyling@nokia.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Add new documentation for the Performance Tests and new Monitoring stack features from: 1122
Type of Change
Checklist
AI Disclosure
Composer 2.5 for initial generation. Editing done by hand.