Bitnami Grafana Virtual Machine

IMPORTANT: The Grafana OVA has been released for VMware vSphere only. The following information does not apply for VirtualBox or similar VM executors.

Description

Grafana is an open source analytics and monitoring dashboard for 40+ data sources, including Graphite, Elasticsearch, Prometheus, MySQL, PostgreSQL and many more.

First steps with the Bitnami Grafana Stack

Welcome to your new Bitnami application! This guide includes some basic information you will need to get started with your application.

What credentials do I need?

You need two sets of credentials:

  • The application credentials, consisting of a username and password. These credentials allow you to log in to your new Bitnami application.
  • The server credentials, consisting of an SSH username and SSH key file. These credentials allow you to log in to your virtual machine using an SSH client and execute commands on the server using the command line. Contact your datacenter administrator for more information.

What is the administrator username set for me to log in to the application for the first time?

Username: admin

What is the administrator password?

Password: The administrator password to log in to your application is randomly generated during the first boot. Check the FAQ to learn how to retrieve it.

What is my server IP address?

The IP address is displayed on screen at the end of the boot process, but you can check it at any time by running the following command:

$ sudo ifconfig

Check server IP address

How to start or stop the services?

  • To start the Grafana server, access your machine and execute the following:

    $ sudo /opt/bitnami/ctlscript.sh start grafana
    
  • To stop the Grafana server, execute the following:

    $ sudo /opt/bitnami/ctlscript.sh stop grafana
    

What is the default configuration?

Configuration files

The Grafana configuration file is the /opt/bitnami/grafana/conf/grafana.ini file.

Grafana can also be customized with "extra" configuration files without editing the main configuration file. For instance, configure data sources in Grafana by adding one or more YAML-formatted files in the /opt/bitnami/grafana/conf/provisioning/datasources directory. Learn more about provisioning data sources.

Log files

The Grafana log file is /opt/bitnami/grafana/logs/grafana.log.

What are the default ports?

A port is an endpoint of communication in an operating system that identifies a specific process or a type of service. Bitnami stacks include several services or servers that require a port.

IMPORTANT: Making this application's network ports public is a significant security risk. You are strongly advised to only allow access to those ports from trusted networks. If, for development purposes, you need to access from outside of a trusted network, please do not allow access to those ports via a public IP address. Instead, use a secure channel such as a VPN or an SSH tunnel. Follow these instructions to remotely connect safely and reliably.

Port 22 is the default port for SSH connections.

The Grafana access port is 3000. This port is closed by default. You must open it to enable remote access.

How can I get started with Grafana?

To get started, we suggest the following steps:

Step 1: Add one or more data sources

Log in to Grafana and create a new data source using the "Configuration -> Data Sources" menu item. Available options include Elasticsearch, MySQL, PostgreSQL, Prometheus and Graphite.

Data source

For more information, refer to the official documentation.

Step 2: Create a dashboard and panels

Add a new dashboard using the "Create -> Dashboard" menu item. Then, add panels to it depending on your query needs.

Dashboard

You can also configure your dashboards in Grafana by adding one or more YAML-formatted configuration files in the /opt/bitnami/grafana/conf/provisioning/dashboards directory. For more information, refer to these instructions.

Step 3: Run queries

Once Grafana has started collecting metrics, run queries using the query editor. Learn more about the query editor.

How to connect to Grafana from a different machine?

The Grafana OVA can only be deployed within a VMware vSphere environment. For that reason, it does not include any specialized firewall software pre-installed or firewall rules set. It is assumed that this OVA will run on a private LAN.

Please contact your system administrator to learn how to remotely access this machine.

How can I run a command in the Bitnami Grafana Stack?

Log in to the server console as the bitnami user and run the command as usual. The required environment is automatically loaded for the bitnami user.

How to create a full backup of Grafana?

Backup

The Bitnami Grafana Stack is self-contained and the simplest option for performing a backup is to copy or compress the Bitnami stack installation directory. To do so in a safe manner, you will need to stop all servers, so this method may not be appropriate if you have people accessing the application continuously.

Follow these steps:

  • Change to the directory in which you wish to save your backup:

      $ cd /your/directory
    
  • Stop all servers:

      $ sudo /opt/bitnami/ctlscript.sh stop
    
  • Create a compressed file with the stack contents:

      $ sudo tar -pczvf application-backup.tar.gz /opt/bitnami
    
  • Restart all servers:

      $ sudo /opt/bitnami/ctlscript.sh start
    

You should now download or transfer the application-backup.tar.gz file to a safe location.

Restore

Follow these steps:

  • Change to the directory containing your backup:

      $ cd /your/directory
    
  • Stop all servers:

      $ sudo /opt/bitnami/ctlscript.sh stop
    
  • Move the current stack to a different location:

      $ sudo mv /opt/bitnami /tmp/bitnami-backup
    
  • Uncompress the backup file to the original directoryv

      $ sudo tar -pxzvf application-backup.tar.gz -C /
    
  • Start all servers:

      $ sudo /opt/bitnami/ctlscript.sh start
    

If you want to create only a database backup, refer to these instructions for MySQL and PostgreSQL.

How to enable a plugin?

To enable a Grafana plugin, follow these steps:

  • Log in to the server console.
  • Run the following command to list all the plugins that can be installed:

      $ grafana-cli plugins list-remote
    
  • Run this command to install a specific plugin, replacing the PLUGIN-NAME placeholder as needed:

      $ sudo su grafana -c '/opt/bitnami/grafana/bin/grafana-cli --pluginsDir /opt/bitnami/grafana/data/plugins/ plugins install PLUGIN_NAME'
    
  • Restart the service:

      $ sudo /opt/bitnami/ctlscript.sh restart grafana
    

At any time, run the following command to list all the plugins that are already installed:

  $ sudo su grafana -c 'grafana-cli --pluginsDir /opt/bitnami/grafana/data/plugins/ plugins ls'

Find out more about Grafana's plugins.

virtualMachine

Bitnami Documentation