Skip to content

Add operational telemetry, privacy safeguards, and dashboard recipes - #56

Open
elpete wants to merge 18 commits into
developmentfrom
codex/reusable-observability
Open

elpete wants to merge 18 commits into
developmentfrom
codex/reusable-observability

Conversation

@elpete

@elpete elpete commented Oct 24, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Add opt-in operational telemetry for runtime health, request saturation, handler/render timings, dependencies, queues, database pools and delivery diagnostics. Automatic collectors use bounded state, fixed labels, isolated adapter failures and shutdown cleanup; manual instrumentation preserves callback results and exceptions.

Preserve PostgreSQL quoted identifiers while redacting values and comments. Keep private feedback text available without importing screenshot/replay capture dependencies. Retain the request-completion fixes for binary aborts and reused workers.

Add offline, consumer-configured performance dashboard recipes. Consumers can separate exact suspect-asset route descriptions from application latency and matching counts while retaining those spans in investigation charts and the all-route/release table. No duration or success cutoff hides slow requests. JVM/queue gauges retain matching sample coverage, and inclusive phases remain separate.

Configuration and ownership

  • Configure automatic sampling through automaticCollectors and a provider-neutral queues list. Providers own queue selection, schema, datasource and query implementation.
  • Observe explicitly configured WireBox methods; existing instances and objects constructed outside WireBox require manual instrumentation.
  • Keep ad hoc request phase names available without prior configuration; Server-Timing publication remains separately opt-in.
  • Generate dashboard recipes with Node built-ins and explicit consumer scopes. The generator does not access Sentry or create dashboards, alerts or telemetry. Consumer routes, project IDs and credentials are excluded from module defaults.
  • Include the earlier PostgreSQL and private-feedback follow-ups from Skip capture imports on private feedback screens #57, preserving module version metadata (2.2.2).

Use qb 14.2.0 or later for QueryTelemetryAdapter@qb and cbq 7.1.0 or later for QueueHealthAdapter@cbq; neither is a dependency or default. Enable metrics and a valid DSN before automatic collection. Keep sentry.endRequest() in application cleanup for early exits.

Operational configuration · Query/browser behavior · Dashboard recipes

Validation

Combined head: 62c6cb8, based on the previous PR head a75a3bd. The consolidation adds only four dashboard files and the README link; runtime code and workflow configuration are identical to a75a3bd.

  • Fresh recipe tests: 5 passed, zero failures. Covers scope validation, readiness separation, optional exact asset split, queue sample coverage and inclusive phase grouping.
  • CLI smoke: example configuration generated valid JSON offline.
  • Whitespace check passed.
  • Prior backend/browser validation is recorded in the existing PR and operational-verification.md. Those runs predate this recipe consolidation; no new backend or browser run is claimed here.
  • The pushed head includes [skip ci] to preserve the hosted-workflow pause. No workflow was dispatched, and no package release, deployment or live ingestion check was performed.

CommuniArts draft-saving timings and autosave optimization are tracked separately in https://github.com/elpete/CommuniArts/pull/19 and are excluded from this module PR.

Closes #55

@github-actions

github-actions Bot commented Oct 24, 2026 •

Copy link
Copy Markdown

lucee@5 ColdBox be Test Results

128 tests   126 ✅  6s ⏱️
 14 suites    2 💤
  1 files      0 ❌

Results for commit a922121.

♻️ This comment has been updated with latest results.

@github-actions

github-actions Bot commented Oct 24, 2026 •

Copy link
Copy Markdown

lucee@6 ColdBox be Test Results

128 tests   126 ✅  4s ⏱️
 14 suites    2 💤
  1 files      0 ❌

Results for commit a922121.

♻️ This comment has been updated with latest results.

@github-actions

github-actions Bot commented Oct 24, 2026 •

Copy link
Copy Markdown

lucee@5 ColdBox ^7.0.0 Test Results

128 tests   126 ✅  6s ⏱️
 14 suites    2 💤
  1 files      0 ❌

