Skip to content

Commit

Permalink
editorial review
Browse files Browse the repository at this point in the history
  • Loading branch information
Magda Sulik committed Oct 21, 2024
1 parent eb52fc7 commit 3fc949e
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 12 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 7 additions & 12 deletions docs/marketplace-docs/guides/prometheus-grafana/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,24 +47,19 @@ Grafana is an analytics and monitoring solution with a focus on accessibility fo

#### Akamai Datasource Plugin (Optional)

If your Akamai account contract has **Reporting** enabled you can take advantage of the **[Akamai Reporting API V2](https://techdocs.akamai.com/reporting/v2/reference/api)**. This allows you to expose data to monitor traffic, analyze patterns and long-term trends directly into Grafana.
If your Akamai account contract has **Reporting** enabled, you can take advantage of the **[Akamai Reporting API V2](https://techdocs.akamai.com/reporting/v2/reference/api)**. This allows you to expose data to monitor traffic, analyze patterns and long-term trends directly into Grafana.

Before you can fill out the necessary fields below you will need to create API client credentials. Please refer to Akamai's Techdocs to create the necessary credentials needed:
**Before you begin**: To get the values for required fields, you need to have API client credentials. If you don't know how to create an API client for your Akamai account, check [Create EdgeGrid authentication credentials](https://techdocs.akamai.com/developer/docs/set-up-authentication-credentials).

- [Get Started](https://techdocs.akamai.com/reporting/v2/reference/get-started)
- [Create Authentication Credentials](https://techdocs.akamai.com/developer/docs/set-up-authentication-credentials)

{{< note type="warning" title="Installing The Plugin">}}
In order to configure the Akamai Insights Datasource plugin you **must** fill out all of the fields. Leaving any of the fields blank will result in the plugin not being installed.
{{< /note >}}

To add the plugin, enter your API client data to the corresponding fields. Leaving any of the fields blank will result in the plugin not being installed.
- **Akamai client_secret:** Enter your `client_secret` value.
- **Akamai host:** Enter your Akamai `host` value. This typically ends in **luna.akamaiapis.net**.
- **Akamai access_token:** Enter your `access_token` value.
- **Akamai client_token:** Enter your `client_token` value.

{{< note type="warning" >}}
Akamai's Grafana data source plugin, as being offered here, is licensed to you under Apache License Version 2.0. Copyright Akamai 2024. Akamai's Grafana data source plugin uses Grafana's Plugin tools (https://github.com/grafana/plugin-tools) software, which is licensed under Apache License Version 2.0 whose terms are available at http://www.apache.org/licenses/LICENSE-2.0. Please note that this is an unsigned plugin and is provided as-is.
Akamai's Grafana data source plugin, as being offered here, is licensed to you under Apache License Version 2.0. Copyright Akamai 2024. Akamai's Grafana data source plugin uses [Grafana's Plugin tools](https://github.com/grafana/plugin-tools) software, which is licensed under Apache License Version 2.0 whose terms are available at http://www.apache.org/licenses/LICENSE-2.0. Remember that this is an unsigned plugin and is provided as-is.
{{< /note >}}

## Getting Started after Deployment
Expand Down Expand Up @@ -135,13 +130,13 @@ Once the app has been *fully* deployed, you need to obtain the credentials from
Now that the Prometheus Data Source is set, you can browse the [available Grafana dashboards](https://grafana.com/grafana/dashboards/) to see which dashboard fits your needs. Review the official [Prometheus](https://prometheus.io/docs/introduction/overview/) and [Grafana](https://grafana.com/docs/grafana/latest/) documentation to learn how to further use your instance.
### Akamai Insights Datasource
### Akamai Insights Datasource
If you opted to add the Akamai Insights Datasource plugin you will find the datasource present in the Data Sources tab.
If you added the Akamai Insights Datasource plugin, the data source is in the **Data sources** tab.
![All Data Sources](grafana_datasource4.png)
Once you click **akamai-insights-datasource** You can test access by clicking the **Save & test** button. If everything is working correctly you will see the following message.
To check if the plugin works, open **akamai-insights-datasource** and click **Save & test**. You should get the *Data source is working properly* message.
![Working Akamai DS](grafana_akamai_ds.png)
{{% content "marketplace-update-note-shortguide" %}}

0 comments on commit 3fc949e

Please sign in to comment.