mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2026-01-06 04:26:57 +00:00
Docs: Grafana Connector Updation (#22875)
* Docs: Grafana Connector Updation * Docs: Grafana Connector Updation --------- Co-authored-by: “Rounak <“rounakpreet.d@deuexsolutions.com”>
This commit is contained in:
parent
c4d395d14d
commit
b725bee3c7
@ -1,6 +1,7 @@
|
||||
{% connectorsListContainer %}
|
||||
|
||||
{% connectorInfoCard name="Domo" stage="PROD" href="/connectors/dashboard/domo-dashboard" platform="OpenMetadata" / %}
|
||||
{% connectorInfoCard name="Grafana" stage="BETA" href="/connectors/dashboard/grafana" platform="OpenMetadata" / %}
|
||||
{% connectorInfoCard name="Lightdash" stage="PROD" href="/connectors/dashboard/lightdash" platform="OpenMetadata" / %}
|
||||
{% connectorInfoCard name="Looker" stage="PROD" href="/connectors/dashboard/looker" platform="OpenMetadata" / %}
|
||||
{% connectorInfoCard name="Metabase" stage="PROD" href="/connectors/dashboard/metabase" platform="OpenMetadata" / %}
|
||||
|
||||
@ -327,6 +327,12 @@ site_menu:
|
||||
url: /connectors/dashboard/domo-dashboard/yaml
|
||||
- category: Connectors / Dashboard / Domo Dashboard / Troubleshooting
|
||||
url: /connectors/dashboard/domo-dashboard/troubleshooting
|
||||
- category: Connectors / Database / Grafana
|
||||
url: /connectors/dashboard/grafana
|
||||
- category: Connectors / Database / Grafana / Run Externally
|
||||
url: /connectors/dashboard/grafana/yaml
|
||||
- category: Connectors / Database / Grafana / Troubleshooting
|
||||
url: /connectors/dashboard/grafana/troubleshooting
|
||||
- category: Connectors / Dashboard / Lightdash
|
||||
url: /connectors/dashboard/lightdash
|
||||
- category: Connectors / Dashboard / Lightdash / Run Externally
|
||||
|
||||
@ -0,0 +1,55 @@
|
||||
---
|
||||
title: Grafana Connector | OpenMetadata Integration Guide
|
||||
description: Learn how to configure and use the Grafana connector in OpenMetadata. Includes setup, authentication, metadata ingestion, and lineage.
|
||||
slug: /connectors/dashboard/grafana
|
||||
---
|
||||
|
||||
{% connectorDetailsHeader
|
||||
name="Grafana"
|
||||
stage="BETA"
|
||||
platform="OpenMetadata"
|
||||
availableFeatures=["Dashboards", "Charts", "Owners", "Tags", "Lineage"]
|
||||
unavailableFeatures=[]
|
||||
/ %}
|
||||
|
||||
In this section, we provide guides and references to use the Grafana connector.
|
||||
|
||||
Configure and schedule Grafana metadata and profiler workflows from the OpenMetadata UI:
|
||||
|
||||
- [Requirements](#requirements)
|
||||
- [Metadata Ingestion](#metadata-ingestion)
|
||||
|
||||
|
||||
{% partial file="/v1.9/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/dashboard/grafana/yaml"} /%}
|
||||
|
||||
## Requirements
|
||||
|
||||
To access the Grafana APIs and import dashboards and panels into OpenMetadata, you need a Service Account Token with sufficient permissions (Admin role is recommended) and API access enabled on your Grafana instance.
|
||||
|
||||
## Metadata Ingestion
|
||||
|
||||
{% partial
|
||||
file="/v1.9/connectors/metadata-ingestion-ui.md"
|
||||
variables={
|
||||
connector: "Grafana",
|
||||
selectServicePath: "/images/v1.9/connectors/grafana/select-service.png",
|
||||
addNewServicePath: "/images/v1.9/connectors/grafana/add-new-service.png",
|
||||
serviceConnectionPath: "/images/v1.9/connectors/grafana/service-connection.png",
|
||||
}
|
||||
/%}
|
||||
|
||||
{% stepsContainer %}
|
||||
|
||||
{% partial file="/v1.9/connectors/test-connection.md" /%}
|
||||
|
||||
{% partial file="/v1.9/connectors/dashboard/configure-ingestion.md" /%}
|
||||
|
||||
{% partial file="/v1.9/connectors/ingestion-schedule-and-deploy.md" /%}
|
||||
|
||||
{% /stepsContainer %}
|
||||
|
||||
Enable debug logging to troubleshoot issues:
|
||||
|
||||
```bash
|
||||
export LOG_LEVEL=DEBUG
|
||||
```
|
||||
@ -0,0 +1,7 @@
|
||||
---
|
||||
title: Grafana Troubleshooting Guide | OpenMetadata Support
|
||||
description: Troubleshoot Grafana connector issues related to table ingestion, schema parsing, or access errors.
|
||||
slug: /connectors/database/grafana/troubleshooting
|
||||
---
|
||||
|
||||
{% partial file="/v1.9/connectors/troubleshooting.md" /%}
|
||||
@ -0,0 +1,140 @@
|
||||
---
|
||||
title: Run the Grafana Connector Externally
|
||||
description: Learn to run the Grafana connector externally in OpenMetadata. Configure metadata ingestion via YAML, including Service Account Token auth, lineage, and SSL setup.
|
||||
slug: /connectors/dashboard/grafana/yaml
|
||||
---
|
||||
|
||||
{% connectorDetailsHeader
|
||||
name="Grafana"
|
||||
stage="BETA"
|
||||
platform="OpenMetadata"
|
||||
availableFeatures=["Dashboards", "Charts", "Owners", "Tags", "Lineage"]
|
||||
unavailableFeatures=[]
|
||||
/ %}
|
||||
|
||||
In this section, we provide guides and references to use the Grafana connector.
|
||||
|
||||
Configure and schedule Grafana metadata and profiler workflows from the OpenMetadata UI:
|
||||
|
||||
- [Requirements](#requirements)
|
||||
- [Metadata Ingestion](#metadata-ingestion)
|
||||
|
||||
{% partial file="/v1.9/connectors/external-ingestion-deployment.md" /%}
|
||||
|
||||
## 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
|
||||
|
||||
{% partial file="/v1.9/connectors/python-requirements.md" /%}
|
||||
|
||||
To run the Grafana ingestion, install:
|
||||
|
||||
```bash
|
||||
pip3 install "openmetadata-ingestion[grafana]"
|
||||
```
|
||||
|
||||
## Metadata Ingestion
|
||||
|
||||
All connectors are defined as JSON Schemas.
|
||||
[Here](https://github.com/open-metadata/OpenMetadata/blob/main/openmetadata-spec/src/main/resources/json/schema/entity/services/connections/dashboard/grafanaConnection.json)
|
||||
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:
|
||||
|
||||
{% codePreview %}
|
||||
|
||||
{% codeInfoContainer %}
|
||||
|
||||
#### Source Configuration - Service Connection
|
||||
|
||||
{% codeInfo srNumber=1 %}
|
||||
|
||||
**hostPort**: URL or IP address of your Grafana instance.
|
||||
|
||||
{% /codeInfo %}
|
||||
|
||||
{% codeInfo srNumber=2 %}
|
||||
|
||||
**apiKey**: Service Account Token for authentication (format: `glsa_xxxxx`). Admin role recommended.
|
||||
|
||||
{% /codeInfo %}
|
||||
|
||||
{% codeInfo srNumber=3 %}
|
||||
|
||||
**verifySSL**: (Optional) Whether to verify SSL certificates. Default: true
|
||||
|
||||
{% /codeInfo %}
|
||||
|
||||
{% codeInfo srNumber=4 %}
|
||||
|
||||
**pageSize**: (Optional) Page size for Grafana API pagination. Default: 100
|
||||
|
||||
{% /codeInfo %}
|
||||
|
||||
{% codeInfo srNumber=5 %}
|
||||
|
||||
**includeTags**: When set to true, imports Grafana tags as OpenMetadata tags.
|
||||
|
||||
{% /codeInfo %}
|
||||
|
||||
#### Sink Configuration
|
||||
|
||||
{% codeInfo srNumber=6 %}
|
||||
|
||||
To send the metadata to OpenMetadata, specify `type: metadata-rest`.
|
||||
|
||||
{% /codeInfo %}
|
||||
|
||||
{% partial file="/v1.9/connectors/yaml/workflow-config-def.md" /%}
|
||||
|
||||
{% /codeInfoContainer %}
|
||||
|
||||
{% codeBlock fileName="grafana-workflow.yaml" %}
|
||||
|
||||
```yaml {% isCodeBlock=true %}
|
||||
source:
|
||||
type: grafana
|
||||
serviceName: local_grafana
|
||||
serviceConnection:
|
||||
config:
|
||||
type: Grafana
|
||||
hostPort: https://grafana.example.com
|
||||
apiKey: glsa_xxxxxxxxxxxxxxxxxxxx
|
||||
verifySSL: true
|
||||
|
||||
sourceConfig:
|
||||
config:
|
||||
type: DashboardMetadata
|
||||
includeTags: true
|
||||
lineageInformation:
|
||||
dbServicePrefixes: ["mysql", "postgres"]
|
||||
|
||||
sink:
|
||||
type: metadata-rest
|
||||
config: {}
|
||||
|
||||
workflowConfig:
|
||||
openMetadataServerConfig:
|
||||
hostPort: <OpenMetadata host and port>
|
||||
authProvider: <OpenMetadata auth provider>
|
||||
```
|
||||
|
||||
{% /codeBlock %}
|
||||
|
||||
{% /codePreview %}
|
||||
|
||||
## Securing Grafana Connection with SSL in OpenMetadata
|
||||
|
||||
{% partial file="/v1.9/connectors/yaml/ingestion-cli.md" /%}
|
||||
@ -517,6 +517,12 @@ site_menu:
|
||||
url: /connectors/dashboard/domo-dashboard/yaml
|
||||
- category: Connectors / Dashboard / Domo Dashboard / Troubleshooting
|
||||
url: /connectors/dashboard/domo-dashboard/troubleshooting
|
||||
- category: Connectors / Database / Grafana
|
||||
url: /connectors/dashboard/grafana
|
||||
- category: Connectors / Database / Grafana / Run Externally
|
||||
url: /connectors/dashboard/grafana/yaml
|
||||
- category: Connectors / Database / Grafana / Troubleshooting
|
||||
url: /connectors/dashboard/grafana/troubleshooting
|
||||
- category: Connectors / Dashboard / Lightdash
|
||||
url: /connectors/dashboard/lightdash
|
||||
- category: Connectors / Dashboard / Lightdash / Run Externally
|
||||
|
||||
BIN
openmetadata-docs/images/connectors/grafana.webp
Normal file
BIN
openmetadata-docs/images/connectors/grafana.webp
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 13 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 192 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 312 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 424 KiB |
Loading…
x
Reference in New Issue
Block a user