Skip to content

Docs: update docs for API operation histogram and in-flight counter; add dashboard for in-flight operations - #1281

Merged
liamfallon merged 18 commits into
kptdev:mainfrom
Nordix:docs-porch-operation-metrics
Oct 28, 2026
Merged

liamfallon merged 18 commits into
kptdev:mainfrom
Nordix:docs-porch-operation-metrics

Conversation

@JamesMcDermott

Copy link
Copy Markdown
Contributor

Description

  • What changed:
    • New time-series panel to the "Porch API" Grafana dashboard for the porch_in_flight_api_operations metric
    • Updated OpenTelemetry metrics documentation to document:
      • new attributes added to porch_api_call_duration_seconds (added operation, operation_outcome, lifecycle_after, namespace, repository, package, and workspace_name)
        • and clarified the verb attribute as an HTTP-style operation name
      • the new porch_in_flight_api_operations up/down counter and its attributes
    • Added to the resources-and-operations table to reflect additional GET support on PackageRevision (porch-controllers, v1alpha2) and a new PackageRevisionApproval row (porch-controllers, UPDATE, v1alpha2)
      • additional operations driven from controllers and not metric'ed in initial v1alpha2 implementation
  • Why it’s needed:

Related Issue(s)


Type of Change

  • Bug fix
  • New feature
  • Enhancement
  • Refactor
  • Documentation
  • Tests
  • Other: Observability / Grafana dashboard

Checklist

  • Code follows project style guidelines
  • Self-reviewed changes
  • Tests added/updated
  • Documentation added/updated
  • All tests and gating checks pass

Testing Instructions (Optional)

  1. Deploy the local monitoring stack with make deploy-monitoring
  2. Access the "Porch API" dashboard in Grafana
  3. Observe the new "All Resources — In-Flight Operation Count by Resource, Operation & User" panel renders and queries porch_in_flight_api_operations
  4. Render the updated opentelemetry.md docs page with hugo serve; verify the new "Request Counts - In Flight" section and expanded attribute tables display correctly.

AI Disclosure

  • I have used AI in the creation of this PR.

If so, please describe how:

  • Kiro to review dashboard and documentation changes
  • Kiro to generate this pull request description from Git diffs

Signed-off-by: James McDermott <james.j.mcdermott@ericsson.com>
…ted) user

- nitpick in PackageRevision/PackageRevisions distinction in doc table

Signed-off-by: James McDermott <james.j.mcdermott@ericsson.com>
@JamesMcDermott
JamesMcDermott requested review from a team and a balanced review from Copilot October 13, 2026 16:50
@netlify

netlify Bot commented Oct 13, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for kpt-porch ready!

Name Link
🔨 Latest commit 85a2b03
🔍 Latest deploy log https://app.netlify.com/projects/kpt-porch/deploys/6ae1ba0f349cd52a8fafdfac
😎 Deploy Preview https://deploy-preview-1281--kpt-porch.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 Changes recommended

The new Grafana panel occupies the same grid position as an existing full-width panel.

2 open findings
What changed in this PR

Updates observability documentation and Grafana visualization for metrics introduced by #1198.

Changes:

  • Documents expanded API duration and in-flight operation metrics.
  • Adds an in-flight operations Grafana panel.
  • Updates documented resource-operation mappings.
File Description
docs/​content/​en/​docs/​6_configuration_and_deployments/​configurations/​opentelemetry.md Documents metric attributes, names, and operations.
deployments/​metrics-resources/​grafana-porch-server-dashboard.json Adds the in-flight operations panel.

🧠 Review effort: Balanced


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@efiacor

efiacor commented Oct 15, 2026

Copy link
Copy Markdown
Contributor

@netlify rebuild

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

just a few minor nitpicks. will review in conjunction with #1198 later as one unit.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

good stuff

@efiacor efiacor mentioned this pull request Oct 22, 2026
4 of 13 tasks
@liamfallon
liamfallon merged commit d3b39cd into kptdev:main Oct 28, 2026
27 checks passed
@JamesMcDermott
JamesMcDermott deleted the docs-porch-operation-metrics branch October 28, 2026 11:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants