feat(ingest): grafana connector (datahub-project#10891)

Co-authored-by: Shirshanka Das <shirshanka@apache.org>
Co-authored-by: Harshal Sheth <hsheth2@gmail.com>

metadata-ingestion/setup.py

@@ -345,6 +345,7 @@
         "flask-openid>=1.3.0",
         "dask[dataframe]<2024.7.0",
     },
+    "grafana": {"requests"},
     "glue": aws_common,
     # hdbcli is supported officially by SAP, sqlalchemy-hana is built on top but not officially supported
     "hana": sql_common
@@ -635,6 +636,7 @@
         "dynamodb = datahub.ingestion.source.dynamodb.dynamodb:DynamoDBSource",
         "elasticsearch = datahub.ingestion.source.elastic_search:ElasticsearchSource",
         "feast = datahub.ingestion.source.feast:FeastRepositorySource",
+        "grafana = datahub.ingestion.source.grafana.grafana_source:GrafanaSource",
         "glue = datahub.ingestion.source.aws.glue:GlueSource",
         "sagemaker = datahub.ingestion.source.aws.sagemaker:SagemakerSource",
         "hana = datahub.ingestion.source.sql.hana:HanaSource",

metadata-ingestion/src/datahub/ingestion/source/grafana/grafana_source.py

@@ -0,0 +1,131 @@
+from typing import Iterable, List, Optional
+
+import requests
+from pydantic import Field, SecretStr
+
+import datahub.emitter.mce_builder as builder
+from datahub.configuration.source_common import PlatformInstanceConfigMixin
+from datahub.emitter.mcp import MetadataChangeProposalWrapper
+from datahub.ingestion.api.common import PipelineContext
+from datahub.ingestion.api.decorators import (
+    SupportStatus,
+    config_class,
+    platform_name,
+    support_status,
+)
+from datahub.ingestion.api.source import MetadataWorkUnitProcessor
+from datahub.ingestion.api.source_helpers import auto_workunit
+from datahub.ingestion.api.workunit import MetadataWorkUnit
+from datahub.ingestion.source.state.stale_entity_removal_handler import (
+    StaleEntityRemovalHandler,
+    StaleEntityRemovalSourceReport,
+    StatefulIngestionConfigBase,
+)
+from datahub.ingestion.source.state.stateful_ingestion_base import (
+    StatefulIngestionReport,
+    StatefulIngestionSourceBase,
+)
+from datahub.metadata.com.linkedin.pegasus2avro.common import ChangeAuditStamps
+from datahub.metadata.schema_classes import DashboardInfoClass, StatusClass
+
+
+class GrafanaSourceConfig(StatefulIngestionConfigBase, PlatformInstanceConfigMixin):
+    url: str = Field(
+        default="",
+        description="Grafana URL in the format http://your-grafana-instance with no trailing slash",
+    )
+    service_account_token: SecretStr = Field(
+        description="Service account token for Grafana"
+    )
+
+
+class GrafanaReport(StaleEntityRemovalSourceReport):
+    pass
+
+
+@platform_name("Grafana")
+@config_class(GrafanaSourceConfig)
+@support_status(SupportStatus.TESTING)
+class GrafanaSource(StatefulIngestionSourceBase):
+    """
+    This is an experimental source for Grafana.
+    Currently only ingests dashboards (no charts)
+    """
+
+    def __init__(self, config: GrafanaSourceConfig, ctx: PipelineContext):
+        super().__init__(config, ctx)
+        self.source_config = config
+        self.report = GrafanaReport()
+        self.platform = "grafana"
+
+    @classmethod
+    def create(cls, config_dict, ctx):
+        config = GrafanaSourceConfig.parse_obj(config_dict)
+        return cls(config, ctx)
+
+    def get_workunit_processors(self) -> List[Optional[MetadataWorkUnitProcessor]]:
+        return [
+            *super().get_workunit_processors(),
+            StaleEntityRemovalHandler.create(
+                self, self.source_config, self.ctx
+            ).workunit_processor,
+        ]
+
+    def get_report(self) -> StatefulIngestionReport:
+        return self.report
+
+    def get_workunits_internal(self) -> Iterable[MetadataWorkUnit]:
+        headers = {
+            "Authorization": f"Bearer {self.source_config.service_account_token.get_secret_value()}",
+            "Content-Type": "application/json",
+        }
+        try:
+            response = requests.get(
+                f"{self.source_config.url}/api/search", headers=headers
+            )
+            response.raise_for_status()
+        except requests.exceptions.RequestException as e:
+            self.report.report_failure(f"Failed to fetch dashboards: {str(e)}")
+            return
+        res_json = response.json()
+        for item in res_json:
+            uid = item["uid"]
+            title = item["title"]
+            url_path = item["url"]
+            full_url = f"{self.source_config.url}{url_path}"
+            dashboard_urn = builder.make_dashboard_urn(
+                platform=self.platform,
+                name=uid,
+                platform_instance=self.source_config.platform_instance,
+            )
+
+            yield from auto_workunit(
+                MetadataChangeProposalWrapper.construct_many(
+                    entityUrn=dashboard_urn,
+                    aspects=[
+                        DashboardInfoClass(
+                            description="",
+                            title=title,
+                            charts=[],
+                            lastModified=ChangeAuditStamps(),
+                            externalUrl=full_url,
+                            customProperties={
+                                key: str(value)
+                                for key, value in {
+                                    "displayName": title,
+                                    "id": item["id"],
+                                    "uid": uid,
+                                    "title": title,
+                                    "uri": item["uri"],
+                                    "type": item["type"],
+                                    "folderId": item.get("folderId"),
+                                    "folderUid": item.get("folderUid"),
+                                    "folderTitle": item.get("folderTitle"),
+                                }.items()
+                                if value is not None
+                            },
+                        ),
+                        StatusClass(removed=False),
+                    ],
+                )
+            )

