Grafana PDF Exporter

Grafana PDF Exporter is a tool that enables you to export Grafana v12 dashboards as high-quality PDFs using Puppeteer. It runs a lightweight Node.js server that processes HTTP requests, launches a headless browser, and captures full dashboard views.

You can also inject a custom button into the Grafana interface to allow users to export directly from the dashboard UI.

Prerequisites

Docker
Docker Compose

Installation

Clone this repository and navigate to the project directory:

git clone https://github.com/arthur-mdn/ExportGrafanaDashboardToPDF.git
cd ExportGrafanaDashboardToPDF

Configuration

Environment Variables

Duplicate the example environment file and rename it.

cp .env.template .env
nano .env

Edit the values according to your configuration.

GRAFANA_USER=gfexp
GRAFANA_PASSWORD=gfexp
GRAFANA_SERVICE_ACCOUNT=false

GRAFANA_USER and GRAFANA_PASSWORD are the credentials the exporter will use to log into Grafana. For a service account set GRAFANA_SERVICE_ACCOUNT to true and provide token in GRAFANA_PASSWORD.

Usage

To start the server, run the following command:

docker compose up -d --build

By default, the service runs on port 3001.

Generating a PDF

To generate a PDF, send a POST request to /generate-pdf with the Grafana dashboard URL.

The server will respond with the URL of the generated PDF.

Using cURL

curl \
  -H "Content-Type: application/json" \
  -X POST \
  -d '{ "url": "http://your-grafana-server/d/your-dashboard-id"}' \
  http://localhost:3001/generate-pdf

Using the `generate-pdf.sh` shell script

docker exec -it grafana-export-to-pdf /usr/src/app/generate-pdf.sh GF_DASH_URL 'http://your-grafana-server/d/your-dashboard-id'

Using an HTML button injected into Grafana

Make sure the disable_sanitize_html setting is set to true in your Grafana configuration to allow HTML/JS injection.

To add a PDF export button:

Copy the content of grafana-button.html into a Grafana text panel.

Modify the server URL in the script if necessary.

window.gfexpPdfGenerationServerUrl = 'http://localhost:3001';

The button should now be displayed in the native Grafana export dropdown menu.

You can disable injection by commenting out the HTML marker.

<!-- <div id="GFEXP_marker"> -->
  <!-- This is a marker to enable HTML injection in this panel -->
<!-- </div> -->

Exporting with a Time Range

In the examples below, the time range is now-1y/y, which corresponds to last year.

See more details on supported time ranges in the Grafana documentation.

To generate a PDF with a time range, you can simply add the native Grafana time range parameters to the URL.

http://your-grafana-server/d/your-dashboard-id?from=now-1y%2Fy&to=now-1y%2Fy

Or provide them directly in the request body:

Using cURL

curl \
  -H "Content-Type: application/json" \
  -X POST \
  -d '{ "url": "http://your-grafana-server/d/your-dashboard-id", "from": "now-1y/y", "to": "now-1y/y"}' \
  http://localhost:3001/generate-pdf

Using the `generate-pdf.sh` shell script

docker exec -it grafana-export-to-pdf /usr/src/app/generate-pdf.sh GF_DASH_URL 'http://your-grafana-server/d/your-dashboard-id' GF_FROM 'now-1y/y' GF_TO 'now-1y/y'

Using the HTML button injected into Grafana

The injected HTML button already retrieves the values of the selected time range in Grafana. You do not need to specify them manually. It also retrieves the theme selected.

Exporting with Fixed Width and Height

To generate a PDF with a fixed width and height, you can adjust the PDF_WIDTH_PX and PDF_HEIGHT_PX variables in the .env file.

PDF_WIDTH_PX=1920
PDF_HEIGHT_PX=1080

To let the PDF match the full height of the dashboard without specifying a fixed height, you can set the PDF_HEIGHT_PX variable to auto in the .env file:
PDF_HEIGHT_PX=auto

But you can also specify the width and height manually by specifying the pdfWidthPx and pdfHeightPx parameters in the request.

Using the pdfWidthPx and pdfHeightPx parameters will override the values set in the .env file.

Using cURL

curl \
  -H "Content-Type: application/json" \
  -X POST \
  -d '{ "url": "http://your-grafana-server/d/your-dashboard-id", "pdfWidthPx": 1920, "pdfHeightPx": 1080}' \
  http://localhost:3001/generate-pdf

Using the `generate-pdf.sh` shell script

docker exec -it grafana-export-to-pdf /usr/src/app/generate-pdf.sh GF_DASH_URL 'http://your-grafana-server/d/your-dashboard-id' GF_PDF_WIDTH_PX 1920 GF_PDF_HEIGHT_PX 1080

Generating a PDF with only a specific panel

By default, the server exports the entire dashboard. If you want to export a single panel, you can add the viewPanel parameter to the URL.

http://your-grafana-server/d/your-dashboard-id?viewPanel=2

The script will try to extract the panel title and use it in the PDF filename.

Custom Configuration

Improved PDF Filename from HTML Content

To make filenames more user-friendly, you can extract title/date directly from HTML elements.

Example

For this URL: http://localhost/d/ID/stats?from=now-1y%2Fy&to=now-1y%2Fy

By default, the generated PDF will use the dashboard UID and raw time range values, like: stats_now-1y_y_to_now-1y_y.pdf
With the custom configuration enabled, and by extracting formatted content from Grafana panels, the filename can be more user-friendly, such as: Stats_Sunday_January_1_2025_-_Sunday_December_31_2025.pdf

