divinity666/ruby-grafana-reporter

Help with Getting Started

Closed this issue · 4 comments

Describe the issue
I am trying to create a simple report of a Grafana dashboard. I have installed the tool to my local and ran the wizard. I see the demo_report.adoc file is there, but am not sure I understand where to go from here.

When creating our own template files, is this supposed to point to the specific dashboard that we want to create the report on? Is there any simple guide that shows how to go about doing this using one dashboard?

Configuration file

  • created with configuration wizard version
  • relevant part of configuration file (remember to X-out personal information as e.g. api_key):
# This configuration has been built with the configuration wizard.

grafana:
  default:
    host: https://URL:443
    api_key: XXXXX

Environment (please complete the following information):

  • OS: OSX
  • Grafana version [e.g. 6.3.4]: 7.4.1
  • Environment: Grafana is running in Kubernetes
  • Ruby Version, if source or gem environment: ruby 3.1.2p20
  • Reporter version: 0.6.2

I am afraid there is no tutorial, like you are asking for.

Generally, the reporter gives you the freedom to specify the dashboard id, panel id and query id for each and every request in the brackets (refer to the help section of the individual commands). This is also the way it is done in the wizard demo report.

Hope this helps. If you have more specific questions, you may ask them in this thread.

i have truied to create the docker-compose file and passed some env variables

  • GRAFANA_URL=http://localhost:3000
  • GRAFANA_USER=admin
  • GRAFANA_PASSWORD=admin
  • GRAFANA_DASHBOARD_ID=lqDwALhVz
  • REPORTER_PORT=8815
    but it is still asking for the config file
    and -w doesnt asks for the dashboard uid and datasource and things pls help

The reporter does currently not use variables from a docker-compose file (though this might be better to do so in future).

Instead, you have to create your config file as usual and place it in the folder mounted as /documents.

Solution provided, missing feedback, if this worked. Closing