Skip to content

docs(observe): fix dataset name, Data Stream filter, and Grafana Data path - #2573

Merged
bruno-andrade-azion merged 3 commits into
mainfrom
docs/mm-16224-observe-dataset-filter-grafana
Nov 12, 2026
Merged

bruno-andrade-azion merged 3 commits into
mainfrom
docs/mm-16224-observe-dataset-filter-grafana

Conversation

@bruno-andrade-azion

@bruno-andrade-azion bruno-andrade-azion commented Nov 5, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Real-Time Events data sources: the Image Processor section named the dataset imageProcessedEvents, which doesn't exist, so a copied query fails with "Cannot query field". It's now imagesProcessedEvents, matching the GraphQL reference and the link anchor.
  • Real-Time Events filters: the example endpoint_type='datadog' returned nothing. Endpoint types are uppercase (DATADOG, as in the data source table and the GraphQL reference), and = is an exact match.
  • Grafana plugin guides (events + metrics): Data path said Events / Metrics. In aziontech/grafana-plugin, getDocs() walks response.data by that dot path and throws Your data path did not exist! otherwise. The plugin defaults to dataPath: 'httpMetrics'. Metrics/Events is a separate control, the query editor's Data source list (dataSourceSelect), which picks the API. Each guide now has a step for that list, and Data path takes the dataset name. I also fixed the garbled "Beside the search bar, search" step.

en and pt-br changed in the same PR.

How to test

  1. pnpm dev in apps/docs.
  2. Open /en/documentation/guides/platform/observability/azion-plugin-grafana-custom-dash/ and the events custom-table guide (plus the pt-br twins). Check that the new Select the Metrics API / Select the Events API step renders, and that the Data path row and bullet name the dataset.
  3. Open the Real-Time Events Data sources page. The Image Processor paragraph names imagesProcessedEvents.
  4. Open Real-Time Events Add filters. The example row reads endpoint_type='DATADOG'.

All 8 changed files compile with @mdx-js/mdx. I didn't run a full site build.

URL changes and redirects

None

