Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arthur-mdn/exportgrafanadashboardtopdf
Free PDF Export Tool in Grafana Community version - Using Puppeteer
https://github.com/arthur-mdn/exportgrafanadashboardtopdf
export-pdf grafana grafana-dashboard grafana-dashboard-exporter pdf-generation puppeteer
Last synced: 26 days ago
JSON representation
Free PDF Export Tool in Grafana Community version - Using Puppeteer
- Host: GitHub
- URL: https://github.com/arthur-mdn/exportgrafanadashboardtopdf
- Owner: arthur-mdn
- Created: 2024-06-11T15:35:10.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-09-03T09:50:47.000Z (2 months ago)
- Last Synced: 2024-10-10T20:02:02.011Z (26 days ago)
- Topics: export-pdf, grafana, grafana-dashboard, grafana-dashboard-exporter, pdf-generation, puppeteer
- Language: HTML
- Homepage:
- Size: 2.97 MB
- Stars: 10
- Watchers: 1
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Grafana PDF Exporter
This project allows exporting Grafana dashboards to PDF using Puppeteer. The project uses a Node.js server to handle HTTP requests and launch Puppeteer to generate the PDFs.
It is possible to inject a button into Grafana to generate a PDF directly from the interface.
## Prerequisites
- Docker
- Docker Compose
## Installation
Clone this repository and navigate to the project directory:
```shell
git clone https://github.com/arthur-mdn/grafana-export-to-pdf/
cd grafana-export-to-pdf
```
## Configuration
### Environment Variables
Duplicate the `.env.example` file and rename it to `.env`.
```shell
cp .env.template .env
nano .env
```
Modify the values according to your configuration.
```dotenv
GRAFANA_USER=pdf_export
GRAFANA_PASSWORD=pdf_export
```
`GRAFANA_USER` and `GRAFANA_PASSWORD` are the credentials used to authenticate to the Grafana instance.
## Usage
To start the project, run the following command:
```shell
docker compose up -d --build
```
The server will be accessible on port 3001.
### Generating a PDF
To generate a PDF, send a POST request to the /generate-pdf API with the Grafana dashboard URL as a parameter.
The server will respond with the URL of the generated PDF.
#### Using cURL
```bash
curl \
-H "Content-Type: application/json" \
-X POST \
-d '{ "url": "http://your-grafana-server/d/your-dashboard-id?orgId=1&kiosk"}' \
http://localhost:3001/generate-pdf
```
#### Using the `generate-pdf.sh` shell script
```bash
docker compose exec grafana-export-to-pdf /usr/src/app/generate-pdf.sh GF_DASH_URL 'http://your-grafana-server/d/your-dashboard-id?orgId=1&kiosk'
```
#### Using an HTML button injected into Grafana
> You must ensure that the ``disable_sanitize_html`` parameter is set to ``true`` in the Grafana configuration file to be able to inject HTML and Javascript code.
>
> 
To inject a button directly into Grafana, add the content of the `grafana-button.html` file to the "Text" field of a Grafana text panel.
Make sure to modify the server URL if necessary. You can easily deactivate the button injection by setting the `pdfGeneration` variable to `false`.
```javascript
const pdfGeneration = true;
const pdfGenerationServerUrl = 'http://localhost:3001/';
```
The button should now be displayed in the native Grafana share menu.
### Generating a PDF 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](https://grafana.com/docs/grafana/latest/dashboards/use-dashboards/#time-units-and-relative-ranges).
To generate a PDF with a time range, you can simply add the native Grafana time range parameters to the URL.
```shell
http://your-grafana-server/d/your-dashboard-id?orgId=1&kiosk&from=now-1y%2Fy&to=now-1y%2Fy
```
But you can also specify the time range manually by specifying the `from` and `to` parameters in the request.
#### Using cURL
```bash
curl \
-H "Content-Type: application/json" \
-X POST \
-d '{ "url": "http://your-grafana-server/d/your-dashboard-id?orgId=1&kiosk", "from": "now-1y/y", "to": "now-1y/y"}' \
http://localhost:3001/generate-pdf
```
#### Using the `generate-pdf.sh` shell script
```bash
docker compose exec server /usr/src/app/generate-pdf.sh GF_DASH_URL 'http://your-grafana-server/d/your-dashboard-id?orgId=1&kiosk' 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 from the share panel.
### 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.
```shell
http://your-grafana-server/d/your-dashboard-id?orgId=1&kiosk&viewPanel=2
```
By using the HTML button injected into Grafana, you can simply click the share button of the panel you want to export, and then you will find the Export to PDF button.
> The script will try to extract the panel title and use it in the PDF filename.
## Custom Configuration
### Fetch the dashboard name and the time range from HTML elements to be used in the PDF filename
To avoid fetching the dashboard name and the time range from the URL (that are sometimes not user-friendly), you can extract the values directly from HTML elements in the Grafana dashboard with a better display format.
#### Example
For this URL: `http://localhost/d/ID/stats?orgId=1&from=now-1y%2Fy&to=now-1y%2Fy`
- The initial PDF filename will be: `stats_now-1y_y_to_now-1y_y.pdf`
- With the custom configuration, the PDF filename could be: `Stats_Sunday_January_1_2023_-_Sunday_December_31_2023.pdf`
#### Activation
To activate this feature, set the following variable to `true` in your `.env` file:
```dotenv
EXTRACT_DATE_AND_DASHBOARD_NAME_FROM_HTML_PANEL_ELEMENTS=true
```
And then add the following code to the Grafana panel where you want to display the dashboard name and the time range. You can customize the display format by modifying the `formatTimestamp` function in the script below:
```html
${__dashboard}
(function() {
function formatTimestamp(timestamp) {
const date = new Date(timestamp);
const options = { weekday: 'long', year: 'numeric', month: 'long', day: 'numeric' };
return date.toLocaleDateString('en-US', options);
}
let fromTimestampGrafana = ${__from};
let toTimestampGrafana = ${__to};
document.getElementById("display_actual_date").innerHTML = formatTimestamp(fromTimestampGrafana) + " - " + formatTimestamp(toTimestampGrafana);
})();
```
### 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:
```dotenv
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. This can be useful for debugging purposes.
#### Activation
You can enable this behavior by setting the following variable to `true` in your `.env` file:
```dotenv
DEBUG_MODE=true
```
## Author
- [Arthur Mondon](https://mondon.pro)
### Contributing
- [svet-b](https://gist.github.com/svet-b/1ad0656cd3ce0e1a633e16eb20f66425)