Apache Druid can power real-time collection, streaming, and interactive visualization of clickstreams. A common problem in clickstream analytics is counting unique things, like visitors or sessions. Generally this involves scanning through all detail data, because unique counts do not add up as you aggregate the numbers.
Imagine you are interested in the number of visitors that watched episodes of a TV show. Let's say you found that at a given day, 1000 unique visitors watched the first episode, and 800 visitors watched the second episode. You may want to explore further trends, for example:
There is no way to answer these questions by just looking at the aggregated numbers. You would have to go back to the detail data and scan every single row. If the data volume is high enough, this may take a very long time, meaning that an interactive data exploration is not possible.
An additional nuisance is that unique counts don't work well with rollups. For this example, it would be great if you could have just one row of data per 15 minute interval[^1], show, and episode. After all, you are not interested in the individual user IDs, just the unique counts.
[^1]: Why 15 minutes and not just 1 hour? Intervals of 15 minutes work better with international timezones because those are not always aligned by hour. India, for instance, is 30 minutes off, and Nepal is even 45 minutes off. With 15 minute aggregates, you can get hourly sums for any of those timezones, too!
Is there a way to avoid crunching the detail data every single time, and maybe even enable rollup? Enter Theta sketches.
Use Theta sketches to obtain a fast approximate estimate for the distinct count of values used to build the sketches. Theta sketches are a probabilistic data structure to enable approximate analysis of big data with known error distributions. Druid's implementation relies on the Apache DataSketches library.
The following properties describe Theta sketches:
In this tutorial, you will learn how to do the following:
For this tutorial, you should have already downloaded Druid as described in the single-machine quickstart and have it running on your local machine. It will also be helpful to have finished Tutorial: Loading a file and Tutorial: Querying data.
This tutorial works with the following data:
date,uid,show,episode 2022-05-19,alice,Game of Thrones,S1E1 2022-05-19,alice,Game of Thrones,S1E2 2022-05-19,alice,Game of Thrones,S1E1 2022-05-19,bob,Bridgerton,S1E1 2022-05-20,alice,Game of Thrones,S1E1 2022-05-20,carol,Bridgerton,S1E2 2022-05-20,dan,Bridgerton,S1E1 2022-05-21,alice,Game of Thrones,S1E1 2022-05-21,carol,Bridgerton,S1E1 2022-05-21,erin,Game of Thrones,S1E1 2022-05-21,alice,Bridgerton,S1E1 2022-05-22,bob,Game of Thrones,S1E1 2022-05-22,bob,Bridgerton,S1E1 2022-05-22,carol,Bridgerton,S1E2 2022-05-22,bob,Bridgerton,S1E1 2022-05-22,erin,Game of Thrones,S1E1 2022-05-22,erin,Bridgerton,S1E2 2022-05-23,erin,Game of Thrones,S1E1 2022-05-23,alice,Game of Thrones,S1E1
Paste data as the data source and paste the given data:inline and click Apply and Next: Parse data.day.theta_uidthetaSketchuid16384.False.Click Apply to add the new metric to the data model.
You are not interested in individual user ID's, only the unique counts. Right now, uid is still in the data model. To remove it, click on the uid column in the data model and delete it using the trashcan icon on the right:
day.ts_tutorial.On the Edit spec page, your final input spec should match the following:
{ "type": "index_parallel", "spec": { "ioConfig": { "type": "index_parallel", "inputSource": { "type": "inline", "data": "date,uid,show,episode\n2022-05-19,alice,Game of Thrones,S1E1\n2022-05-19,alice,Game of Thrones,S1E2\n2022-05-19,alice,Game of Thrones,S1E1\n2022-05-19,bob,Bridgerton,S1E1\n2022-05-20,alice,Game of Thrones,S1E1\n2022-05-20,carol,Bridgerton,S1E2\n2022-05-20,dan,Bridgerton,S1E1\n2022-05-21,alice,Game of Thrones,S1E1\n2022-05-21,carol,Bridgerton,S1E1\n2022-05-21,erin,Game of Thrones,S1E1\n2022-05-21,alice,Bridgerton,S1E1\n2022-05-22,bob,Game of Thrones,S1E1\n2022-05-22,bob,Bridgerton,S1E1\n2022-05-22,carol,Bridgerton,S1E2\n2022-05-22,bob,Bridgerton,S1E1\n2022-05-22,erin,Game of Thrones,S1E1\n2022-05-22,erin,Bridgerton,S1E2\n2022-05-23,erin,Game of Thrones,S1E1\n2022-05-23,alice,Game of Thrones,S1E1" }, "inputFormat": { "type": "csv", "findColumnsFromHeader": true } }, "tuningConfig": { "type": "index_parallel", "partitionsSpec": { "type": "hashed" }, "forceGuaranteedRollup": true }, "dataSchema": { "dataSource": "ts_tutorial", "timestampSpec": { "column": "date", "format": "auto" }, "dimensionsSpec": { "dimensions": [ "show", "episode" ] }, "granularitySpec": { "queryGranularity": "day", "rollup": true, "segmentGranularity": "day" }, "metricsSpec": [ { "name": "count", "type": "count" }, { "type": "thetaSketch", "name": "theta_uid", "fieldName": "uid" } ] } } }
Notice the theta_uid object in the metricsSpec list, that defines the thetaSketch aggregator on the uid column during ingestion.
Click Submit to start the ingestion.
Calculating a unique count estimate from a Theta sketch column involves the following steps:
DS_THETA aggregator function in Druid SQL.THETA_SKETCH_ESTIMATE function.Between steps 1 and 2, you can apply set functions as demonstrated later in Set operations.
Let's first see what the data looks like in Druid. Run the following SQL statement in the query editor:
SELECT * FROM ts_tutorial
The Theta sketch column theta_uid appears as a Base64-encoded string; behind it is a bitmap.
The following query to compute the distinct counts of user IDs uses APPROX_COUNT_DISTINCT_DS_THETA and groups by the other dimensions:
SELECT __time, "show", "episode", APPROX_COUNT_DISTINCT_DS_THETA(theta_uid) AS users FROM ts_tutorial GROUP BY 1, 2, 3
In the preceding query, APPROX_COUNT_DISTINCT_DS_THETA is equivalent to calling DS_THETA and THETA_SKETCH_ESIMATE as follows:
SELECT __time, "show", "episode", THETA_SKETCH_ESTIMATE(DS_THETA(theta_uid)) AS users FROM ts_tutorial GROUP BY 1, 2, 3
That is, APPROX_COUNT_DISTINCT_DS_THETA applies the following:
DS_THETA: Creates a new Theta sketch from the column of Theta sketchesTHETA_SKETCH_ESTIMATE: Calculates the distinct count estimate from the output of DS_THETADruid has the capability to use filtered metrics. This means you can include a WHERE clause in the SELECT part of the query. :::info In the case of Theta sketches, the filter clause has to be inserted between the aggregator and the estimator. :::
As an example, query the total unique users that watched Bridgerton:
SELECT THETA_SKETCH_ESTIMATE( DS_THETA(theta_uid) FILTER(WHERE "show" = 'Bridgerton') ) AS users FROM ts_tutorial
You can use this capability of filtering in the aggregator, together with set operations, to finally answer the questions from the introduction.
How many users watched both episodes of Bridgerton? Use THETA_SKETCH_INTERSECT to compute the unique count of the intersection of two (or more) segments:
SELECT THETA_SKETCH_ESTIMATE( THETA_SKETCH_INTERSECT( DS_THETA(theta_uid) FILTER(WHERE "show" = 'Bridgerton' AND "episode" = 'S1E1'), DS_THETA(theta_uid) FILTER(WHERE "show" = 'Bridgerton' AND "episode" = 'S1E2') ) ) AS users FROM ts_tutorial
Again, the set function is spliced in between the aggregator and the estimator.
Likewise, use THETA_SKETCH_UNION to find the number of visitors that watched any of the episodes:
SELECT THETA_SKETCH_ESTIMATE( THETA_SKETCH_UNION( DS_THETA(theta_uid) FILTER(WHERE "show" = 'Bridgerton' AND "episode" = 'S1E1'), DS_THETA(theta_uid) FILTER(WHERE "show" = 'Bridgerton' AND "episode" = 'S1E2') ) ) AS users FROM ts_tutorial
And finally, there is THETA_SKETCH_NOT which computes the set difference of two or more segments. The result describes how many visitors watched episode 1 of Bridgerton but not episode 2.
SELECT THETA_SKETCH_ESTIMATE( THETA_SKETCH_NOT( DS_THETA(theta_uid) FILTER(WHERE "show" = 'Bridgerton' AND "episode" = 'S1E1'), DS_THETA(theta_uid) FILTER(WHERE "show" = 'Bridgerton' AND "episode" = 'S1E2') ) ) AS users FROM ts_tutorial
See the following topics for more information:
This tutorial is adapted from a blog post by community member Hellmar Becker.