Create JSON-Connected Dashboards in Grafana

Cameron Leblanc
Cameron Leblanc
Senior Technology Evangelist
Connect to JSON Services via CData Connect AI in Grafana and create custom business dashboards with real-time access to JSON services.

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 JSON services for business dashboards. This article outlines the process of connecting to JSON using Connect AI and creating a basic dashboard from JSON services within Grafana.

CData Connect AI offers a pure SQL Server, cloud-to-cloud interface for JSON, enabling the creation of dashboards directly from live JSON services 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 JSON. This leverages server-side processing to swiftly deliver the requested JSON services.

Configure JSON Connectivity for Grafana

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

  1. Log into Connect AI, click Sources, and then click Add Connection
  2. Select "JSON" from the Add Connection panel
  3. Enter the necessary authentication properties to connect to JSON.

    See the Getting Started chapter in the data provider documentation to authenticate to your data source: The data provider models JSON APIs as bidirectional database tables and JSON files as read-only views (local files, files stored on popular cloud services, and FTP servers). The major authentication schemes are supported, including HTTP Basic, Digest, NTLM, OAuth, and FTP. See the Getting Started chapter in the data provider documentation for authentication guides.

    After setting the URI and providing any authentication values, set DataModel to more closely match the data representation to the structure of your data.

    The DataModel property is the controlling property over how your data is represented into tables and toggles the following basic configurations.

    • Document (default): Model a top-level, document view of your JSON data. The data provider returns nested elements as aggregates of data.
    • FlattenedDocuments: Implicitly join nested documents and their parents into a single table.
    • Relational: Return individual, related tables from hierarchical data. The tables contain a primary key and a foreign key that links to the parent document.

    See the Modeling JSON Data chapter for more information on configuring the relational representation. You will also find the sample data used in the following examples. The data includes entries for people, the cars they own, and various maintenance services performed on those cars.

  4. Click Save & Test
  5. Navigate to the Permissions tab in the Add JSON Connection page and update the User-based 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.
  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 JSON services from Grafana.

Visualize Live JSON Services 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.
  4. Select Microsoft SQL Server and click Add new data source.
  5. Enter a name for the new data source and then enter the following connection settings:
    • Host: tds.cdata.com:14333
    • Database: enter the Connection Name of the CData Connect AI data source you want to connect to (for example, JSON1).
    • Username: enter your CData Connect AI username. This is displayed in the top-right corner of the CData Connect AI interface. For example, [email protected].
    • Password: enter the PAT you previously generated.
  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 JSON, you can start building dashboards on JSON services. 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.
  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.
  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.
  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!

Ready to get started?

Learn more about CData Connect AI or sign up for free trial access:

Free Trial