metadata-ingestion/tests/integration/grafana/default-dashboard.json

@@ -0,0 +1,25 @@
+{
+    "id": null,
+    "uid": "default",
+    "title": "Default Dashboard",
+    "tags": [],
+    "timezone": "browser",
+    "schemaVersion": 16,
+    "version": 0,
+    "panels": [
+        {
+            "type": "text",
+            "title": "Welcome",
+            "gridPos": {
+                "x": 0,
+                "y": 0,
+                "w": 24,
+                "h": 5
+            },
+            "options": {
+                "content": "Welcome to your Grafana dashboard!",
+                "mode": "markdown"
+            }
+        }
+    ]
+}

metadata-ingestion/tests/integration/grafana/docker-compose.yml

@@ -0,0 +1,32 @@
+version: '3.7'
+
+services:
+  grafana:
+    image: grafana/grafana:latest
+    container_name: grafana
+    ports:
+      - "3000:3000"
+    environment:
+      - GF_SECURITY_ADMIN_PASSWORD=admin
+      - GF_SECURITY_ADMIN_USER=admin
+      - GF_PATHS_PROVISIONING=/etc/grafana/provisioning
+    volumes:
+      - grafana-storage:/var/lib/grafana
+      - ./provisioning:/etc/grafana/provisioning
+      - ./default-dashboard.json:/var/lib/grafana/dashboards/default-dashboard.json
+    depends_on:
+      - postgres
+
+  postgres:
+    image: postgres:13
+    container_name: grafana-postgres
+    environment:
+      POSTGRES_DB: grafana
+      POSTGRES_USER: grafana
+      POSTGRES_PASSWORD: grafana
+    volumes:
+      - postgres-storage:/var/lib/postgresql/data
+
+volumes:
+  grafana-storage:
+  postgres-storage:

metadata-ingestion/tests/integration/grafana/grafana_mcps_golden.json

@@ -0,0 +1,56 @@
+[
+{
+    "entityType": "dashboard",
+    "entityUrn": "urn:li:dashboard:(grafana,default)",
+    "changeType": "UPSERT",
+    "aspectName": "dashboardInfo",
+    "aspect": {
+        "json": {
+            "customProperties": {
+                "displayName": "Default Dashboard",
+                "id": "1",
+                "uid": "default",
+                "title": "Default Dashboard",
+                "uri": "db/default-dashboard",
+                "type": "dash-db"
+            },
+            "externalUrl": "http://localhost:3000/d/default/default-dashboard",
+            "title": "Default Dashboard",
+            "description": "",
+            "charts": [],
+            "datasets": [],
+            "lastModified": {
+                "created": {
+                    "time": 0,
+                    "actor": "urn:li:corpuser:unknown"
+                },
+                "lastModified": {
+                    "time": 0,
+                    "actor": "urn:li:corpuser:unknown"
+                }
+            }
+        }
+    },
+    "systemMetadata": {
+        "lastObserved": 1720785600000,
+        "runId": "grafana-test-simple",
+        "lastRunId": "no-run-id-provided"
+    }
+},
+{
+    "entityType": "dashboard",
+    "entityUrn": "urn:li:dashboard:(grafana,default)",
+    "changeType": "UPSERT",
+    "aspectName": "status",
+    "aspect": {
+        "json": {
+            "removed": false
+        }
+    },
+    "systemMetadata": {
+        "lastObserved": 1720785600000,
+        "runId": "grafana-test-simple",
+        "lastRunId": "no-run-id-provided"
+    }
+}
+]

metadata-ingestion/tests/integration/grafana/provisioning/api-keys/api_keys.yaml

@@ -0,0 +1,3 @@
+api_keys:
+  - name: 'example-api-key'
+    role: 'Admin'

metadata-ingestion/tests/integration/grafana/provisioning/dashboards/dashboard.yaml

@@ -0,0 +1,11 @@
+apiVersion: 1
+
+providers:
+  - name: 'default'
+    orgId: 1
+    folder: ''
+    type: file
+    disableDeletion: false
+    updateIntervalSeconds: 10
+    options:
+      path: /var/lib/grafana/dashboards

metadata-ingestion/tests/integration/grafana/provisioning/datasources/datasource.yaml

@@ -0,0 +1,12 @@
+apiVersion: 1
+
+datasources:
+  - name: PostgreSQL
+    type: postgres
+    access: proxy
+    url: postgres:5432
+    database: grafana
+    user: grafana
+    password: grafana
+    jsonData:
+      sslmode: disable

metadata-ingestion/tests/integration/grafana/provisioning/service_accounts/service_accounts.yaml

@@ -0,0 +1,6 @@
+service_accounts:
+  - name: 'example-service-account'
+    role: 'Admin'
+    apiKeys:
+      - keyName: 'example-api-key'
+        role: 'Admin'