Skip to main content

Loading Google Analytics Data to Databricks using Python dlt Library

Need help deploying these pipelines, or figuring out how to run them in your data stack?

Join our Slack community or book a call with our support engineer Violetta.

This documentation provides a guide on how to leverage the dlt Python library to load data from Google Analytics into Databricks. Google Analytics is a robust platform that gathers data from your websites and apps, generating insightful reports for your business. On the other hand, Databricks is a unified data analytics platform, designed by the original creators of Apache Spark™, that enhances innovation by integrating data science, engineering, and business. By using dlt, an open-source Python library, you can facilitate the data transfer from Google Analytics to Databricks, allowing for seamless data analysis and insights generation. For more information on Google Analytics, visit https://analytics.google.com.

dlt Key Features

  • Google Analytics: A verified source in dlt that loads data from Google Analytics API to your chosen destination. Read More
  • Governance Support in dlt Pipelines: dlt pipelines offer robust governance support through pipeline metadata utilization, schema enforcement and curation, and schema change alerts. Read More
  • Databricks Destination: dlt supports Databricks as a destination for your data pipeline. The guide provides a detailed setup process for your Databricks workspace. Read More
  • Extracting Data with dlt: dlt simplifies data extraction by leveraging iterators, chunking, and parallelization techniques, and utilizing implicit extraction Directed Acyclic Graphs (DAGs). Read More
  • After Loading: dlt provides several options for transformations after loading the data, including using dbt, the dlt SQL client, or Pandas. Read More

Getting started with your pipeline locally

0. Prerequisites

dlt requires Python 3.8 or higher. Additionally, you need to have the pip package manager installed, and we recommend using a virtual environment to manage your dependencies. You can learn more about preparing your computer for dlt in our installation reference.

1. Install dlt

First you need to install the dlt library with the correct extras for Databricks:

pip install "dlt[databricks]"

The dlt cli has a useful command to get you started with any combination of source and destination. For this example, we want to load data from Google Analytics to Databricks. You can run the following commands to create a starting point for loading data from Google Analytics to Databricks:

# create a new directory
mkdir google_analytics_pipeline
cd google_analytics_pipeline
# initialize a new pipeline with your source and destination
dlt init google_analytics databricks
# install the required dependencies
pip install -r requirements.txt

The last command will install the required dependencies for your pipeline. The dependencies are listed in the requirements.txt:


google-analytics-data
google-api-python-client
google-auth-oauthlib
requests_oauthlib
dlt[databricks]>=0.3.25

You now have the following folder structure in your project:

google_analytics_pipeline/
├── .dlt/
│ ├── config.toml # configs for your pipeline
│ └── secrets.toml # secrets for your pipeline
├── google_analytics/ # folder with source specific files
│ └── ...
├── google_analytics_pipeline.py # your main pipeline script
├── requirements.txt # dependencies for your pipeline
└── .gitignore # ignore files for git (not required)

2. Configuring your source and destination credentials

The dlt cli will have created a .dlt directory in your project folder. This directory contains a config.toml file and a secrets.toml file that you can use to configure your pipeline. The automatically created version of these files look like this:

generated config.toml

# put your configuration values here

[runtime]
log_level="WARNING" # the system log level of dlt
# use the dlthub_telemetry setting to enable/disable anonymous usage data reporting, see https://dlthub.com/docs/telemetry
dlthub_telemetry = true

[sources.google_analytics]
property_id = 0 # please set me up!
queries =
["a", "b", "c"] # please set me up!

generated secrets.toml

# put your secret values and credentials here. do not share this file and do not push it to github

[sources.google_analytics.credentials]
client_id = "client_id" # please set me up!
client_secret = "client_secret" # please set me up!
refresh_token = "refresh_token" # please set me up!
project_id = "project_id" # please set me up!

[destination.databricks.credentials]
catalog = "catalog" # please set me up!
server_hostname = "server_hostname" # please set me up!
http_path = "http_path" # please set me up!
access_token = "access_token" # please set me up!

2.1. Adjust the generated code to your usecase

Further help setting up your source and destinations
  • Read more about setting up the Google Analytics source in our docs.
  • Read more about setting up the Databricks destination in our docs.

3. Running your pipeline for the first time

The dlt cli has also created a main pipeline script for you at google_analytics_pipeline.py, as well as a folder google_analytics that contains additional python files for your source. These files are your local copies which you can modify to fit your needs. In some cases you may find that you only need to do small changes to your pipelines or add some configurations, in other cases these files can serve as a working starting point for your code, but will need to be adjusted to do what you need them to do.

The main pipeline script will look something like this:


""" Loads the pipeline for Google Analytics V4. """

import time
from typing import Any

import dlt

from google_analytics import google_analytics

# this can also be filled in config.toml and be left empty as a parameter.
QUERIES = [
{
"resource_name": "sample_analytics_data1",
"dimensions": ["browser", "city"],
"metrics": ["totalUsers", "transactions"],
},
{
"resource_name": "sample_analytics_data2",
"dimensions": ["browser", "city", "dateHour"],
"metrics": ["totalUsers"],
},
]


