Run Grafana

Grafana runs as a web-based dashboard, and the grafanadash module configures it to use port 10000 by default. To view Puppet Server metrics in Grafana, you must configure a metrics dashboard.

Grafana does not display Puppet metrics displayed by default. You must create a metrics dashboard or edit and import a JSON-based dashboard, such as our sample metrics dashboard JSON file.

You can also use the puppet_operational_dashboards module to visualize Puppet Server metrics.
  1. Open a web browser on a computer that can reach your grafanadash agent node and navigate to http://<AGENT_HOSTNAME>:10000.

    You'll see a test screen indicating whether Grafana can successfully connect to your Graphite server.

    If Grafana is configured to use a hostname that your current computer can't resolve, click View details and go to the Requests tab to determine the hostname Grafana is trying to use. Then add the IP address and hostname to the hosts file.

    • On *nix and macOS agents, the file is located at: /etc/hosts
    • On Windows agents, the file is located at: C:\Windows\system32\drivers\etc\hosts
  2. Download the sample metrics dashboard JSON file, save the file as sample_metrics_dashboard.json, and open it in a text editor on the same computer you're using to access Grafana.
  3. Throughout the file, replace primary.example.com with the hostname of your primary server.
    The hostname value must also be used as the metrics_server_id value when you Enable Puppet Server's Graphite support.
  4. Save the file.
  5. In the Grafana UI, click Search (Folder icon) > Import > Browse, then select your sample_metrics_dashboard.json file.
Results
This loads a dashboard with nine graphs that display various metrics exported from the Puppet Server to the Graphite server. However, these graphs remain empty until you Enable Puppet Server's Graphite support. For information about the aspects of the sample dashboard, refer to Sample Grafana dashboard graphs.