Add Loki target

CHANGELOG.rst

@@ -9,7 +9,7 @@ x.x.x ?
 * Added ``tooltipSort`` parameter to PieChartv2 panel
 * Fix mappings for Table
 * Added support for AWS Cross-Account in CloudwatchMetricsTarget
-
+* Added `LokiTarget`
 
 0.7.1 2024-01-12
 ================

grafanalib/core.py

@@ -606,6 +606,29 @@ def to_json_data(self):
         }
 
 
+# Currently not deriving from `Target` because Grafana errors if fields like `query` are added to Loki targets
+@attr.s
+class LokiTarget(object):
+    """
+    Target for Loki LogQL queries
+    """
+
+    datasource = attr.ib(default='', validator=instance_of(str))
+    expr = attr.ib(default='', validator=instance_of(str))
+    hide = attr.ib(default=False, validator=instance_of(bool))
+
+    def to_json_data(self):
+        return {
+            'datasource': {
+                'type': 'loki',
+                'uid': self.datasource,
+            },
+            'expr': self.expr,
+            'hide': self.hide,
+            'queryType': 'range',
+        }
+
+
 @attr.s
 class SqlTarget(Target):
     """

grafanalib/tests/test_core.py

@@ -1152,6 +1152,32 @@ def test_target_invalid():
         )
 
 
+def test_loki_target():
+    t = G.Dashboard(
+        title='unittest',
+        uid='unit-test-uid',
+        timezone='browser',
+        panels=[
+            G.TimeSeries(
+                title='Some logs',
+                targets=[
+                    G.LokiTarget(
+                        datasource='my-logs',
+                        expr='{pod="unittest"} |= "hello"',
+                    ),
+                ],
+                gridPos=G.GridPos(h=10, w=24, x=0, y=0),
+            ),
+        ],
+    ).auto_panel_ids()
+
+    dashboard_json = t.to_json_data()
+    target_json = dashboard_json['panels'][0].targets[0].to_json_data()
+    # Grafana wants type/uid fields for Loki targets (as of 2024-04)
+    assert target_json['datasource']['type'] == 'loki'
+    assert target_json['datasource']['uid'] == 'my-logs'
+
+
 def test_sql_target():
     t = G.Table(
         dataSource="some data source",