SparkEx.Observation (SparkEx v0.1.0)

Copy Markdown View Source

Collects metrics observed during query execution.

Observations are identified by a name. Use SparkEx.DataFrame.observe/3 to attach an observation to a DataFrame plan, then access the metrics with get/1 after an action is executed.

Summary

Types

t()

Functions

get(observation)

Returns the observed metrics map for this observation.

new(name \\ nil)

Creates a named observation. When called with no arguments, generates a UUID name.

Types

t()

@type t() :: %SparkEx.Observation{name: String.t()}

Functions

get(observation)

@spec get(t()) :: map()

Returns the observed metrics map for this observation.

Raises if the observation was never attached via DataFrame.observe/3.

new(name \\ nil)

@spec new(String.t() | nil) :: t()

Creates a named observation. When called with no arguments, generates a UUID name.