Grafana

BETA

Available In

Feature List

Dashboards

Charts

Owners

How to Run the Connector Externally

To run the Ingestion via the UI you'll need to use the OpenMetadata Ingestion Container, which comes shipped with custom Airflow plugins to handle the workflow deployment.

If, instead, you want to manage your workflows externally on your preferred orchestrator, you can check the following docs to run the Ingestion Framework anywhere.

External Schedulers

Get more information about running the Ingestion Framework Externally

Requirements

You will need:

Grafana 9.0+ (Service Account Tokens)
Service Account Token with Admin role (for full metadata extraction)
Network access to Grafana API endpoints

Python Requirements

We have support for Python versions 3.9-3.11

To run the Grafana ingestion, install:

Metadata Ingestion

All connectors are defined as JSON Schemas. Here you can find the structure to create a connection to Grafana.

In order to create and run a Metadata Ingestion workflow, we will follow the steps to create a YAML configuration able to connect to the source, process the Entities if needed, and reach the OpenMetadata server.

1. Define the YAML Config

This is a sample config for Grafana:

Source Configuration - Service Connection

hostPort: URL or IP address of your Grafana instance.

apiKey: Service Account Token for authentication (format: glsa_xxxxx). Admin role recommended.

verifySSL: (Optional) Whether to verify SSL certificates. Default: true

pageSize: (Optional) Page size for Grafana API pagination. Default: 100

includeTags: When set to true, imports Grafana tags as OpenMetadata tags.

Sink Configuration

To send the metadata to OpenMetadata, specify type: metadata-rest.

Workflow Configuration

The main property here is the openMetadataServerConfig, where you can define the host and security provider of your OpenMetadata installation.

Logger Level

You can specify the loggerLevel depending on your needs. If you are trying to troubleshoot an ingestion, running with DEBUG will give you far more traces for identifying issues.

JWT Token

JWT tokens will allow your clients to authenticate against the OpenMetadata server. To enable JWT Tokens, you will get more details here.

You can refer to the JWT Troubleshooting section link for any issues in your JWT configuration.

Store Service Connection

If set to true (default), we will store the sensitive information either encrypted via the Fernet Key in the database or externally, if you have configured any Secrets Manager.

If set to false, the service will be created, but the service connection information will only be used by the Ingestion Framework at runtime, and won't be sent to the OpenMetadata server.

Store Service Connection

If set to true (default), we will store the sensitive information either encrypted via the Fernet Key in the database or externally, if you have configured any Secrets Manager.

If set to false, the service will be created, but the service connection information will only be used by the Ingestion Framework at runtime, and won't be sent to the OpenMetadata server.

SSL Configuration

If you have added SSL to the OpenMetadata server, then you will need to handle the certificates when running the ingestion too. You can either set verifySSL to ignore, or have it as validate, which will require you to set the sslConfig.caCertificate with a local path where your ingestion runs that points to the server certificate file.

Find more information on how to troubleshoot SSL issues here.

ingestionPipelineFQN

Fully qualified name of ingestion pipeline, used to identify the current ingestion pipeline.

grafana-workflow.yaml

Securing Grafana Connection with SSL in OpenMetadata

2. Run with the CLI

First, we will need to save the YAML file. Afterward, and with all requirements installed, we can run:

Note that from connector to connector, this recipe will always be the same. By updating the YAML configuration, you will be able to extract metadata from different sources.