Prometheus & Grafana

Deploy Prometheus and Grafana, two open source tools used together to collect and view data. Optionally, you can also install Loki, a log aggregation system designed to work seamlessly with Grafana.

1. Deploy Prometheus & Grafana

 Estimated deployment time: 2–5 minutes

Follow the deployment instructions from the Get started section to configure the app, deploy it, and verify software installation.

For information on the app-specific configurations, see the Configuration options section.

Base distribution and plan

  • Supported distribution: Ubuntu 24.04 LTS
  • Recommended plans: All plan types and sizes can be used.

Configuration options

Configure the required options to deploy your instance. For additional customization, add advanced options.

The table maps the Cloud Manager UI fields to their corresponding API/CLI keys (stackscript_data) required for automated deployments.

StackScript ID: 985364

UI fieldAPI/CLI keyDescription
Required options
Limited sudo useruser_nameYour preferred username for the limited sudo user, entered without any capital letters, spaces, or special characters.
When adding a limited sudo user, the user is created with a strong generated password for your new Linode instance, and the account is assigned to the sudo group, which provides elevated permissions when running commands with the sudo prefix.
Note: For easier and more secure access with the sudo user, add an account SSH key for the Cloud Manager user during deployment and select that user as an authorized_user. Their SSH pubkey will be assigned to both the root and limited sudo users.
Email address (for the Let's Encrypt SSL certificate)soa_email_addressThe email used to receive notifications about the renewal of the Let's Encrypt SSL certificate.
Advanced options
Disable root access over SSHdisable_rootApplies to a limited sudo user. To block the root user from logging in over SSH, select Yes. Defaults to No.
Note: When you disable the root user from logging in over SSH and don't provide a valid Account SSH Key assigned to the authorized_user, you can still switch to the root user. To do that, log in as root via the Lish console and run cat /home/$USERNAME/.credentials to view the generated password for the limited sudo user.
Linode API tokentoken_passwordApplies to a custom domain. The Linode API token if you want to use Linode's DNS Manager to manage DNS records for your custom domain. Follow Manage personal access tokens to get your token on your account with Read/Write access to Domains.
  • If you provide the token along with the subdomain and domain, the installation attempts to create DNS records via the Linode API.
  • If you don't provide the token, you need to manually configure your DNS records through your DNS provider and point them to the IP address of the new instance.
SubdomainsubdomainApplies to a custom domain. The subdomain you want to use, like blog for blog.example.com. Use it only if you specify a Domain.
DomaindomainApplies to a custom domain. The domain name you want to use, like example.com. Use it only if you specify a Linode API token.
Akamai client_secretakamai_client_secretApplies to the Akamai Insights Data Source plug-in. Your Akamai's client_secret.
Akamai hostakamai_hostApplies to the Akamai Insights Data Source plug-in. Your Akamai's host. This typically ends in luna.akamaiapis.net.
Akamai access_tokenakamai_access_tokenApplies to the Akamai Insights Data Source plug-in. Your Akamai's access_token.
Akamai client_tokenakamai_client_tokenApplies to the Akamai Insights Data Source plug-in. Your Akamai's client_token.
Install Loki as data sourceinstall_lokiWhen set to Yes, it installs Loki, a log aggregation system that integrates with Grafana. Defaults to No if not specified.
Optional data exporter Add-onsadd_onsAn option to include add-ons for your deployment. Possible values are:
  • none (default)
  • node_exporter
  • mysqld_exporter
  • newrelic

Notes:

  • After the app deployment completes, the passwords for your limited sudo, Prometheus, Grafana, and Loki (if installed) users are generated and stored in the .credentials file in the home directory. Log in to your instance as root through the Lish console or SSH, then run cat /home/$USERNAME/.credentials to view its contents.
  • You can automatically configure a custom domain (optional) during deployment. To do that:
    1. First, configure your domain to use Linode’s name servers via your registrar. See Configure your domain's authoritative name servers for details.
    2. Once you complete that, specify the Linode API token, subdomain, and domain for the app in Cloud Manager or via API/CLI/Terraform.

Use API, CLI, or Terraform

In addition to deploying the app to a new Linode instance via Cloud Manager, you can also use the Linode API, CLI, or Terraform. When running the operation, you need to provide the StackScript ID, supported Linux distribution, and app-specific fields along with the standard Linode deployment configurations.

Note: Generate a personal access token to authenticate your API, CLI, or Terraform requests.

curl --location 'https://api.linode.com/v4/linode/instances' \
    --header 'Content-Type: application/json' \
    --header 'Accept: application/json' \
    --header 'Authorization: Bearer abc123def456hij789klm' \
    --data-raw '{
        "region": "us-east",
        "type": "g6-standard-2",
        "image": "linode/ubuntu24.04",
        "label": "my-prometheus-grafana-one-click-app",
        "root_pass": "@C0mpl3x#P@ssw0rd",
        "stackscript_id": 985364,
        "stackscript_data": {
            "user_name": "jsmith",
            "soa_email_address": "jsmith@example.com"
        }
    }'
