Macro Reference

GrafanaSight provides seven Confluence macros. Use this page when you need to choose the right macro for a runbook, explain what a label means, or confirm which buttons readers and authors should expect.

The examples below use the Supabase Production Health Runbook connected to the Supabase Project dashboard in Grafana Cloud.

Configure Macros In The Confluence Editor

Select a GrafanaSight macro chip in the Confluence editor, then choose the pencil icon in the floating toolbar to open the configuration dialog. Use Save configuration only when the field values are ready for the page; use Close to leave the macro unchanged.

Panel configuration labels:

• Grafana panel URL accepts a Grafana dashboard URL with viewPanel or a /d-solo/ URL.
• Dashboard lets the author choose from cached dashboards.
• Panel lets the author choose from the selected dashboard’s cached panels.
• Time range switches between Relative preset and Absolute range.
• Preset stores a relative range such as Last 6h.
• Current selection confirms the range that will be saved.

Lower panel configuration labels:

• Template variables lets authors override Grafana variables without editing URL parameters.
• Each variable card shows the display name and the Grafana query key, such as var-project or var-datasource.
• Use default clears an override and falls back to the Grafana dashboard default.
• Optional title override replaces the macro’s reader-facing title without renaming the Grafana panel.
• Save configuration submits the macro settings.
• Close exits configuration without saving.

Dashboard, alert, status, and annotation macros use the same configuration shell with mode-specific fields.

Detailed Panel Macro

Module key: gs-panel

Use the detailed panel macro when one Grafana panel is the main signal on a page. GrafanaSight renders the panel image from Grafana Cloud, then adds page-friendly metadata and actions.

Labels and controls:

• The panel image shows the selected Grafana panel at the configured time range.
• The title is the Grafana panel title unless the author sets a title override.
• The folder label shows where the dashboard lives in Grafana.
• The snapshot timestamp shows when GrafanaSight last fetched or refreshed the panel snapshot.
• Refresh panel asks GrafanaSight to fetch a fresh panel snapshot.
• Open in Grafana opens the source panel or dashboard context in Grafana Cloud.

Configuration fields:

• Source URL: a Grafana dashboard URL with viewPanel or a /d-solo/ panel URL.
• Dashboard: selected from the cached dashboard catalog when available.
• Panel: selected from the dashboard’s cached panels.
• Time range: relative presets or an absolute range.
• Template variables: var-* values passed to Grafana, such as project or datasource.
• Title override: optional reader-facing title for the macro.

Compact Panel Macro

Module key: gs-panel-compact

Use the compact panel macro when the page needs a smaller supporting metric, such as a service summary, an executive scan row, or several panels side by side in a runbook.

Labels and controls:

• The image is a smaller Grafana render of the same source panel.
• The folder, title, dashboard name, visualization type, and update timestamp keep the compact card traceable.
• Refresh refreshes the compact panel snapshot.
• Open opens the source Grafana context.

Configuration fields are the same as the detailed panel macro. Choose compact when density matters more than a large visual.

Detailed Dashboard Macro

Module key: gs-dash

Use the detailed dashboard macro to orient a page around a whole Grafana dashboard without forcing every reader into Grafana.

Labels and controls:

• GRAFANA marks the content as Grafana-backed.
• The folder label identifies the Grafana folder.
• The panel count shows how many non-row panels GrafanaSight found.
• The dashboard title and Grafana URL identify the source.
• Tags show dashboard taxonomy from Grafana.
• Why this macro exists explains that the macro is a Confluence summary, not a full Grafana replacement.
• The top panels table lists important dashboard panels and visualization types.
• Refresh refreshes the dashboard overview cache.
• Open in Grafana opens the source dashboard.

Configuration fields:

• Source URL: a supported Grafana /d/ dashboard URL.
• Dashboard: selected from the cached catalog when available.
• Save configuration: stores the selected dashboard overview settings.
• Close: exits without changing the macro.

Compact Dashboard Macro

Module key: gs-dash-compact

Use the compact dashboard macro when a runbook needs a one-line dashboard reference with the dashboard title, folder, panel count, tags, and Grafana link.

Labels and controls:

• GRAFANA marks the row as Grafana-backed.
• The dashboard title identifies the source dashboard.
• Folder, panel count, and tags help readers confirm they are looking at the right dashboard.
• Open in Grafana opens the source dashboard.

Configuration fields are the same as the detailed dashboard macro.

Alert Summary Macro

Module key: gs-alerts

Use the alert summary macro when a page needs the current cached Grafana alert records in table form.

Labels and controls:

• GRAFANA marks the macro as Grafana-backed.
• The active count shows the number of matching alert records.
• The snapshot timestamp shows when GrafanaSight last fetched alert data.
• Scope explains the active filters, such as all active alerts, states, severity, or label text.
• The table shows alert title, state, severity, start time, and an action.
• Open opens the alert source when Grafana provides a generator URL.
• Refresh refreshes the alert summary from the GrafanaSight cache path.

Configuration fields:

• States: comma-separated alert states to include. Leave blank for all active alerts.
• Severity: optional exact severity filter.
• Label contains: optional key:value label text filter.
• Max items: maximum alerts shown in the table.
• Save configuration: stores alert filters.
• Close: exits without changing the macro.

Verification note: during documentation QA, the page byline showed six active alerts while an alert summary macro configured with states=firing,pending showed no rows. The source-backed cause is filter mismatch: the byline asks for all active alerts, while the macro can filter to specific states. The UI should distinguish “no alerts exist” from “active alerts exist but none match this filter” and offer a clear-filter action.

Status Badge Macro

Module key: gs-status-badge

Use the inline status badge macro near a heading, decision, or checklist item when readers need a compact health signal.

Labels:

• Grafana: Degraded, Grafana: Firing, Grafana: Healthy, or Grafana: Unknown summarizes current cached alert posture.
• 0 firing, 0 pending, and 6 other active break down the matched alert states.

Configuration fields:

• Severity: optional severity filter.
• Label contains: optional label text filter.
• Save configuration: stores badge filters.
• Close: exits without changing the macro.

Annotation Timeline Macro

Module key: gs-annotations

Use the annotation timeline macro when readers need recent Grafana annotations or change events beside an incident or service runbook.

Labels and controls:

• GRAFANA ANNOTATIONS marks the macro as annotation-backed.
• The event count shows how many annotations matched.
• Range shows the configured time window.
• Snapshot shows when GrafanaSight fetched the annotation data.
• The table shows time, event text, tags, and scope.
• Scope identifies the dashboard UID and panel ID when available.
• Refresh annotations refreshes the annotation summary.

Configuration fields:

• Source URL: optional dashboard or panel URL used to scope annotations.
• Dashboard scope: dashboard UID when selected from the catalog.
• Time range: relative or absolute annotation window.
• Tags: optional tag filters.
• Max events: maximum events shown in the table.
• Save configuration: stores annotation scope and filters.
• Close: exits without changing the macro.

Auto-Convert Links

GrafanaSight can auto-convert supported links into macros when a Confluence author pastes one link and presses Enter.

Supported link patterns:

• Panel macros: https://*.grafana.net/d-solo/*/*
• Panel macros: https://*.grafana.net/d/*/*?*viewPanel=*
• Dashboard macros: https://*.grafana.net/d/*/*
• Alert summary macro: https://flowdence.io/grafanasight/alert-summary*
• Status badge macro: https://flowdence.io/grafanasight/status*
• Annotation timeline macro: https://flowdence.io/grafanasight/annotations*

Paste one link at a time. Bulk-pasted Grafana links can remain generic Confluence smart links instead of converting into GrafanaSight macros.