Data source health check: Support data source zipkin

README.md

@@ -172,6 +172,7 @@ implemented as of June 2022.
 - Prometheus
 - Tempo
 - Testdata
+- Zipkin
 
 We are humbly asking the community to contribute adapters for other data
 sources.

docs/datasource-state.md

@@ -19,7 +19,6 @@ stackdriver
 testdata
 
 ### UNKNOWN
-zipkin
 
 ### TODO
 alertmanager

examples/datasource-health-probe.rst

@@ -216,3 +216,10 @@ Testdata
 
     python examples/datasource-health-probe.py --type=testdata
 
+
+Zipkin
+======
+::
+
+    docker run --rm -it --publish=9411:9411 openzipkin/zipkin:2.23
+    python examples/datasource-health-probe.py --type=zipkin --url=http://host.docker.internal:9411

grafana_client/elements/datasource.py

@@ -349,6 +349,12 @@ def health_check(self, datasource: Union[DatasourceIdentifier, Dict]) -> Datasou
                     message = "Success"
                     success = True
 
+            # With Zipkin, a 200 OK response with a JSON body containing an empty array is probably just fine.
+            elif datasource_type == "zipkin":
+                if response == []:
+                    message = "Success"
+                    success = True
+
             # Generic case, where the response has a top-level `results` or `data` key.
             else:
                 if "results" in response:

grafana_client/knowledge.py

@@ -107,6 +107,8 @@ def datasource_factory(datasource: DatasourceModel) -> DatasourceModel:
         datasource.access = "proxy"
     elif datasource.type == "testdata":
         pass
+    elif datasource.type == "zipkin":
+        datasource.access = "proxy"
     else:
         raise NotImplementedError(f"Unknown data source type: {datasource.type}")
     return datasource
@@ -226,6 +228,8 @@ def query_factory(datasource, expression: str, store: Optional[str] = None) -> U
         query = {}
     elif datasource_type == "testdata":
         query = expression
+    elif datasource_type == "zipkin":
+        query = {}
     else:
         raise NotImplementedError(f"Unknown data source type: {datasource_type}")
     return query
@@ -251,6 +255,7 @@ def query_factory(datasource, expression: str, store: Optional[str] = None) -> U
     "simpod-json-datasource": "url:///datasources/proxy/{datasource_id}",
     "tempo": "url:///datasources/proxy/{datasource_id}/api/echo",
     "testdata": "url:///datasources/uid/{datasource_uid}",
+    "zipkin": "url:///datasources/proxy/{datasource_id}/api/v2/services",
 }
 
 

test/elements/test_datasource_fixtures.py

@@ -151,6 +151,14 @@
     "access": "proxy",
 }
 
+ZIPKIN_DATASOURCE = {
+    "id": 57,
+    "uid": "3sXIv8q7k",
+    "name": "Zipkin",
+    "type": "zipkin",
+    "access": "proxy",
+}
+
 
 PROMETHEUS_DATA_RESPONSE = {
     "status": "success",

test/elements/test_datasource_health.py

@@ -20,6 +20,7 @@
     SUNANDMOON_DATASOURCE_INCOMPLETE,
     TEMPO_DATASOURCE,
     TESTDATA_DATASOURCE,
+    ZIPKIN_DATASOURCE,
 )
 
 import requests_mock
@@ -731,6 +732,32 @@ def test_health_check_testdata(self, m):
             ),
         )
 
+    @requests_mock.Mocker()
+    def test_health_check_zipkin_success(self, m):
+        m.get(
+            "http://localhost/api/datasources/uid/3sXIv8q7k",
+            json=ZIPKIN_DATASOURCE,
+        )
+        m.get(
+            "http://localhost/api/datasources/proxy/57/api/v2/services",
+            json=[],
+        )
+        response = self.grafana.datasource.health_check(DatasourceIdentifier(uid="3sXIv8q7k"))
+        response.duration = None
+        response.response = None
+        self.assertEqual(
+            response,
+            DatasourceHealthResponse(
+                uid="3sXIv8q7k",
+                type="zipkin",
+                success=True,
+                status="OK",
+                message="Success",
+                duration=None,
+                response=None,
+            ),
+        )
+
     @requests_mock.Mocker()
     def test_health_check_zdict_valid_response_success(self, m):
         """