Grafana

LAST UPDATED: JAN 17, 2025

Overview

Grafana is an open-source platform for monitoring, observability, and data visualization. It enables organizations to create dynamic, interactive dashboards that display metrics and logs from various sources. This integration enables clients to send Loki log messages and Metrics to Grafana.

D3 SOAR is providing REST operations to function with Grafana.

Grafana is available for use in:

Known Limitations

Grafana Cloud follows a pay-as-you-go policy, allowing users to be billed based on actual usage across logs and metrics.

Refer to Logs invoice | Grafana and Metrics invoice | Grafana for detailed information.

Connection

To connect to Grafana from D3 SOAR, follow this part to collect the required information below:

Configuring Grafana to Work with D3 SOAR

Retrieving the Loki Log URL and Username

1. Log in to Grafana Cloud with an admin account.

   

2. Click on the My Account link.

   

3. Click on the Launch button under the desired Grafana Cloud stack.

   

4. Locate the Loki stack, then click on the Details button.

   

5. Copy and save the URL and user ID in a secure place. Refer to step 3i sub-steps 1 and 2 in Configuring D3 SOAR to Work with Grafana.

   

Creating the API Token

1. Click on the Generate now link.

   

2. Click on the create a new token link.

   

3. Click on the Create access policy button.

   

4. Configure the access policy settings.

   

   1. Enter the display name.

   2. Select the realm in which this access policy will apply.

   3. Select the Read and Write checkboxes for both the metrics and logs resources.

   4. Click on the Create button.

5. Click on the Add token button.

   

6. Add a token to the policy.

   

   1. Enter a name.

   2. (Optional) Set an expiration date.

   3. Click on the Create button.

7. Click on the Copy to clipboard button to copy the API token and save it in a secure place. Refer to step 3i sub-step 5 in Configuring D3 SOAR to Work with Grafana.

   

   This token will no longer be visible after this step.

Retrieving the Metrics URL and Metrics Username

1. Click on the My Account link, then click on the Launch button under the desired Grafana Cloud stack.

   

2. Locate the InfluxDB connectivity stack, then click on the Configure button.

   

3. Copy the URL and username and save them in a secure place. Refer to step 3i sub-steps 3 and 4 in Configuring D3 SOAR to Work with Grafana.

   

Configuring D3 SOAR to Work with Grafana

1. Log in to D3 SOAR.

2. Find the Grafana integration.

   

   1. Navigate to Configuration on the top header menu.

   2. Click on the Integration icon on the left sidebar.

   3. Type Grafana in the search box to find the integration, then click it to select it.

   4. Click on the + Connection button on the right side of the Connections section. A new connection window will appear.

3. Configure the following fields to create a connection to Grafana.

   

   1. Connection Name: The desired name for the connection.

   2. Site: Specifies the site to use the integration connection. Use the drop-down menu to select the site. The Share to Internal Sites option enables all sites defined as internal sites to use the connection. Selecting a specific site will only enable that site to use the connection.

   3. Recipient site for events from connections Shared to Internal Sites: This field is displayed when Share to Internal Sites is selected for the Site field, allowing selection of the internal site for deploying the integration connection.

   4. Agent Name (Optional): Specifies the proxy agent required to build the connection. Use the dropdown menu to select the proxy agent from a list of previously configured proxy agents.

   5. Description (Optional): Add a description for the connection.

   6. Active: Check the checkbox to ensure the connection is available for use.

   7. Privileged: Chooses access level for the connection. Only roles with Privileged Connection settings can set and use privileged integration connections.

   8. Configure User Permissions: Defines which users have access to the connection.

   9. System: This section contains the parameters defined specifically for the integration. These parameters must be configured to create the integration connection.

      

      1. Input the domain-level Loki Log URL. Refer to step 5 in Retrieving the Loki Log URL and Username.

      2. Input the Loki Log Username. Refer to step 5 in Retrieving the Loki Log URL and Username.3

      3. Input the Metrics URL. Refer to step 3 in Retrieving the Metrics URL and Metrics Username.

      4. Input the Metrics Username. Refer to step 3 in Retrieving the Metrics URL and Metrics Username.

      5. Input the API Token. Refer to step 7 in Creating the API Token.

   10. Enable Password Vault: An optional feature that allows users to take the stored credentials from their own password vault. Refer to the password vault connection guide if needed.

   11. Connection Health Check: Updates the connection status you have created. A connection health check is done by scheduling the Test Connection command of this integration. This can only be done when the connection is active.

       To set up a connection health check, check the Connection Health Check tick box. You can customize the interval (minutes) for scheduling the health check. An email notification can be set up after a specified number of failed connection attempts.

4. Test the connection.

   

   1. Click on the Test Connection button to verify credentials and connectivity. A success alert displays Passed with a green checkmark. If the connection fails, review the parameters and retry.

   2. Click OK to close the alert window.

   3. Click + Add to create and add the configured connection.

Commands

Grafana includes the following executable commands for users to set up schedules or create playbook workflows. With the Test Command function, users can execute these commands independently for playbook troubleshooting.

Integration API Note

For more information about the Grafana API, refer to the references below.

• Loki HTTP API | Grafana

• How to use HTTP APIs to send metrics and logs to Grafana Cloud | Grafana

Note for Time-related parameters

The input format of time-related parameters may vary based on user account settings, which may cause the sample data in commands to differ from what is displayed. To adjust the time format, follow these steps:

1. Navigate to Configuration > Application Settings. Select Date/Time Format.

   

2. Choose the desired date and time format, then click on the Save button.

   

After that, users will be able to view their preferred time format when configuring the DateTime input parameters for commands.

Send Loki Logs

Sends Log entries to Loki.

Input

[
    [
        "1731534656000000000",
        "log message"
    ]
]

{
    "source": "D3_VSOC_1",
    "app": "SOAR"
}

Output

To view the sample output data for all commands, refer to this article.

Error Handling

If the Return Data displays Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.

Send Metric

Sends a Metric to Grafana.

Input

{
    "bar_label": "d3",
    "source": "vsoc_1"
}

Output

To view the sample output data for all commands, refer to this article.

Error Handling

If the Return Data displays Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.

Test Connection

Allows users to perform a health check on an integration connection. Users can schedule a periodic health check by selecting Connection Health Check when editing an integration connection.

Input

N/A

Output

Error Handling

If the Return Data displays Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.