VOOZH about

URL: https://www.cdata.com/kb/tech/adobecommerce-cloud-grafana.rst

⇱ Create Adobe Commerce-Connected Dashboards in Grafana


Create Adobe Commerce-Connected Dashboards in Grafana

πŸ‘ Cameron Leblanc
Cameron Leblanc
Senior Technology Evangelist
Connect to Adobe Commerce Data via CData Connect AI in Grafana and create custom business dashboards with real-time access to Adobe Commerce data.

Grafana is an open-source platform that allows users to analyze, monitor, and visualize telemetry from various data sources. When combined with CData Connect AI, you gain immediate access to Adobe Commerce data for business dashboards. This article outlines the process of connecting to Adobe Commerce using Connect AI and creating a basic dashboard from Adobe Commerce data within Grafana.

CData Connect AI offers a pure SQL Server, cloud-to-cloud interface for Adobe Commerce, enabling the creation of dashboards directly from live Adobe Commerce data within Grafana, all without the need for data replication to a native database. As you build visualizations, Grafana generates SQL queries to gather data. With its inherent optimized data processing capabilities, CData Connect AI efficiently channels all supported SQL operations, including filters and JOINs, directly to Adobe Commerce. This leverages server-side processing to swiftly deliver the requested Adobe Commerce data.

Configure Adobe Commerce Connectivity for Grafana

Connectivity to Adobe Commerce from Grafana is made possible through CData Connect AI. To work with Adobe Commerce data from Grafana, we start by creating and configuring a Adobe Commerce connection.

  1. Log into Connect AI, click Sources, and then click Add Connection
  2. πŸ‘ Adding a Connection
  3. Select "Adobe Commerce" from the Add Connection panel
  4. πŸ‘ Selecting a data source
  5. Enter the necessary authentication properties to connect to Adobe Commerce.

    Adobe Commerce uses the OAuth 1 authentication standard. To connect to the Adobe Commerce REST API, obtain values for the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties by registering an app with your Adobe Commerce system. See the "Getting Started" section in the help documentation for a guide to obtaining the OAuth values and connecting.

    You will also need to provide the URL to your Adobe Commerce system. The URL depends on whether you are using the Adobe Commerce REST API as a customer or administrator.

    • Customer: To use Adobe Commerce as a customer, make sure you have created a customer account in the Adobe Commerce homepage. To do so, click Account -> Register. You can then set the URL connection property to the endpoint of your Adobe Commerce system.

    • Administrator: To access Adobe Commerce as an administrator, set CustomAdminPath instead. This value can be obtained in the Advanced settings in the Admin menu, which can be accessed by selecting System -> Configuration -> Advanced -> Admin -> Admin Base URL.

      If the Use Custom Admin Path setting on this page is set to YES, the value is inside the Custom Admin Path text box; otherwise, set the CustomAdminPath connection property to the default value, which is "admin".

    πŸ‘ Configuring a connection (Salesforce is shown)
  6. Click Save & Test
  7. Navigate to the Permissions tab in the Add Adobe Commerce Connection page and update the User-based permissions. πŸ‘ Updating permissions

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

  1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
  2. On the Settings page, go to the Access Tokens section and click Create PAT.
  3. Give the PAT a name and click Create. πŸ‘ Creating a new PAT
  4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

With the connection configured and a PAT generated, you are ready to connect to Adobe Commerce data from Grafana.

Visualize Live Adobe Commerce Data in Grafana

To establish a connection from Grafana to the CData Connect AI Virtual SQL Server API, follow these steps.

  1. If you have not already done so, download and install Grafana for your operating system from the Grafana Website. Once installed, access Grafana at http://localhost:3000/.
  2. Log in to Grafana with your username and password for Grafana. If this is your first time logging in, the username is admin and the password is admin.
  3. On the navigation menu, click Sources > Add new connection. On this page, you can search for Microsoft SQL Server and select it as your data source. πŸ‘ Adding a new Connection in Grafana
  4. Select Microsoft SQL Server and click Add new data source. πŸ‘ Adding a new Connection in Grafana
  5. Enter a name for the new data source and then enter the following connection settings:
  6. Click Save & Test. A Database Connect OK message appears when you have a successful connection established.

Create a Dashboard

Once you create the data source for Adobe Commerce, you can start building dashboards on Adobe Commerce data. Start in the navigation menu and click Dashboards

  1. On the Dashboards page, click + Create dashboard, then click + Add visualization.
  2. This opens the Select data source window where you can select your created connection. πŸ‘ Select your connection. (Salesforce shown)
  3. After selecting your connection, you can choose the tables and columns that you want to query for your visualization. Then press Run Query to run the generated query. πŸ‘ Select the tables and columns you want to query. (Salesforce shown)
  4. After running your query, the resulting data is populated above the query editor. Here you can select the visualization that you want to use to present your data on the dashboard panel. πŸ‘ Visualize your queried data. (Salesforce shown)
  5. When you have finished editing your panel, you can click Save dashboard to save the changes made to your Dashboard.

To get live data access to hundreds of SaaS, Big Data, and NoSQL sources directly from your cloud applications, try CData Connect AI today!