GuidesAPI ReferenceDiscussions

Tracking PySpark

How to gain visibility into your code errors, metrics, and logging information in PySpark jobs.

If you are running jobs in PySpark, Databand can provide visibility into your code errors, metrics, and logging information, in the context of your broader pipelines or orchestration system.

Like for Python, you can use Databand decorators and the logging API for Spark jobs in a similar way. Here is an example of a PySpark function with Databand decoration and metrics' logging:

import sys
from operator import add
from pyspark.sql import SparkSession
import logging
from dbnd import log_metric, task

logger = logging.getLogger(__name__)

def calculate_counts(input_file, output_file):
    spark = SparkSession.builder.appName("PythonWordCount").getOrCreate()

    lines = r: r[0])
    counts = (
        lines.flatMap(lambda x: x.split(" ")).map(lambda x: (x, 1)).reduceByKey(add)
    output = counts.collect()
    for (word, count) in output:
        print("%s: %i" % (word, count))
    log_metric("counts", len(output))
        "Log message from EMR cluster"

if __name__ == "__main__":
    calculate_counts(sys.argv[1], sys.argv[2])

In this code example, there are a number of artifacts that will be reported to the DBND tracking system.

The first one is the output of the following Python snippet:

for (word, count) in output: print("%s: %i" % (word, count))

The second is Databand's log_metric API, which reports a count. When you use Python logging facilities, for example - (line below the log_metric API in the code), all logs are also reported.

Databand will correlate the tracking metrics from the Spark job with the associated pipeline from your orchestration system (for example, an Airflow DAG) based on the user design.

You can run this script in the following way:

# enable explicit tracking for @task code
export DBND__TRACKING=True

# make sure you have your login information, this way or another

spark-submit --conf "spark.env.DBND__RUN__NAME=my_run_name" <path/to/input_file> <path/to/output_file>

Tracking Dataframes

You can use the dataset logging API to track Spark DataFrame as described in Tracking Datasets.

Integrating with Databand Listener.

Your PySpark script can benefit from automatic tracking of DatasetOperations. Please see detailed information at JVM SDK Configuration.

# Please export all relevant environment variables here.

spark-submit --driver-java-options "-javaagent:/PATH_TO_AGENT" --conf "spark.sql.queryExecutionListeners=ai.databand.spark.DbndSparkQueryExecutionListener"  \
    <path/to/input_file> <path/to/output_file>

Integrating with PyDeequ for Data Quality Metrics

Databand can collect and send PyDeequ metrics.

Please follow up on this installation guide
Make sure that DBND JVM client is part of your spark application including ai.databand:dbnd-api-deequ package Installing JVM DBND Library and Agent

DBND Python Deequ Metrics Repository

In order to connect Databand to Deequ use DbndDeequMetricsRepository as in the following example. See more details at Deequ Repository Documentation:

from dbnd_spark.deequ_metrics_repository import DbndMetricsRepository

result_key = ResultKey(spark, ResultKey.current_milli_time(), {"name": "words"})
analysis_runner = AnalysisRunner(spark).onData(lines)

# implement your Deequ Validations , for example :
# .addAnalyzer( ApproxCountDistinct("value") )



If you are running Scala or Java Spark

Please refer to our page for Tracking Spark (Scala/Java).