def simple_load() -> Any:
"""
Just loads the data normally. Incremental loading for this pipeline is on,
the last load time is saved in dlt_state, and the next load of the pipeline will have the last load as a starting date.

Returns:
Load info on the pipeline that has been run.
"""
# FULL PIPELINE RUN
pipeline = dlt.pipeline(
pipeline_name="dlt_google_analytics_pipeline",
destination='databricks',
full_refresh=False,
dataset_name="sample_analytics_data",
)
# Google Analytics source function - taking data from QUERIES defined locally instead of config
# TODO: pass your google analytics property id as google_analytics(property_id=123,..)
data_analytics = google_analytics(queries=QUERIES)
info = pipeline.run(data=data_analytics)
print(info)
return info


def simple_load_config() -> Any:
"""
Just loads the data normally. QUERIES are taken from config. Incremental loading for this pipeline is on,
the last load time is saved in dlt_state, and the next load of the pipeline will have the last load as a starting date.

Returns:
Load info on the pipeline that has been run.
"""
# FULL PIPELINE RUN
pipeline = dlt.pipeline(
pipeline_name="dlt_google_analytics_pipeline",
destination='databricks',
full_refresh=False,
dataset_name="sample_analytics_data",
)
# Google Analytics source function - taking data from QUERIES defined locally instead of config
data_analytics = google_analytics()
info = pipeline.run(data=data_analytics)
print(info)
return info


def chose_date_first_load(start_date: str = "2000-01-01") -> Any:
"""
Chooses the starting date for the first pipeline load. Subsequent loads of the pipeline will be from the last loaded date.

Args:
start_date: The string version of the date in the format yyyy-mm-dd and some other values.
More info: https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/DateRange

Returns:
Load info on the pipeline that has been run.
"""
# FULL PIPELINE RUN
pipeline = dlt.pipeline(
pipeline_name="dlt_google_analytics_pipeline",
destination='databricks',
full_refresh=False,
dataset_name="sample_analytics_data",
)
# Google Analytics source function
data_analytics = google_analytics(start_date=start_date)
info = pipeline.run(data=data_analytics)
print(info)
return info


if __name__ == "__main__":
start_time = time.time()
simple_load()
end_time = time.time()
print(f"Time taken: {end_time-start_time}")

Provided you have set up your credentials, you can run your pipeline like a regular python script with the following command:

python google_analytics_pipeline.py

4. Inspecting your load result

You can now inspect the state of your pipeline with the dlt cli:

dlt pipeline dlt_google_analytics_pipeline info

You can also use streamlit to inspect the contents of your Databricks destination for this:

# install streamlit
pip install streamlit
# run the streamlit app for your pipeline with the dlt cli:
dlt pipeline dlt_google_analytics_pipeline show

5. Next steps to get your pipeline running in production

One of the beauties of dlt is, that we are just a plain Python library, so you can run your pipeline in any environment that supports Python >= 3.8. We have a couple of helpers and guides in our docs to get you there:

The Deploy section will show you how to deploy your pipeline to

  • Deploy with Github Actions: dlt supports deployment with Github Actions. This allows you to automate your data pipelines and schedule them to run at specific times. To learn more, check out the guide on how to deploy a pipeline with Github Actions.
  • Deploy with Airflow: Airflow is a popular tool for orchestrating complex computational workflows and data processing pipelines. dlt provides support for deploying your data pipelines with Airflow. Learn more about how to deploy a pipeline with Airflow.
  • Deploy with Google Cloud Functions: Google Cloud Functions is a serverless execution environment for building and connecting cloud services. dlt can be deployed with Google Cloud Functions to run your data pipelines. Read the guide on how to deploy a pipeline with Google Cloud Functions to learn more.
  • Other Deployment Options: Apart from the above, dlt supports various other deployment options. You can explore all the available options for deploying your data pipelines in the deployment guide.

The running in production section will teach you about:

  • Monitor Your Pipeline: dlt provides robust tools to monitor your pipeline, ensuring it's running smoothly and efficiently. You can keep track of your pipeline's performance and troubleshoot any issues that arise. Learn how to monitor your pipeline here.
  • Set Up Alerts: Stay informed about your pipeline's status with dlt's alerting capabilities. You can set up alerts to notify you of any issues or changes in your pipeline, allowing you to address them promptly. Get started with setting up alerts here.
  • Implement Tracing: dlt enables tracing to help you understand the flow of data through your pipeline. This can be crucial for debugging and optimizing your pipeline. Learn how to set up tracing here.

Additional pipeline guides

This demo works on codespaces. Codespaces is a development environment available for free to anyone with a Github account. You'll be asked to fork the demo repository and from there the README guides you with further steps.
The demo uses the Continue VSCode extension.

Off to codespaces!

DHelp

Ask a question

Welcome to "Codex Central", your next-gen help center, driven by OpenAI's GPT-4 model. It's more than just a forum or a FAQ hub – it's a dynamic knowledge base where coders can find AI-assisted solutions to their pressing problems. With GPT-4's powerful comprehension and predictive abilities, Codex Central provides instantaneous issue resolution, insightful debugging, and personalized guidance. Get your code running smoothly with the unparalleled support at Codex Central - coding help reimagined with AI prowess.