Activation

To activate this feature, set the following variable to true in your .env file:

EXTRACT_DATE_AND_DASHBOARD_NAME_FROM_HTML_PANEL_ELEMENTS=true

And the following code is used to extract the dashboard title and date range from the HTML elements.

You can remove this section if you do not want to use this feature.

<!-- Dashboard title and date display -->
[...]
<style>
    [...]
</style>

<div id="gfexp_display_container">
    <p id="gfexp_display_actual_dashboard_title">${__dashboard}</p>
    <p id="gfexp_display_actual_date"></p>
</div>

<script>
    [...]
</script>
<!-- End of dashboard title and date display -->

Force Kiosk Mode

By default, FORCE_KIOSK_MODE is set to true. This means that if the url does not contain the kiosk parameter, the server will add it to the URL to ensure that the PDF is generated without any elements overlapping the dashboard content.

Deactivation

You can disable this behavior by setting the following variable to false in your .env file:

FORCE_KIOSK_MODE=false

Disabling this feature would have no effect if the kiosk parameter is already present in the URL given to the server.

Debug Mode

By default, DEBUG_MODE is set to false. When activated, the server will save the HTML content of the page to a file in the debug folder. There is also more verbose logging in the console, which can help you understand what is happening during the PDF generation process. This can be useful for debugging purposes.

Activation

You can enable this behavior by setting the following variable to true in your .env file:

DEBUG_MODE=true

Hide Dashboard Controls

By default, HIDE_DASHBOARD_CONTROLS is set to true. This means that the server will hide the dashboard controls (such as the time range selector, the share button, etc.) when generating the PDF. This can be useful to have a cleaner PDF output.

Expand Collapsed Panels

By default, EXPAND_COLLAPSED_PANELS is set to true. This means that the server will expand all collapsed panels when generating the PDF. This can be useful to ensure that all panels are visible in the PDF output.

Check for all queries to be completed

⚠️ Experimental feature!

Intended as a future replacement for NAVIGATION_TIMEOUT.

When activated, the server will wait for all queries to be completed before generating the PDF. This can be useful for dashboards with long queries.

Activation

You can enable this behavior by setting the following variable to true in your .env file.

CHECK_QUERIES_TO_COMPLETE=true

You can also set the maximum time to wait for each single query to be completed, the interval between each check for the queries completion, and the maximum time to wait for all the queries to be completed, before generating the PDF.

CHECK_QUERIES_TO_COMPLETE_MAX_QUERY_COMPLETION_TIME=30000
CHECK_QUERIES_TO_COMPLETE_QUERIES_INTERVAL=1000
CHECK_QUERIES_TO_COMPLETE_QUERIES_COMPLETION_TIMEOUT=60000

Expand Table Panels

🧪 Only available in Grafana v11.4+

By default, EXPAND_TABLE_PANELS is set to false due to performance concerns. When enabled, the server will try to auto-adjust the height of table panels to fit all the rows when generating the PDF. This can be useful to ensure that all data is visible in the PDF output.

You can enable this feature via your .env file:

EXPAND_COLLAPSED_TABLES=true

⚠️ Important Note: When large tables are expanded, the generated PDF height can grow dramatically (several thousand pixels), which may:

Slow down rendering or cause performance issues during export

Produce unexpectedly long PDFs

Recommendation: Only enable table expansion for dashboards where full row visibility is critical, or consider adjusting panel sizes manually in Grafana to fit content naturally.

Known Issues

With injected button in Grafana

The PDF generation is complete but the browser do not allow to open the popup window.
- You can manually allow the popup window by clicking on the popup blocked icon in the browser's address bar, and then click on "Always allow pop-ups from ...".

Author

Arthur Mondon

Name		Name	Last commit message	Last commit date
Latest commit History 164 Commits
.github		.github
debug		debug
illustrations		illustrations
output		output
.env.template		.env.template
.gitignore		.gitignore
Dockerfile		Dockerfile
README.md		README.md
docker-compose.yml		docker-compose.yml
generate-pdf.sh		generate-pdf.sh
grafana-button.html		grafana-button.html
grafana_pdf.js		grafana_pdf.js
package-lock.json		package-lock.json
package.json		package.json
server.js		server.js

arthur-mdn/ExportGrafanaDashboardToPDF

Folders and files

Latest commit

History

Repository files navigation

Grafana PDF Exporter

Prerequisites

Installation

Configuration

Environment Variables

Usage

Generating a PDF

Using cURL

Using the generate-pdf.sh shell script

Using an HTML button injected into Grafana

Exporting with a Time Range

Using cURL

Using the generate-pdf.sh shell script

Using the HTML button injected into Grafana

Exporting with Fixed Width and Height

Using cURL

Using the generate-pdf.sh shell script

Generating a PDF with only a specific panel

Custom Configuration

Improved PDF Filename from HTML Content

Example

Activation

Force Kiosk Mode

Deactivation

Debug Mode

Activation

Hide Dashboard Controls

Expand Collapsed Panels

Check for all queries to be completed

Activation

Expand Table Panels

Known Issues

With injected button in Grafana

Author

Contributing

About

Topics

Resources

Uh oh!

Stars

Watchers

Forks

Uh oh!

Contributors 5

Uh oh!

Languages

Using the `generate-pdf.sh` shell script

Using the `generate-pdf.sh` shell script

Using the `generate-pdf.sh` shell script