Changelog

4.15.0

Features

• Add LogsSample supplemental query, remove deprecated getDataProvider (#1744)
• Add Grafana query metadata support (#1743)
• Allow disabling logs and trace links (#1754)
• Improve query modification (#1738)
• Add initial support for SQL abstractions (dsAbstraction) (#1756)
• Add OpenTelemetry instrumentation (#1734)
• Add field config to trace search results for better default display (#1733)
• Add filterQuery method to datasource (#1732)
• Support grouping orderBy columns by their column hint values (#1695)
• Bump Grafana minimum version to v11.6.0 (#1753)

Fixes

• Fix log context field returning labels (#1737)
• Fix additional settings config bug (#1630)
• Dependency updates

4.14.1

Features

• Extract Map value type for mapKey filter in getFilters (#1694)

Fixes

• Dependency updates

4.14.0

Features

• Add FilterTime hint to enable multi-timestamp log filtering/sorting (#1642)
• Skip OTel trace time range optimization when trace timestamp table does not exist (#1663)

Fixes

• Dependency updates
• Add separate columns for Resource/Scope/Log Attributes (#1560)
• Fix panic when configuring datasource with numeric timeout values (#1559)

4.13.0

Features

• Support for hiding table names in ad-hoc filters (#1493)
• Allow manual placement of ad-hoc filters (#1488)
• Add support for Nullable(Enum8/16) column types (#1523)
• Add dashboard variable to control AdHoc filter syntax (#1464)

Fixes

• Fix generating query with column names containing colons (#1538)
• Update config HTTPS language (#1537)
• Dependency updates

4.12.0

Features

• Support log volume queries for the SQL editor. Note that this will only work for Grafana versions >= 12.4.0 (#1475)
• Support columns with . in ad-hoc filters (#1481)

Fixes

• Dependency updates

4.11.4

Fixes

• Fix view logs link in Explore and Dashboards (#1462)
• Fix filter for map type LogLabels (#1456)
• Temporarily disable slow JSON suggestions function (#1468)
• Dependency updates

4.11.3

Fixes

• Fix config UI bugs (#1409) and update design (#1422)
• Dependency updates

4.11.2

Features

• Second part of redesigned ClickHouse config page (behind newClickhouseConfigPageDesign) (#1387)

Fixes

• Improved error classification to mark all ClickHouse errors as downstream errors, including errors wrapped in HTTP response bodies and multi-error chains (#1405)
• Dependency updates

4.11.1

Fixes

• All Clickhouse errors are marked as downstream errors for Grafana (#1378)

4.11.0

Features

• Merge OpenTelemetry resource/scope/log attributes into a unified Labels column in Logs (#1369)
• First part of redesigned ClickHouse config page with sidebar navigation and collapsible sections (behind newClickhouseConfigPageDesign) (#1370)

Fixes

• Fix ad-hoc filter application with templated target tables (#1241)
• Fix column sorting by formatting bytes in Grafana (#1352)
• Fix events and links not displaying correctly for table view queries (#1345)
• Dependency updates

4.10.2

Fixes

• Fix Ad-Hoc filters for variable datasources #1330
• Fix switching between SQL Editor and Query Builder #1337
• Fix large JSON objects + complex JSON types #1326
• Configuration fixes related to row limit implementation #1294
• Fix bug where switched to logs query type errored #1341
• Dependency updates

4.10.1

Fixes

• Bump grafana/plugin-actions from ff169fa386880e34ca85a49414e5a0ff84c3f7ad to b788be6746403ff9bae26d5e800794f2a5620b4c (#1286)
• Bump cspell from 9.0.2 to 9.1.1 (#1278)

4.10.0

Features

• Ad-hoc queries: Allow to filter by values inside the map (#1265)

Fixes

• Fix ad-hoc filter application with templated target tables (#1241)
• Dependency updates

4.9.1

Fixes

• Error logging fix

4.9.0

Features

• Add support for the Grafana row_limit configuration setting.
• Add support for kind, status, instrumentation library, links, events and state data for traces (#1043, #1208)
• Cancel JSON paths query after 10s (#1206)
• SQL Editor now suggests database, table, column, and function names while typing (#1204)
• Add SQL Formatter button + shortcut for making long queries more readable in the editor (#1205)

Fixes

• Fixed "run query" shortcut from running stale query (#1205)
• Dependency updates

4.8.2

Fixes

• Dependency updates

4.8.1

Fixes

• Dependency updates

4.8.0

Features

• Enable CtrlCmd + Enter keyboard shortcut to Run Query (#1158)

Fixes

• Refactor MutateResponse function and PDC dialler creation (#1155)
• Refactor clickhouse.Connect to improve context cancellation handling (#1154)
• Prevent usage of failed connections and improve connection management (#1156). Please note that following this change, the following limits will be set. Although we believe these limits are reasonable, you can adjust them in the datasource settings if needed:
  • MaxOpenConns to 50.
  • MaxIdleConns to 25.
  • ConnMaxLifetime to 5 minutes.
• Dependency updates

4.7.0

Features

• Add JSON column sub-paths to column selection in query builder
• Added events support in trace detail view.(https://github.com/grafana/clickhouse-datasource/pull/1128)

4.6.0

Features

• Add support for new Variant, Dynamic, and JSON types (https://github.com/grafana/clickhouse-datasource/pull/1108)

Fixes

• Optimized performance for log volumes processing using ClickHouse multiSearchAny

4.5.1

Fixes

• Dependency updates

4.5.0

Features

• Implemented log context for log queries
• Added configuration options for log context columns
• Queries parsed from the SQL editor will now attempt to re-map columns into their correct fields for Log and Trace queries.
• Added support for IN operator in adhoc filters

Fixes

• Fixed and enhanced the logic for parsing a query back into the query builder.

4.4.0

Features

• Added "Labels" column selector to the log query builder
• Datasource OTel configuration will now set default table names for logs and traces.

Fixes

• Added warning for when uid is missing in provisioned datasources.
• Map filters in the query builder now correctly show the key instead of the column name
• Updated and fixed missing system.dashboards dashboard in list of dashboards
• Updated the duration value in example traces dashboard to provide useful information
• Fix to display status codes from spans in trace queries (#950)

4.3.2

Fixes

• Optimized performance for types dependent on the JSON converter
• Dependency updates

4.3.1

Features

• Added preset dashboard from system.dashboards table

Fixes

• Fix trace start times in trace ID mode (#900)
• Fixed OTel dashboard that waa failing to import (#908)

4.3.0

Features

• Added OpenTelemetry dashboard (#884)

Fixes

• Fix support for LowCardinality strings (#857)
• Update trace queries to better handle time fields (#890)
• Dependency bumps

4.2.0

Features

• Added $__dateTimeFilter() macro for conveniently filtering a PRIMARY KEY composed of Date and DateTime columns.

4.1.0

Features

• Added the ability to define column alias tables in the config, which simplifies query syntax for tables with a known schema.

4.0.8

Fixes

• Fixed IN operator escaping the entire string (specifically with Nullable(String)), also added FixedString(N) (#830)
• Fixed query builder filter editor on alert rules page (#828)

4.0.7

• Upgrade dependencies

4.0.6

Fixes

• Add support for configuring proxy options from context rather than environment variables (supported by updating sqlds) (#799)

4.0.5

Fixes

• Fixed converter regex for Nullable(IP) and Nullable(String). It won't match to Array(Nullable(IP)) or Array(Nullable(String)) any more. (#783)
• Updated grafana-plugin-sdk-go to fix a PDC issue. More details here (#790)

4.0.4

Fixes

• Changed trace timestamp table from the constant otel_traces_trace_id_ts to a suffix _trace_id_ts applied to the current table name.

4.0.3

Features

• Added $__fromTime_ms macro that represents the dashboard "from" time in milliseconds using a DateTime64(3)
• Added $__toTime_ms macro that represents the dashboard "to" time in milliseconds using a DateTime64(3)
• Added $__timeFilter_ms macro that uses DateTime64(3) for millisecond precision time filtering
• Re-added query type selector in dashboard view. This was only visible in explore view, but somehow it affects dashboard view, and so it has been re-added. (#730)
• When OTel is enabled, Trace ID queries now use a skip index to optimize exact ID lookups on large trace datasets (#724)

Fixes

• Fixed performance issues caused by $__timeFilter using a DateTime64(3) instead of DateTime (#699)
• Fixed trace queries from rounding span durations under 1ms to 0 (#720)
• Fixed AST error when including Grafana macros/variables in SQL (#714)
• Fixed empty builder options when switching from SQL Editor back to Query Editor
• Fix SQL Generator including "undefined" in FROM when database isn't defined
• Allow adding spaces in multi filters (such as WHERE .. IN)
• Fixed missing AND keyword when adding a filter to a Trace ID query

4.0.2

Fixes

• Fixed migration script not running when opening an existing v3 config

4.0.1

Fixes

• Set protocol to native by default in config view. Fixes the "default port" description.

4.0.0

Features

Version 4.0.0 contains major revisions to the query builder and datasource configuration settings.

Query Builder

• Completely rebuilt query builder to have specialized editors for Table, Logs, Time Series, and Traces.
• Completely rebuilt SQL generator to support more complicated and dynamic queries.
• Updated query builder options structure to be clearer and support more complex queries.
• Updated database/table selector to be in a more convenient location. Database and table options are automatically selected on initial load.
• Upgraded query builder state management so queries stay consistent when saving/editing/sharing queries.
• Separated Table and Time Series query builders. Table view operates as a catch-all for queries that don't fit the other query types.
• Combined "format" into the query type switcher for simplicity. The query tab now changes the builder view and the display format when on the Explore page. This includes the raw SQL editor.
• Added an OTEL switch for logs and trace views. This will allow for quicker query building for those using the OTEL exporter for ClickHouse.
• Updated Time Series query builder with dedicated Time column. Default filters are added on-load.
• Added an IS ANYTHING filter that acts as a placeholder for easily editing later (useful for query templates/bookmarks on the Explore page.)
• Added better support for Map types on the Filter editor.
• LIMIT editor can now be set to 0 to be excluded from the query.
• Table and Time Series views now have a simple / aggregate mode, depending on the query complexity.
• Updated the logs histogram query to use the new query builder options and column hints.
• Added Logs query builder with dedicated Time, Level, and Message columns. Includes OTEL switch for automatically loading OTEL schema columns. Default filters are added on-load.
• Added Trace query builder with dedicated trace columns. Includes OTEL switch for automatically loading OTEL schema columns. Default filters are added on-load.
• Updated data panel filtering to append filters with column hints. Visible in logs view when filtering by a specific level. Instead of referencing a column by name, it will use its hint.
• Order By now lists aggregates by their full name + alias.
• Order By column allows for custom value to be typed in.
• Aggregate column name allows for custom value to be typed in.
• Filter editor allows for custom column names to be typed in.
• Increased width of filter value text input.
• Columns with the Map* type now show a [] at the end to indicate they are complex types. For example, SpanAttributes[].
• Filter editor now has a dedicated field for map key. You can now select a map column and its key separately. For example, SpanAttributes['key'].
• Map types now load a sample of options when editing the key for the map. This doesn't include all unique values, but for most datasets it should be a convenience.
• Added column hints, which offers better linking across query components when working with columns and filters. For example, a filter can be added for the Time column, even without knowing what the time column name is yet. This enables better SQL generation that is "aware" of a column's intended use.

Plugin Backend

• Added migration logic for v3 configs going to v4+. This is applied when the config is loaded when building a database connection.
• $__timeFilter, $__fromTime, and $__toTime macros now convert to DateTime64(3) for better server-side type conversion. Also enables millisecond precision time range filtering.

Datasource Configuration

• Added migration script for v3.x configurations to v4+. This runs automatically when opening/saving the datasource configuration.
• Renamed config value server to host.
• Renamed config value timeout to the more specific dial_timeout.
• Updated labeling for port selection. The default port will now change depending on native/http and secure/unsecure setting.
• Rearranged fields and sections to flow better for initial setup of a new datasource.
• Added plugin version to config data for easier config version migrations in the future.
• Added fields for setting default values for database/table.
• Added section for setting default log database/table/columns. Includes OTEL. These are used when using the log query builder.
• Added section for setting default trace database/table/columns. Includes OTEL. These are used when using the trace query builder.
• Added OTEL switches for logs/traces for quicker query building. OTEL defaults to the latest version, and will auto update if kept on this setting.
• Increased width of inputs for typically long values (server URL, path, etc.)
• Allow adding custom HTTP headers with either plain text or secure credentials. #633
• Add path setting to specify an additional URL path when using the HTTP protocol. #512

Fixes

• Queries will now remain consistent when reloading/editing a previously saved query.
• Fixed default Ad-Hoc filters. #650
• Fixed Ad-Hoc filters parsing numeric fields. #629
• Fixed majority of usability quirks with redesigned query builder.

Upgrades

• Updated all dependencies to latest compatible versions (Includes Dependabot PRs)

3.3.0

Features

• Support Point geo data type.

Fixes

• Fix timeInterval_ms macro.
• Fix Table summary and Parts over time panels in Data Analysis dashboard.

Upgrades

• Upgrade grafana-plugin-sdk-go.

3.2.0

Features

• Add timeInterval_ms macro to allow higher precision queries on DateTime64 columns. #462.

Fixes

• Ensure databases, tables, and columns are escaped correctly. #460.
• Fix conditionAll handling. #459.
• Fix support for ad-hoc regexp filters: =~, !~ #414.
• Do not create malformed adhoc filters #451. invalid values will be ignored.
• Fix auto formatting by reverting to table correctly. #469.
• Fix parsing of numeric configuration values in yaml file. #456.

3.1.0

• Stable release of v3.0.4-beta

3.0.4-beta

• Update Grafana dependencies to >=v9.0.0
• Feature - Add support for the secure socks proxy

3.0.3-beta

• Update ClickHouse driver to v2.9.2

3.0.2-beta

• Custom ClickHouse settings can be set in data source settings. Allow passing custom ClickHouse settings in datasource
• Histogram UI fixes Histogram UI fixes
  • Support filter/filter out logs view actions
  • Fix undefined database name by default
  • Reset level and time field properly on table/database change
  • Make it possible to clear the level field (so the histogram will render without grouping by level)
  • Fix filter value that gets stuck in the UI
• Tracing dashboard added to default dashboards. Tracing dashboard

3.0.1-beta

• Users on v8.x of Grafana are encouraged to continue to use v2.2.0 of the plugin.
• Users of Grafana v9.x can use v3 however it is beta and may contain bugs.

3.0.0

• Feature - Logs volume histogram support
• Chore - Update clickhouse-go to v2.8.1

2.2.1

• Chore - Backend binaries compiled with latest go version 1.20.4
• Custom ClickHouse settings can be set in data source settings. Allow passing custom ClickHouse settings in datasource
• Standard Golang HTTP proxy environment variables support (HTTP_PROXY/HTTPS_PROXY/NO_PROXY). See FromEnvironment for more information. If the Grafana instance is started with one of these env variables, the driver will automatically load them now.

2.2.0

• Feature - Support format dropdown and support for rendering traces

2.1.1

• Fix - Date and Date32 type normalization with user's timezone

2.1.0

• Fix - Quote table names with dots by @slvrtrn in https://github.com/grafana/clickhouse-datasource/pull/298
• Add a predefined TimeRange filter if there is at least one DateTime* column by @slvrtrn in https://github.com/grafana/clickhouse-datasource/pull/304

2.0.7

• Fix - Empty template variables used with the conditionalAll macro work the same as selecting All. Allow empty Inputs for $__conditionalAll
• Fix - Intervals are limited to 1 second. limit $__interval_s to at least 1 second
• Chore - Bump ClickHouse go API to v2.5.1 Bump github.com/ClickHouse/clickhouse-go/v2 from 2.4.3 to 2.5.1

2.0.6

• Chore - Backend binaries compiled with latest go version 1.19.4
• Chore - Backend grafana dependencies updated to latest version
• Chore - Clickhouse-go client updated to v2.4.3

2.0.5

• Chore - Update sqlds to 2.3.17 which fixes complex macro queries
• Chore - Backend grafana dependency updated
• Fix - Allow default protocol toggle value when saving in settings

2.0.4

• Fix - Query builder: allow custom filter values for fields with Map type

2.0.3

• Chore - Backend binaries compiled with latest go version 1.19.3
• Chore - Backend grafana dependencies updated

2.0.2

• Feature - Update sqlds to 2.3.13 which fixes some macro queries

2.0.1

• Bug - Now works with Safari. Safari does not support regex look aheads

2.0.0

• Feature - Upgrade driver to support HTTP
• Feature - Changed how ad hoc filters work with a settings option provided in CH 22.7
• Feature - Conditional alls are now handled with a conditional all function. The function checks if the second parameter is a template var set to all, if it then replaces the function with 1=1, and if not set the function to the first parameter.
• Bug - Visual query builder can use any date type for time field
• Fix - 'any' is now an aggregation type in the visual query builder
• Fix - Time filter macros can be used in the adhoc query
• Bug - Time interval macro cannot have an interval of 0
• Fix - Update drive to v2.1.0
• Bug - Expand query button works with grafana 8.0+
• Fix - Added adhoc columns macro

1.1.2

• Bug - Add timerange to metricFindQuery

1.1.1

• Bug - Add timeout

1.1.0

• Feature - Add convention for showing logs panel in Explore

1.0.0

• Official release

0.12.7

• Fix - Ignore template vars when validating sql

0.12.6

• Fix - Time series builder - use time alias when grouping/ordering

0.12.5

• Chore - Dashboards

0.12.4

• Fix - timeseries where clause. make default db the default in visual editor

0.12.3

• Fix - When removing conditional all, check scoped vars (support repeating panels)

0.12.2

• Fix - When removing conditional all, only remove lines with variables

0.12.1

• Fix - Handle large decimals properly

0.12.0

• Feature - Time series builder: use $__timeInterval macro on time field so buckets can be adjusted from query options.

0.11.0

• Feature - Time series: Hide fields, use group by in select, use time field in group by

0.10.0

• Feature - Ad-Hoc sourced by database or table

0.9.13

• Fix - Update sdk to show streaming errors

0.9.12

• Fix - Format check after ast change

0.9.11

• Feature - $timeInterval(column) and $interval_s macros

0.9.10

• Fix - Set format when using the new Run Query button.

0.9.9

• Feature - Query Builder.

0.9.8

• Fix - Detect Multi-line time series. Handle cases with functions.

0.9.7

• Feature - Multi-line time series.

0.9.6

• Bug - Change time template variable names.

0.9.5

• Bug - Fix global template variables.

0.9.4

• Bug - Fix query type variables.

0.9.3

• Bug - Support Array data types.

0.9.2

• Bug - Fix TLS model.

0.9.1

• Feature - Add secure toggle to config editor.

0.9.0

• Initial Beta release.