Skip to content

Add TrafficPeak APIContext bundle#196

Open
tom-howe-hdx wants to merge 4 commits into
mainfrom
catalog-export/apicontext
Open

Add TrafficPeak APIContext bundle#196
tom-howe-hdx wants to merge 4 commits into
mainfrom
catalog-export/apicontext

Conversation

@tom-howe-hdx

Copy link
Copy Markdown
Collaborator

Summary

  • Import TrafficPeak APIContext 1.0.0 bundle into IDT
  • Add portable CAC source, generated bundle assets, dashboards, summary table, and transform
  • Uses apicontext as the raw table and apicontext_sampled_day as the dashboard summary table

Validation

  • Performance review: pass with live read-only MCP evidence on demo.trafficpeak.live
  • CAC validation: bundle parsing, hdx/grafana structure consistency, compatibility, and extend resolution passed
  • IDT pipeline: uv run --python 3.11 --with pyyaml python scripts/run_pipeline.py --bundle-dir trafficpeak/apicontext --config trafficpeak/apicontext/bundle-config.json --track full --skip-validate --verbose

@tom-howe-hdx tom-howe-hdx added the bundle request for bundle submissions label Apr 29, 2026
@tom-howe-hdx tom-howe-hdx had a problem deploying to bundle-validator-env April 29, 2026 01:23 — with GitHub Actions Failure
@tom-howe-hdx tom-howe-hdx temporarily deployed to bundle-runbook-env April 29, 2026 01:23 — with GitHub Actions Inactive
@tom-howe-hdx tom-howe-hdx temporarily deployed to bundle-validator-env April 29, 2026 01:31 — with GitHub Actions Inactive
Primary `start_time` was 2024-10-07 — ~569 days stale, well past the 183-day
freshness threshold. The validator silently skipped the staleness check (root
cause tracked in LOTC-1523), so the bundle would have hit ingest verification
issues on deploy: rows landing far outside default dashboard time windows.

Shifted all three datetime fields by the primary's delta to first-of-month UTC
(matches what the auto-shifter would do post-LOTC-1523), preserving the
original relative ordering. Applied to both the configured bundle and the
portables CAC copy:

  start_time:  2024-10-07T06:27:17.160556Z -> 2026-04-01T00:00:00.000000Z
  last_update: 2024-06-05T17:11:36.588106Z -> 2025-11-28T10:44:19.427550Z
  created:     2019-06-05T17:11:36.444708Z -> 2020-11-27T10:44:19.284152Z

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@kevinborkman-hub kevinborkman-hub temporarily deployed to bundle-validator-env April 29, 2026 19:00 — with GitHub Actions Inactive
Three issues surfaced when running `--local` against the cluster:

1. `transform.json` had `settings.data_mirroring_target: null` (import
   artifact). The Hydrolix config API rejects this with "not a parameter
   that can be used". Removed from both the configured bundle and the
   portables CAC copy. No other bundle in the repo carries this field.

2. Both dashboards used `${__interval_s:raw}` for time bucketing, which
   the Hydrolix Grafana plugin does not interpolate in this position --
   the literal `${...}` string reaches ClickHouse and fails parsing at
   the `$`. Switched to `INTERVAL $__interval_s SECOND` (bare Grafana
   built-in, always interpolated to an integer before reaching the
   datasource), preserving the original dynamic-bucketing intent.

3. The secondary dashboard (network-monitoring-dashboard-synthetics)
   had its `apicontext_sampled_day` constant set to bare
   `__SUMMARY_TABLE_NAME_1__`. Per the project convention (also seen in
   bot_insights, cdn-insights, etc.), secondary dashboards must use
   `__PROJECT_NAME__.__SUMMARY_TABLE_NAME_N__` because
   `grafana::dashboard::create_others` substitutes only the bare summary
   name. The primary dashboard correctly uses bare
   `__SUMMARY_TABLE_NAME_1__` because `default::create_summary_table`
   substitutes it with the already-prefixed `project.summary` form.

Bundle now deploys cleanly and both dashboards render against the
populated test project.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@kevinborkman-hub kevinborkman-hub temporarily deployed to bundle-validator-env April 29, 2026 20:50 — with GitHub Actions Inactive
@@ -0,0 +1,5 @@
{
"data_category": "security",

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

data_category should be "api" for this one so it can structure the cac-bundle format into the API directory for Grafana.

hdx-main-folder:
name: TrafficPeak Certified Reference Dashboards
children:
hdx-security-folder:

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

changing data_category in the bundle-config should update this. If not, this should be API Context

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

hdx-api-folder:
name: API Context

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bundle request for bundle submissions

Development

Successfully merging this pull request may close these issues.

4 participants