Notes

  • Jira: MM-16224 (epic MM-16212). This answers question 3 of real-time-metrics.md in MM-16194 from the plugin source.
  • Out of scope: switching the deprecated httpMetrics to workloadMetrics across 17 pages (review finding Integration services sp #5). It waits on the GraphQL owner, so the examples keep httpMetrics to match their queries.

… path (MM-16224)

- Real-Time Events data sources: rename the nonexistent imageProcessedEvents
  dataset to imagesProcessedEvents, as the GraphQL reference names it.
- Real-Time Events filters: use endpoint_type='DATADOG'. Endpoint types are
  uppercase and = is an exact match.
- Grafana plugin guides: Data path takes the dataset name the query reads
  (httpMetrics, workloadEvents), not Metrics/Events. Metrics/Events is the
  query editor's Data source list, now its own step. Behavior confirmed in
  aziontech/grafana-plugin (getDocs walks response.data by dataPath).
- Fix the garbled "Create a dashboard" step in the events guide.

en and pt-br changed together.

Co-Authored-By: Claude <noreply@anthropic.com>
* origin/main: (29 commits)
  fix(structure): tag bare code fences, fix heading skips, add pt-br meta_tags (#2629)
  docs(style-guide): drop the nonexistent GlossaryFilter from the glossary template (#2577)
  docs(release-notes): fix the October 14 anchor and merge the duplicate February 24 entry (#2572)
  fix(orchestrator): fix broken bind and create-service API samples (#2574)
  docs(readability): split the long sentences in the Runtime, CLI, Reference, and KV Store pages (#2635)
  chore(nav): count only visible rows toward the navcheck soft max (#2640)
  docs(nav): triage the pages outside the navigation (#2593)
  fix(guides): match the QStash variable and the Functions usage response to the code (#2571)
  feat(nav): give every breadcrumb crumb a page and make CLI commands runnable (#2636)
  fix(cli): drop azion update workload-deployment, which the CLI does not expose (#2639)
  docs(terminology): retire Edge Node, module, and add-on from current pages (#2618)
  docs(migration): share the repeated migration-guide procedures as partials (#2619)
  fix(marketplace): drop the Azion CLI prerequisite from firewall integration guides (#2612)
  docs(guides): replace the residual "These checks confirm" lines with use-case expect blocks (#2611)
  docs(guides): make the auth layer and vector search tutorials runnable (#2566)
  chore(scripts): add pnpm lint:terraform to validate Terraform samples (#2637)
  fix(firewall): correct the CLI binding, the WAF config sample, and the JWT paywall steps (#2565)
  docs(cli): document azion workload-deployment and fix pages that say the CLI cannot bind a deployment (#2567)
  docs(terraform): rewrite the samples for provider v2.10.0 (#2557)
  chore(deploy): promote docs-v2.4.4 to production (#2631)
  ...

# Conflicts:
#	apps/docs/src/content/docs/en/pages/observe/real-time-events/data-sources.mdx
#	apps/docs/src/content/docs/pt-br/pages/observe/real-time-events/fontes-de-dados.mdx
@bruno-andrade-azion bruno-andrade-azion changed the title docs(observe): fix dataset name, Data Stream filter, and Grafana Data path (MM-16224) docs(observe): fix dataset name, Data Stream filter, and Grafana Data path Nov 12, 2026
…ta sources pages

The merge of main kept this branch's whole version of data-sources.mdx and
fontes-de-dados.mdx, which reverted the anchor updates from #2636 and a
Tiered Cache row. Take main's version and keep only the
imagesProcessedEvents fix.
@bruno-andrade-azion
bruno-andrade-azion merged commit e302ed0 into main Nov 12, 2026
9 checks passed
@bruno-andrade-azion
bruno-andrade-azion deleted the docs/mm-16224-observe-dataset-filter-grafana branch November 12, 2026 16:17
bruno-andrade-azion pushed a commit that referenced this pull request Nov 12, 2026
* origin/main: (39 commits)
  fix(terminology): replace desempenho and aplicativo in pt-br pages (#2621)
  docs(observe): fix dataset name, Data Stream filter, and Grafana Data path (#2573)
  fix(fundamentals): rewrite the Load Balancer steps in minimize-downtime from the reference (#2578)
  i18n(pt-br): label unlabelled asides and fix label casing (#2622)
  fix(links): point pt-br links to their existing pt-br pages (#2620)
  i18n(pt-br): resync the drifted release notes, punctuation, and Edge Services pairs (#2624)
  i18n(pt-br): pair three pages with their English versions by namespace (#2625)
  docs(style-guide): adopt the jsonl tag for JSON Lines samples (#2642)
  chore(lint): check the changelog entries a PR adds (#2634)
  [NO-ISSUE] ci: replace technote-space/assign-author (SO-5131) (#2591)
  fix(structure): tag bare code fences, fix heading skips, add pt-br meta_tags (#2629)
  docs(style-guide): drop the nonexistent GlossaryFilter from the glossary template (#2577)
  docs(release-notes): fix the October 14 anchor and merge the duplicate February 24 entry (#2572)
  fix(orchestrator): fix broken bind and create-service API samples (#2574)
  docs(readability): split the long sentences in the Runtime, CLI, Reference, and KV Store pages (#2635)
  chore(nav): count only visible rows toward the navcheck soft max (#2640)
  docs(nav): triage the pages outside the navigation (#2593)
  fix(guides): match the QStash variable and the Functions usage response to the code (#2571)
  feat(nav): give every breadcrumb crumb a page and make CLI commands runnable (#2636)
  fix(cli): drop azion update workload-deployment, which the CLI does not expose (#2639)
  ...

# Conflicts:
#	apps/docs/src/content/docs/en/pages/store/sql-database/glossary.mdx
#	apps/docs/src/content/docs/pt-br/pages/store/sql-database/glossario.mdx
bruno-andrade-azion pushed a commit that referenced this pull request Nov 12, 2026
* origin/main: (53 commits)
  docs(style-guide): standardize Azion Console click paths (#2596)
  docs(store): name the SQL and Storage libraries by their scoped packages (#2575)
  fix(terminology): replace desempenho and aplicativo in pt-br pages (#2621)
  docs(observe): fix dataset name, Data Stream filter, and Grafana Data path (#2573)
  fix(fundamentals): rewrite the Load Balancer steps in minimize-downtime from the reference (#2578)
  i18n(pt-br): label unlabelled asides and fix label casing (#2622)
  fix(links): point pt-br links to their existing pt-br pages (#2620)
  i18n(pt-br): resync the drifted release notes, punctuation, and Edge Services pairs (#2624)
  i18n(pt-br): pair three pages with their English versions by namespace (#2625)
  docs(style-guide): adopt the jsonl tag for JSON Lines samples (#2642)
  chore(lint): check the changelog entries a PR adds (#2634)
  [NO-ISSUE] ci: replace technote-space/assign-author (SO-5131) (#2591)
  fix(structure): tag bare code fences, fix heading skips, add pt-br meta_tags (#2629)
  docs(style-guide): drop the nonexistent GlossaryFilter from the glossary template (#2577)
  docs(release-notes): fix the October 14 anchor and merge the duplicate February 24 entry (#2572)
  fix(orchestrator): fix broken bind and create-service API samples (#2574)
  docs(readability): split the long sentences in the Runtime, CLI, Reference, and KV Store pages (#2635)
  chore(nav): count only visible rows toward the navcheck soft max (#2640)
  docs(nav): triage the pages outside the navigation (#2593)
  fix(guides): match the QStash variable and the Functions usage response to the code (#2571)
  ...

# Conflicts:
#	apps/docs/src/content/docs/en/pages/main-menu/reference/accounts/personal-tokens.mdx
#	apps/docs/src/content/docs/en/pages/main-menu/reference/services/support/http-error-status-codes.mdx
#	apps/docs/src/content/docs/pt-br/pages/menu-principal/referencia/contas/personal-tokens.mdx
bruno-andrade-azion pushed a commit that referenced this pull request Nov 12, 2026
* origin/main: (48 commits)
  docs(templates): list the Astro templates that only the showcase covered (#2595)
  docs(orchestrator): consolidate duplicate guides and write How it works (#2588)
  docs(secure): retire the pre-Workloads security journey and guide pages (#2586)
  docs(applications): Run Function needs only Functions; fix WEBP and CORS prerequisites (#2580)
  docs(fundamentals): apply the reader review and the style guide to the Fundamentals pages (#2558)
  fix(observe): name the query editor list instead of its position in the Grafana guides (#2643)
  docs(templates): migrate the legacy template guides to the current guide pattern (#2597)
  docs(style-guide): standardize Azion Console click paths (#2596)
  docs(store): name the SQL and Storage libraries by their scoped packages (#2575)
  fix(terminology): replace desempenho and aplicativo in pt-br pages (#2621)
  docs(observe): fix dataset name, Data Stream filter, and Grafana Data path (#2573)
  fix(fundamentals): rewrite the Load Balancer steps in minimize-downtime from the reference (#2578)
  i18n(pt-br): label unlabelled asides and fix label casing (#2622)
  fix(links): point pt-br links to their existing pt-br pages (#2620)
  i18n(pt-br): resync the drifted release notes, punctuation, and Edge Services pairs (#2624)
  i18n(pt-br): pair three pages with their English versions by namespace (#2625)
  docs(style-guide): adopt the jsonl tag for JSON Lines samples (#2642)
  chore(lint): check the changelog entries a PR adds (#2634)
  [NO-ISSUE] ci: replace technote-space/assign-author (SO-5131) (#2591)
  fix(structure): tag bare code fences, fix heading skips, add pt-br meta_tags (#2629)
  ...

# Conflicts:
#	apps/docs/src/content/docs/en/pages/main-menu/reference/accounts/billing.mdx
#	apps/docs/src/content/docs/en/pages/main-menu/reference/accounts/teams-permissions.mdx
#	apps/docs/src/content/docs/pt-br/pages/menu-principal/referencia/contas/faturamento.mdx
#	apps/docs/src/content/docs/pt-br/pages/menu-principal/referencia/contas/teams-permissions.mdx
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants