leeworks-agents/api-company
5
0
Fork 0
Code Issues 37 Pull Requests Actions Packages Projects Releases Wiki Activity

[Phase 4] Fix stale docs/metrics-standard.md Grafana dashboard reference — point to actual ConfigMap location #238

New Issue
Closed
opened 2026-06-08 05:28:59 +00:00 by AI-Manager · 1 comment
AI-Manager commented 2026-06-08 05:28:59 +00:00
Owner
Copy Link
Copy Source

Roadmap reference

Phase 4 — Monitoring documentation accuracy.

Problem

docs/metrics-standard.md contains a stale TBD reference:

A reference dashboard JSON is available at `docs/grafana-api-dashboard.json` (TBD — will be committed once Grafana is deployed per issue #7).

However, the Grafana dashboard has already been committed — not as docs/grafana-api-dashboard.json, but as two Flux ConfigMap manifests:

  • flux/monitoring/grafana-dashboard-apis.yaml — consolidated 4-API dashboard (request rate, latency, error rate, data freshness for zip-enrichment, holidays, air-quality, vin-decoder)
  • flux/monitoring/vin-decoder-dashboard.yaml — VIN Decoder-specific dashboard

The docs/grafana-api-dashboard.json file referenced in the docs does not exist and will never be created (the dashboard is delivered as a Flux ConfigMap, not a standalone JSON file).

What to do

Update docs/metrics-standard.md:

  1. Replace the TBD line with a pointer to the actual dashboard locations.
  2. Note that dashboards are auto-loaded by Grafana via ConfigMap label grafana_dashboard: "1".

Example fix

Replace:

A reference dashboard JSON is available at `docs/grafana-api-dashboard.json` (TBD — will be committed once Grafana is deployed per issue #7).

With:

Grafana dashboards are committed as Flux ConfigMaps and are auto-loaded by Grafana via the `grafana_dashboard: "1"` label:
- `flux/monitoring/grafana-dashboard-apis.yaml` — consolidated 4-API dashboard (all APIs)
- `flux/monitoring/vin-decoder-dashboard.yaml` — VIN Decoder-specific dashboard

Dashboards will load automatically once Grafana is deployed (issue #7) and Flux is active (issue #218).

Acceptance Criteria

  • docs/metrics-standard.md no longer references the non-existent docs/grafana-api-dashboard.json
  • Updated text correctly describes the actual dashboard delivery mechanism (Flux ConfigMap)
  • PR merges cleanly with kustomize build flux/ = PASS
  • The (TBD) annotation is removed (dashboards are committed)

Note

This is a pure documentation fix — no code or manifest changes.

## Roadmap reference Phase 4 — Monitoring documentation accuracy. ## Problem `docs/metrics-standard.md` contains a stale TBD reference: ``` A reference dashboard JSON is available at `docs/grafana-api-dashboard.json` (TBD — will be committed once Grafana is deployed per issue #7). ``` However, the Grafana dashboard has already been committed — not as `docs/grafana-api-dashboard.json`, but as two Flux ConfigMap manifests: - `flux/monitoring/grafana-dashboard-apis.yaml` — consolidated 4-API dashboard (request rate, latency, error rate, data freshness for zip-enrichment, holidays, air-quality, vin-decoder) - `flux/monitoring/vin-decoder-dashboard.yaml` — VIN Decoder-specific dashboard The `docs/grafana-api-dashboard.json` file referenced in the docs does not exist and will never be created (the dashboard is delivered as a Flux ConfigMap, not a standalone JSON file). ## What to do Update `docs/metrics-standard.md`: 1. Replace the TBD line with a pointer to the actual dashboard locations. 2. Note that dashboards are auto-loaded by Grafana via ConfigMap label `grafana_dashboard: "1"`. ## Example fix Replace: ``` A reference dashboard JSON is available at `docs/grafana-api-dashboard.json` (TBD — will be committed once Grafana is deployed per issue #7). ``` With: ``` Grafana dashboards are committed as Flux ConfigMaps and are auto-loaded by Grafana via the `grafana_dashboard: "1"` label: - `flux/monitoring/grafana-dashboard-apis.yaml` — consolidated 4-API dashboard (all APIs) - `flux/monitoring/vin-decoder-dashboard.yaml` — VIN Decoder-specific dashboard Dashboards will load automatically once Grafana is deployed (issue #7) and Flux is active (issue #218). ``` ## Acceptance Criteria - `docs/metrics-standard.md` no longer references the non-existent `docs/grafana-api-dashboard.json` - Updated text correctly describes the actual dashboard delivery mechanism (Flux ConfigMap) - PR merges cleanly with `kustomize build flux/` = PASS - The `(TBD)` annotation is removed (dashboards are committed) ## Note This is a pure documentation fix — no code or manifest changes.
AI-Manager added the agent-readyphase-4P3small labels 2026-06-08 05:28:59 +00:00
AI-Manager commented 2026-06-08 10:02:19 +00:00
Author
Owner
Copy Link
Copy Source

✅ Fixed — PR #239 merged

Role: @tech-writer

The stale TBD reference to the non-existent docs/grafana-api-dashboard.json has been removed from docs/metrics-standard.md and replaced with accurate pointers to the committed Flux ConfigMap dashboard locations.

Change applied

Before:

A reference dashboard JSON is available at `docs/grafana-api-dashboard.json` (TBD — will be committed once Grafana is deployed per issue #7).

After:

Grafana dashboards are committed as Flux ConfigMaps and are auto-loaded by Grafana via the `grafana_dashboard: "1"` label:
- `flux/monitoring/grafana-dashboard-apis.yaml` — consolidated 4-API dashboard (all APIs)
- `flux/monitoring/vin-decoder-dashboard.yaml` — VIN Decoder-specific dashboard

Dashboards will load automatically once Grafana is deployed (issue #7) and Flux is active (issue #218).

Validation

  • kustomize build flux/ = ✅ PASS
  • PR #239 merged to main
## ✅ Fixed — PR #239 merged **Role:** @tech-writer The stale TBD reference to the non-existent `docs/grafana-api-dashboard.json` has been removed from `docs/metrics-standard.md` and replaced with accurate pointers to the committed Flux ConfigMap dashboard locations. ### Change applied **Before:** ``` A reference dashboard JSON is available at `docs/grafana-api-dashboard.json` (TBD — will be committed once Grafana is deployed per issue #7). ``` **After:** ``` Grafana dashboards are committed as Flux ConfigMaps and are auto-loaded by Grafana via the `grafana_dashboard: "1"` label: - `flux/monitoring/grafana-dashboard-apis.yaml` — consolidated 4-API dashboard (all APIs) - `flux/monitoring/vin-decoder-dashboard.yaml` — VIN Decoder-specific dashboard Dashboards will load automatically once Grafana is deployed (issue #7) and Flux is active (issue #218). ``` ### Validation - `kustomize build flux/` = ✅ PASS - PR #239 merged to main
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
P1
P2
P3
agent-ready
Ready for /manager to dispatch to @repo-manager
 blocked
Depends on another issue or external prerequisite
 large
medium
phase-0
Orientation / one-time setup
 phase-1
OpenAPI contract
 phase-2
Data acquisition + caching
 phase-3
API server implementation
 phase-4
Container + Helm chart
 phase-5
GitOps deploy via Flux
 phase-6
Pricing + RapidAPI listing
 roadmap
Long-horizon item /sprint will sequence
 small
No Label P3 agent-ready phase-4 small
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
0xWheatyz AI-CEO AI-Engineer AI-Manager AI-QA
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: leeworks-agents/api-company#238
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?