Results for commit a922121.

♻️ This comment has been updated with latest results.

@github-actions

github-actions Bot commented Oct 24, 2026 •

Copy link
Copy Markdown

adobe@2018 ColdBox ^7.0.0 Test Results

128 tests   126 ✅  5s ⏱️
 14 suites    2 💤
  1 files      0 ❌

Results for commit a922121.

♻️ This comment has been updated with latest results.

@github-actions

github-actions Bot commented Oct 24, 2026 •

Copy link
Copy Markdown

adobe@2018 ColdBox ^6.0.0 Test Results

128 tests   126 ✅  6s ⏱️
 14 suites    2 💤
  1 files      0 ❌

Results for commit a922121.

♻️ This comment has been updated with latest results.

@github-actions

github-actions Bot commented Oct 24, 2026 •

Copy link
Copy Markdown

lucee@5 ColdBox ^6.0.0 Test Results

128 tests   126 ✅  5s ⏱️
 14 suites    2 💤
  1 files      0 ❌

Results for commit a922121.

♻️ This comment has been updated with latest results.

@github-actions

github-actions Bot commented Oct 24, 2026 •

Copy link
Copy Markdown

boxlang@1 ColdBox be Test Results

128 tests   126 ✅  6s ⏱️
 14 suites    2 💤
  1 files      0 ❌

Results for commit a922121.

♻️ This comment has been updated with latest results.

@github-actions

github-actions Bot commented Oct 24, 2026 •

Copy link
Copy Markdown

adobe@2021 ColdBox ^6.0.0 Test Results

128 tests   126 ✅  6s ⏱️
 14 suites    2 💤
  1 files      0 ❌

Results for commit a922121.

♻️ This comment has been updated with latest results.

@github-actions

github-actions Bot commented Oct 24, 2026 •

Copy link
Copy Markdown

adobe@2021 ColdBox ^7.0.0 Test Results

128 tests   126 ✅  5s ⏱️
 14 suites    2 💤
  1 files      0 ❌

Results for commit a922121.

♻️ This comment has been updated with latest results.

@github-actions

github-actions Bot commented Oct 24, 2026 •

Copy link
Copy Markdown

adobe@2021 ColdBox be Test Results

128 tests   126 ✅  4s ⏱️
 14 suites    2 💤
  1 files      0 ❌

Results for commit a922121.

♻️ This comment has been updated with latest results.

@github-actions

github-actions Bot commented Oct 24, 2026 •

Copy link
Copy Markdown

adobe@2023 ColdBox ^6.0.0 Test Results

128 tests   126 ✅  5s ⏱️
 14 suites    2 💤
  1 files      0 ❌

Results for commit a922121.

♻️ This comment has been updated with latest results.

@github-actions

github-actions Bot commented Oct 24, 2026 •

Copy link
Copy Markdown

adobe@2023 ColdBox be Test Results

128 tests   126 ✅  5s ⏱️
 14 suites    2 💤
  1 files      0 ❌

Results for commit a922121.

♻️ This comment has been updated with latest results.

@github-actions

github-actions Bot commented Oct 24, 2026 •

Copy link
Copy Markdown

adobe@2023 ColdBox ^7.0.0 Test Results

128 tests   126 ✅  5s ⏱️
 14 suites    2 💤
  1 files      0 ❌

Results for commit a922121.

♻️ This comment has been updated with latest results.

@elpete elpete changed the title Add reusable operational telemetry Add reusable operational telemetry and automatic collectors Oct 24, 2026
@elpete elpete changed the title Add reusable operational telemetry and automatic collectors Add operational telemetry and tighten query and feedback privacy Oct 31, 2026
@elpete
elpete marked this pull request as ready for review October 31, 2026 02:04
@elpete elpete changed the title Add operational telemetry and tighten query and feedback privacy Add operational telemetry, privacy safeguards, and dashboard recipes Nov 3, 2026
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.

Add reusable operational telemetry

1 participant