Grafana: Basic end-to-end example / integration test by amotl · Pull Request #1442 · crate/cratedb-examples

amotl · 2026-03-03T05:10:31Z

About

we don't run integration tests against Grafana yet

Review

While CI is failing on some matrix slots, the patch can still be reviewed and merged, because it is valid, as demonstrated on CI slots of earlier Grafana releases. Thanks!

References

/cc @karynzv, @hammerhead, @goat-ssh, @zolbatar, @WalBeh

coderabbitai · 2026-03-03T05:10:41Z

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

@coderabbitai resume to resume automatic reviews.
@coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

▶️ Resume reviews
🔍 Trigger review

Walkthrough

Adds a Grafana integration: Dependabot entries, a new GitHub Actions "Grafana" workflow, a Docker Compose stack (CrateDB, Grafana, example task), a Python provisioning/validation script with requirements, and a test runner script for end‑to‑end verification.

Changes

Cohort / File(s)	Summary
Dependabot `\.github/dependabot.yml`	Added three Dependabot entries for `application/grafana` (package-ecosystems: `pip`, `docker`, `docker-compose`) scheduled daily.
CI Workflow `\.github/workflows/application-grafana.yml`	New "Grafana" GitHub Actions workflow: triggers on PR/push/manual/schedule, concurrency cancel-in-progress, matrix over OS/CrateDB/Grafana, runs `application/grafana/test.sh`.
Compose & Docker `application/grafana/compose.yml`	New Docker Compose defining `cratedb`, `grafana`, and `example-weather` (inline Dockerfile); healthchecks for CrateDB/Grafana; `example-weather` depends on healthy services and uses `tasks` profile.
Example App & Requirements `application/grafana/example-weather.py`, `application/grafana/requirements.txt`	New Python example that loads sample weather data into CrateDB, provisions a Grafana datasource and dashboard via API, and validates datasource/dashboard queries; requirements added (`cratedb-toolkit`, `grafana-client<6`, `grafanalib<0.8`).
Test runner `application/grafana/test.sh`	Shell script to bring up the compose stack (`docker compose up --wait -d`) and run the `example-weather` task via `docker compose run`.

Sequence Diagram

sequenceDiagram
    participant GHA as GitHub Actions
    participant Docker as Docker Compose
    participant CDB as CrateDB
    participant GF as Grafana
    participant Script as example-weather.py

    GHA->>Docker: docker compose up --wait -d
    Docker->>CDB: start CrateDB container
    Docker->>GF: start Grafana container
    CDB-->>Docker: healthcheck OK
    GF-->>Docker: healthcheck OK

    Docker->>Script: docker compose run example-weather
    Script->>CDB: insert sample weather data (SQL)
    CDB-->>Script: insert OK

    Script->>GF: create datasource via Grafana API
    GF-->>Script: datasource created / exists

    Script->>GF: upload/update dashboard
    GF-->>Script: dashboard created/ack

    Script->>GF: validate datasource health
    GF-->>Script: health OK

    Script->>GF: trigger dashboard queries (Grafana -> CrateDB)
    GF->>CDB: execute SQL queries
    CDB-->>GF: query results
    GF-->>Script: query responses (HTTP 200)

    Script-->>Docker: validation complete

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Suggested reviewers

seut
matriv
hammerhead

Poem

🐰 I hopped through compose and CI light,
I planted datasources late at night,
Weather rows in CrateDB sing,
Grafana panels bloom in spring,
A little rabbit cheers the flight. 🥕

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately and specifically describes the main change: adding a basic end-to-end example and integration test for Grafana, which aligns with the file additions and purpose evident in the changeset.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Description check	✅ Passed	The pull request description clearly relates to the changeset by explaining the purpose (adding Grafana integration tests) and acknowledging CI issues.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch grafana

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

