grafana-util docs

grafana-util-dashboard-screenshot.1

Browser-readable rendering of a generated roff manpage.

This page renders the generated roff manpage into readable HTML for browser use. For richer per-subcommand detail, prefer the command-reference pages.

NAME

grafana-util-dashboard-screenshot - Open one dashboard in a headless browser and capture image or PDF output.

SYNOPSIS

grafana-util dashboard screenshot [OPTIONS]

DESCRIPTION

Open one dashboard in a headless browser and capture image or PDF output.

Use this when you need a reproducible dashboard or panel screenshot, especially for docs, incident notes, or visual debugging.

COMMON OPTIONS

--dashboard-uid or --dashboard-url
choose the dashboard to capture.
--output
destination file for the capture.
--panel-id
capture only one panel through the solo route.
--vars-query and --var
pass variable state into the capture.
--full-page and --full-page-output
capture the full scrollable page or tiled output.
--header-title, --header-url, --header-captured-at, --header-text
add PNG or JPEG headers.
--theme
choose the browser theme.
--output-format
force PNG, JPEG, or PDF.
--width, --height, --device-scale-factor, --wait-ms, --browser-path
rendering controls.

EXAMPLES

Open one dashboard in a headless browser and capture image or PDF output.

grafana-util dashboard screenshot --dashboard-url 'https://grafana.example.com/d/cpu-main/cpu-overview?var-cluster=prod-a' --profile prod --output ./cpu-main.png --full-page --header-title --header-url --header-captured-at

SEE ALSO

grafana-util(1), grafana-util-dashboard(1)