Akamai Edge DNS Datasource

Use the Akamai Edge DNS datasource plugin to observe Edge DNS metrics.

Install Grafana 7.0 or newer

Install Grafana details the process of installing Grafana on several operating systems.

(Be sure to get version 7.0 or newer. Your package manager may install an older version. It's best to go to Install Grafana and follow the directions there.)

Obtain Akamai API credentials

"Akamai Edge DNS Datasource" gets data from the Edge DNS Traffic By Time API.

You need to create an "API Client" with authorization to use the Edge DNS Traffic By Time API.

See the "Get Started" section of Reporting API v1 which says, "To enable this API, choose the API service named reporting-api, and set the access level to READ-WRITE".

Follow directions at Authenticate With EdgeGrid to generate the required client credentials.

A customized version of those directions follows:

Go to Control Center
Navigate to the "Identity & Access" page.
Press "New API Client for Me"

Select the "Advanced" option.
Choose "Select APIs".
Select "Reporting API" and "READ-WRITE" access.

Press "Create API client"
Copy the credentials (client_secret, host, access_token, and client token).

The credentials will later be entered into "Akamai Edge DNS Datasource" configuration.

Note that Step 2 in Authenticate With EdgeGrid "Decide which tool you’ll use to make requests" is not necessary. "Akamai Edge DNS Datasource" makes the requests.

Installing "Akamai Edge DNS Datasource" on a local Grafana

On the edgedns-grafana-datasource-plugin GitHub repository, under "Releases", select "Grafana datasource for Akamai Edge DNS metrics v1.0.1".
Copy "akamai-edgedns-datasource-1.0.1.zip" to your computer. Unzip the archive.

Linux OSs (Debian, Ubuntu, CentOS, Fedora, OpenSuse, Red Hat)

Configuration file: /etc/grafana/grafana.ini

Plugin directory: /var/lib/grafana/plugins
Log directory: /var/log/grafana/

You may have to use 'sudo' to edit the configuration file or to view the log file.
You may have to change permissons on the 'plugin' directory, for example: sudo chmod 777 /var/lib/grafana/plugins
Under the plugin directory (/var/lib/grafana/plugins), create a directory called 'edgedns-grafana-datasource'.

From the unzipped archive, copy:

LICENSE
README.md
img (directory and its contents)
module.js
module.js.LICENSE.txt
module.js.map
plugin.json

to /var/lib/grafana/plugins/edgedns-grafana-datasource

From the unzipped archive, copy one of (as appropriate for your hardware):

gpx_akamai-edgedns-datasource-plugin_linux_amd64
gpx_akamai-edgedns-datasource-plugin_linux_arm
gpx_akamai-edgedns-datasource-plugin_linux_arm64

to /var/lib/grafana/plugins/edgedns-grafana-datasource

Macintosh

Configuration file: /usr/local/etc/grafana/grafana.ini

Plugin directory: /usr/local/var/lib/grafana/plugins
Log directory: /usr/local/var/log/grafana/

Under the plugin directory (/usr/local/var/lib/grafana/plugins), create a directory called 'edgedns-grafana-datasource'.

From the unzipped archive, copy:

LICENSE
README.md
img (directory and its contents)
module.js
module.js.LICENSE.txt
module.js.map
plugin.json

to /usr/local/var/lib/grafana/plugins/edgedns-grafana-datasource

From the unzipped archive, copy:

gpx_akamai-edgedns-datasource-plugin_darwin_amd64

to /usr/local/var/lib/grafana/plugins/edgedns-grafana-datasource

Windows

Grafana can be installed into any directory (install_dir). Configuration file: install_dir\conf

Plugin directory: install_dir\data\plugins
Log directory: install_dir\data\log

Under the plugin directory (install_dir\data\plugins), create a directory called 'edgedns-grafana-datasource'.

From the unzipped archive, copy:

LICENSE
README.md
img (directory and its contents)
module.js
module.js.LICENSE.txt
module.js.map
plugin.json

to install_dir\data\plugins\edgedns-grafana-datasource

From the unzipped archive, copy:

gpx_akamai-edgedns-datasource-plugin_windows_amd64.exe

to install_dir\data\plugins\edgedns-grafana-datasource

Grafana configuration

Configuration describes configuration for each operating system. Carefully read the directions.

Using a text editor, open the configuration file (as described in Configuration).
Under the [paths] section header, uncomment "plugins" by removing the semicolon. For example:

[paths]
# Directory where grafana will automatically scan and look for plugins
plugins = /var/lib/grafana/plugins

To the right of "plugins =", insert the complete path to the plugin directory.
NOTE: The plugin directory differs by operating system!
Under the [plugins] section header, uncomment "allow_loading_unsigned_plugins".
To the right of "allow_loading_unsigned_plugins =", add "akamai-edgedns-datasource" (without quotes). For example:

[plugins]
# Enter a comma-separated list of plugin identifiers to identify plugins that are allowed to be loaded even if they lack a valid signature.
allow_loading_unsigned_plugins = akamai-edgedns-datasource

Restart Grafana

Restart Grafana describes how to restart Grafana for each operating system.

Under the log directory for your operating system, in "grafana.log", you should see something similar to:

t=2021-03-24T10:31:09-0400 lvl=info msg="Registering plugin" logger=plugins id=akamai-edgedns-datasource

Troubleshooting contains troubleshooting tips.

Log in to Grafana

Getting started with Grafana describes how to log in to Grafana. The default username/password are: admin/admin.