application/grafana/requirements.txt

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@application/grafana/example-weather.py`:
- Around line 143-147: The current hard assert on
grafana.datasource.health_inquiry(DATASOURCE_UID) can fail due to Grafana's
health-check SQL being incompatible with CrateDB; keep the two logger.info lines
for health.status and health.message but remove the assert and instead run an
explicit lightweight smoke query via the smartquery API (e.g., call smartquery
with a trivial SELECT/limit against DATASOURCE_UID) to determine pass/fail; if
the smartquery returns a successful result treat the datasource as healthy,
otherwise log the smartquery error and raise/assert failure. Ensure you
reference grafana.datasource.health_inquiry, DATASOURCE_UID, health, logger, and
smartquery when making the change.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 985816ff-6a03-44ee-ab7d-29b15d1bde41

📥 Commits

Reviewing files that changed from the base of the PR and between 61e93bb and 09603e7.

📒 Files selected for processing (6)

.github/dependabot.yml
.github/workflows/application-grafana.yml
application/grafana/compose.yml
application/grafana/example-weather.py
application/grafana/requirements.txt
application/grafana/test.sh

🚧 Files skipped from review as they are similar to previous changes (3)

application/grafana/requirements.txt
application/grafana/test.sh
application/grafana/compose.yml

application/grafana/example-weather.py

amotl · 2026-03-10T11:45:46Z

Is it possible that this test rig can also validate the column name autocompletion feature?

Support parse_ident function crate#18660

seut

thanks! just some versions to check suggestions

seut · 2026-03-06T13:53:09Z

.github/workflows/application-grafana.yml

+          - "11.6"
+          - "12.3.4"
+          - "12.4"
+          - "nightly"


I don't think it makes sense to test a grafana nightly, it may fail for valid reasons which could never land in a release.

Suggested change

- "nightly"

I think this would only be the case with main. Using nightly here is the right choice to receive "going south" signals early. If we see too much flakyness due to unrelated instabilities in Grafana nightly, we can always remove that label again. I don't expect many of such, because we are only testing a very minor surface of Grafana, and I don't expect them to ship any completely dysfunctional releases. Grafana nightly is well tested.

I'd prefer to instead ensure that we update this once a new major or minor version is released (dependbot?). I'd like to avoid any possible effort caused by a nightly version which may never see the light. Anyhow, we can also test and remove it once it causes issues.

.github/workflows/application-grafana.yml

amotl · 2026-03-16T21:56:55Z

application/grafana/example-weather.py

+                        SELECT
+                            $__timeGroupAlias("timestamp", $__interval),
+                            "location",
+                            MEAN("{column_name}") AS "{column_name}"
+                        FROM "example"."weather_data"
+                        WHERE $__timeFilter("timestamp")
+                        GROUP BY "time", "location"
+                        ORDER BY "time"


Please note this querying scheme+template is super important to follow, otherwise you will set the wire and the browser on fire when processing big data.

@hammerhead told me about this the other day, but I don't know if it is general knowledge across the board and is correctly applied by all our users and customers. ¹

Footnotes

I have a slight suspicion users can overload their clusters easily because nobody tells them about those details. In this spirit, a dedicated CrateDB datasource plugin for Grafana would be very sweet indeed, which would optimally guide the user appropriately, similarly like InfluxDB users, for example, who do not need to be concerned about relevant details at all? ↩

However, in the following comment, you can see @matriv pinged me about the DATE_BIN() function that had been recommended by @seut.

If that works now, I would be happy to demonstrate the modern version here, even if it requires CrateDB 5.7. We can easily add the SQL template above to the documentation to inform users of older CrateDB versions.

Would be great to do that, 5.7 is already a bit old.

Did someone use the new variant successfully already, so we can copy from there?

/cc @hammerhead, @grbade, @zolbatar

@zolbatar will look into this detail. Thank you! 🙇

@coderabbitai: Please capture this into a dedicated issue, so we can improve later. Thank you.

🧩 Analysis chain

🏁 Script executed:

gh issue create \ --repo crate/cratedb-examples \ --title "Grafana: Improve SQL template to use DATE_BIN() (CrateDB 5.7+)" \ --body "## Summary In the Grafana end-to-end example ([application/grafana/example-weather.py](https://github.com/crate/cratedb-examples/blob/grafana/application/grafana/example-weather.py)), the SQL query template currently uses \`\$__timeGroupAlias(\"timestamp\", \$__interval)\` together with \`MEAN()\` for time-series aggregation. It has been recommended to adopt the modern \`DATE_BIN()\` function (available since CrateDB 5.7) as the preferred SQL template for Grafana queries, since CrateDB 5.7 is already a reasonably old baseline. Using the correct querying scheme and template is critical — as noted by `@hammerhead` — to avoid overloading the cluster or setting the wire and the browser on fire when processing large datasets. This is important knowledge that is not always applied correctly by users and customers. ## Background - `@matriv` flagged the \`DATE_BIN()\` function (recommended by `@seut`) as the modern replacement in [this comment](https://github.com/daq-tools/kotori/pull/148#discussion_r1499035232). - The original discussion about the querying scheme can be found [here](https://github.com/daq-tools/kotori/pull/148#discussion_r1237795785). - `@zolbatar` has volunteered to look into the details of the new \`DATE_BIN()\` variant. ## Tasks - [ ] Validate the \`DATE_BIN()\` SQL template for Grafana with CrateDB (coordinated with `@zolbatar`) - [ ] Update the SQL query in \`application/grafana/example-weather.py\` to use the modern \`DATE_BIN()\` approach - [ ] Add the legacy \`\$__timeGroupAlias\` SQL template to the documentation as a reference for users on older CrateDB versions ## References - PR: https://github.com/crate/cratedb-examples/pull/1442 - Comment: https://github.com/crate/cratedb-examples/pull/1442#discussion_r2943186202 - Requested by: `@amotl` " \ --assignee amotl

Length of output: 53

@amotl, done! I've created issue #1508 to track this improvement:

👉 #1508

"Grafana: Improve SQL template to use DATE_BIN() (CrateDB 5.7+)"

The issue captures:

The motivation for adopting DATE_BIN() as the modern time-series aggregation approach (replacing $__timeGroupAlias + MEAN())

The importance of using the correct querying scheme to avoid overloading clusters

References to the original discussions with @hammerhead, @seut, and @matriv

@zolbatar's involvement in validating the new variant

Tasks for updating example-weather.py and documenting the legacy template for older CrateDB versions

(∩^ω^)⊃━☆ﾟ.*･｡ﾟ

seut · 2026-03-17T09:15:27Z

.github/dependabot.yml

+  - directory: "/application/grafana"
+    package-ecosystem: "docker-compose"
+    schedule:
+      interval: "daily"


Wouldn't weekly be enough? (same for the other jobs)

Suggested change

interval: "daily"

interval: "weekly"

We want to be informed in-time when something goes south, so we can start conversations with upstream authors earlier than later.

seut · 2026-03-17T09:15:52Z

application/grafana/example-weather.py

+                        SELECT
+                            $__timeGroupAlias("timestamp", $__interval),
+                            "location",
+                            MEAN("{column_name}") AS "{column_name}"
+                        FROM "example"."weather_data"
+                        WHERE $__timeFilter("timestamp")
+                        GROUP BY "time", "location"
+                        ORDER BY "time"


Would be great to do that, 5.7 is already a bit old.

amotl force-pushed the grafana branch from bf6f0d7 to 390d437 Compare March 3, 2026 05:13

amotl requested review from matriv and seut March 3, 2026 05:15

amotl marked this pull request as ready for review March 3, 2026 05:17

amotl mentioned this pull request Mar 3, 2026

Add badge for Grafana integration test crate/cratedb-guide#558

Merged

This comment was marked as resolved.

Sign in to view

amotl mentioned this pull request Mar 3, 2026

Fix compatibility with urllib3-future crate/crate-python#784

Merged

amotl commented Mar 3, 2026

View reviewed changes

application/grafana/requirements.txt Outdated Show resolved Hide resolved

amotl commented Mar 3, 2026

View reviewed changes

application/grafana/requirements.txt Outdated Show resolved Hide resolved

amotl force-pushed the grafana branch from 17790d6 to 61e93bb Compare March 3, 2026 08:38

This comment was marked as off-topic.

Sign in to view

amotl mentioned this pull request Mar 3, 2026

expected bytes-like object, not int jawah/urllib3.future#318

Closed

amotl force-pushed the grafana branch from 61e93bb to 09603e7 Compare March 4, 2026 23:14

coderabbitai bot reviewed Mar 4, 2026

View reviewed changes

application/grafana/example-weather.py Show resolved Hide resolved

amotl mentioned this pull request Mar 4, 2026

Nightly image no longer published (last pushed 2 days ago) crate/docker-crate#266

Closed

amotl commented Mar 5, 2026

View reviewed changes

application/grafana/example-weather.py Outdated Show resolved Hide resolved

amotl changed the title ~~Grafana: Weather data example (integration test)~~ Grafana: Basic end-to-end example / integration test Mar 5, 2026

amotl force-pushed the grafana branch 5 times, most recently from c527bfc to d075101 Compare March 9, 2026 08:53

seut reviewed Mar 16, 2026

View reviewed changes

amotl requested a review from seut March 16, 2026 21:45

amotl commented Mar 16, 2026

View reviewed changes

seut reviewed Mar 17, 2026

View reviewed changes

amotl mentioned this pull request Mar 17, 2026

Grafana panel raises convert frame from rows error crate/crate-clients-tools#301

Open

amotl force-pushed the grafana branch from d075101 to 867ca0d Compare March 18, 2026 22:43

amotl mentioned this pull request Mar 18, 2026

grafana-cratedb-source crate/crate-clients-tools#275

Open

amotl added 4 commits March 24, 2026 22:40

Grafana: Weather data example (integration test)

1e2eec6

Grafana: Implement suggestions by CodeRabbit

6504eb8

Grafana: Stop pinning crate-python after new release of urllib3-future

2987b56

Grafana: Use Grafana 12.3 instead of 12.3.4

f93c1cf

amotl force-pushed the grafana branch from 867ca0d to f93c1cf Compare March 24, 2026 21:41

coderabbitai bot mentioned this pull request Mar 24, 2026

Grafana: Improve SQL template to use DATE_BIN() (CrateDB 5.7+) #1508

Open

3 tasks

amotl mentioned this pull request Mar 24, 2026

Grafana: Validate the column name autocompletion feature #1509

Open

amotl merged commit b6b52cd into main Mar 24, 2026
8 checks passed

amotl deleted the grafana branch March 24, 2026 21:47

Conversation

amotl commented Mar 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

About

Review

References

Uh oh!

coderabbitai bot commented Mar 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviews paused

Walkthrough

Changes

Sequence Diagram

Estimated code review effort

Suggested reviewers

Poem

Uh oh!

This comment was marked as resolved.

Uh oh!

Uh oh!

Uh oh!

This comment was marked as off-topic.

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

amotl commented Mar 10, 2026

Uh oh!

seut left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

amotl Mar 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Footnotes

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot Mar 24, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

amotl Mar 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

amotl commented Mar 3, 2026 •

edited

Loading

coderabbitai bot commented Mar 3, 2026 •

edited

Loading

amotl Mar 16, 2026 •

edited

Loading

amotl Mar 17, 2026 •

edited

Loading