Skip to content

Latest commit

 

History

History
212 lines (130 loc) · 7.64 KB

README.md

File metadata and controls

212 lines (130 loc) · 7.64 KB
Raw

Taking off with Materialize, Redpanda and dbt

This is a sample project with enough plumbing to spin up an end-to-end analytics pipeline using Materialize, Redpanda and dbt to explore real-time data.

Setup

demo_overview

The project uses Docker Compose to make it easier to bundle up all the services in the pipeline:

  • Data generator

    Finding streaming data to play with isn't always a breeze, so we wired up a data generator that polls the OpenSky Network API continuously to save you some time! For details like poll frequency and message schema, or just a template to create a message producer for a different source of data, check the data-generator directory.

  • Redpanda

    The data generator produces JSON-formatted events with flight information into the flight_information Redpanda topic. You can think of Redpanda as your source of truth, the system that stores and distributes your business-critical data downstream.

  • Materialize

    Materialize is set up to consume streaming flight information from Redpanda, as well as static aircraft reference data from a JSON file. Any sources and transformations are defined through dbt! We've also included mzcli (a psql-like SQL client) in the setup, so you can easily connect to the running Materialize instance.

  • dbt

    dbt acts as the SQL transformation layer in the setup, and is bootstrapped with some examples and templates to get you going. Using the dbt-materialize adapter, you can build and run models to transform the streaming source data in real time.

  • Metabase

    There are different ways to push data out of Materialize. Here, we included Metabase, a neat BI tool that lets you visualize the ever-updating results of your transformations in a dashboard!

Installation

To get started, make sure you have installed:

We recommend running Docker with at least 2 CPUs and 8GB of memory, so double check your resource preferences before moving on!

Getting the setup up and running

🖐️ Warning for M1 Mac users: some of the tools used in this project don't provide multi-architecture Docker images just yet, so you need to run an extra initial step to set the variables that determine the right images to fetch for arm64. Don't skip this step!

If you're on a M1 Mac, first run:

export ARCH=linux/arm64 MIMG=iwalucas

To get the setup up and running:

# Start the setup
docker-compose up -d

# Check if everything is up and running!
docker-compose ps

At any point, you can stop the data generator using:

docker stop data-generator

Once you're done playing with the setup, tear it down:

docker-compose down -v

Redpanda

Check the source data

To tap into and manage Redpanda, you can use the rpk CLI. For example, to check that the topic has been created, run:

docker-compose exec redpanda rpk topic list

and that there's data landing from the data-generator:

docker-compose exec redpanda rpk topic consume flight_information

To exit the consumer, press Ctrl+C.

dbt

If this is your first time trying out dbt with Materialize, our dbt + Materialize guide should give you a good overview of the basic concepts and supported materializations.

Get in that shell!

To access the dbt CLI, run:

docker exec -it dbt /bin/bash

From here, you can run dbt commands as usual. For example, to check that the dbt-materialize plugin has been installed, and that everything is working:

dbt --version

dbt debug

Build and run your models

Note: any changes you make to the /dbt directory locally, like adding new models, will be shipped to the container automatically.

We've created a few core models that take care of defining sources in Materialize:

  • rp_flight_information.sql

  • icao_mapping.sql

, as well as some staging views to transform the source data:

  • stg_flight_information.sql

  • stg_icao_mapping.sql

To (optionally) install the materialize-dbt-utils package and run the models:

dbt deps

dbt run

The first time you run a dbt model on top of Materialize…well, you never have to run it again! No matter how much or how frequently your data arrives, your models will stay up-to-date without manual or configured refreshes.

Generate documentation

To generate documentation for your project and bring up the website, run:

dbt docs generate

dbt docs serve

The documentation website should be available at: http://localhost:8000/

Materialize

If you're completely new to Materialize, you can refer to our getting started guide for a quick rundown.

Inspect the database

To connect to the running Materialize service, you can use any compatible CLI. Let's roll with mzcli, which is included in the setup:

docker-compose run mzcli
SHOW SOURCES;

         name
-----------------------
 icao_mapping
 rp_flight_information
SHOW VIEWS;

          name
------------------------
 fct_flight
 stg_flight_information
 stg_icao_mapping

You'll notice that you're only able to SELECT from fct_flight — this is because it is the only materialized view! This view is incrementally updated as new data streams in, so you get fresh and correct results with low latency. Behind the scenes, Materialize is indexing the results of the embedded query in memory.

Metabase

To visualize the results in Metabase:

1. In a browser, navigate to http://localhost:3030/.

2. Click Let's get started.

3. Complete the first set of fields asking for your email address. This information isn't crucial for anything but has to be filled in.

4. On the Add your data page, specify the connection properties for the Materialize database:

Field Value
Database PostgreSQL
Name opensky
Host materialized
Port 6875
Database name materialize
Database username materialize
Database password Leave empty

5. Click Ask a question -> Native query.

6. Under Select a database, choose opensky.

7. In the query editor, enter a query and hit Save. You need to do this for each visualization you’re planning to add to the dashboard that Metabase prompts you to create.

8. Once you have a dashboard set up, you can manually set the refresh rate to 1 second by adding #refresh=1 to the end of the URL and opening the modified URL in a new tab.