linode-cli linodes create \
    --region us-east \
    --type g6-standard-2 \
    --label my-prometheus-grafana-one-click-app \
    --image linode/ubuntu24.04 \
    --root_pass @C0mpl3x#P@ssw0rd \
    --stackscript_id 985364 \
    --stackscript_data '{"user_name":"jsmith", "soa_email_address":"jsmith@example.com"}'
resource "linode_instance" "my-linode" {
    region         = "us-east"
    type           = "g6-standard-2"
    label          = "my-prometheus-grafana-one-click-app"
    image          = "linode/ubuntu24.04"
    root_pass      = "@C0mpl3x#P@ssw0rd"
    stackscript_id = 985364
    stackscript_data = {
        "user_name"         = "jsmith"
        "soa_email_address" ="jsmith@example.com"
    }
}

2. Access Prometheus & Grafana

Get credentials

To access the front-end interfaces for Grafana and Prometheus, you need to get the credentials from the server.

  1. Once the app is fully deployed, log in to your Linode instance as a root user using either the Lish console or SSH.

  2. After logging in, you can find the URLs and credential files listed in the motd (message of the day).

    cat /etc/motd
    *********************************************************
    Akamai Connected Cloud Prometheus & Grafana Quick Deploy App
    Grafana URL: https://$EXAMPLE_DOMAIN.COM
    Prometheus URL: https://$EXAMPLE_DOMAIN.COM/prometheus
    Credentials File: /home/$SUDO_USER/.credentials
    Documentation: https://techdocs.akamai.com/quick-deploy-apps/docs/prometheus-grafana
    *********************************************************

    To delete the motd, run rm /etc/motd.

  3. Then run cat /home/$SUDO_USER/.credentials to see the file contents. It contains the credentials for the created limited sudo, Prometheus, Grafana, and Loki (if installed) users.

Add Prometheus as a data source to Grafana

  1. Log in to the Grafana front end with your credentials.

  2. On the main menu, hover over the gear icon to open the Configuration menu. Then select Data sources.

  3. Within the Data sources tab, click the Add data source button.

  4. Select Prometheus from the Time series database section of the Add data source page.

    A data source labeled Prometheus is automatically created, and its configuration settings are now visible.

  5. Within the URL field, enter http://localhost:9090/prometheus. You can adjust the rest of the settings as needed.

    Now that the Prometheus data source is set, you can browse the available Grafana dashboards to see which dashboard fits your needs.

Configure Loki

If you installed Loki during deployment, it's automatically configured as a data source in Grafana.

To send logs from your applications and systems to Loki, install and configure a log collection agent, like Grafana Alloy, on the client systems.

Add Akamai Insights Data Source plug-in

If your Akamai account contract has Reporting enabled, you can take advantage of the Akamai Reporting API V2. This allows you to expose data to monitor traffic and analyze patterns and long-term trends directly in Grafana.

Before deploying the app, you need to have API client credentials. To learn how to create an API client for your Akamai account, see EdgeGrid authentication credentials.

To start using the plug-in:

  1. During app deployment, enter your API client data into the corresponding fields. All fields are required to install the plug-in.

    • Akamai client_secret: Enter your client_secret.
    • Akamai host: Enter your Akamai host. This typically ends in luna.akamaiapis.net.
    • Akamai access_token: Enter your access_token.
    • Akamai client_token: Enter your client_token.
  2. Once the app is deployed, log in to the Grafana front end.

  3. On the main menu, hover over the gear icon to open the Configuration menu. Then select Data sources.

  4. You should be able to find the akamai-insights-datasource option. Open it and click Save & test to check if the plug-in is working.

    If successful, you should see the Data source is working properly message.

Additional resources

For more information about the installed packages, see their official documentation.

📘

Note that we can't vouch for the accuracy or timeliness of externally hosted resources.


Did this page help you?