Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
barend-xebia committed Jul 26, 2024
1 parent b6cd4b4 commit 91fbe1e
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

This package connects [Apache Spark™][sp-home] to [OpenTelemetry][ot-home].

This creates a layer of indirection to allow reporting metrics from any Spark or PySpark job to [OpenTelemetry Collector][ot-col], or directly to any [supported backend][ot-export].
This allows reporting tracing and metrics from any Spark or PySpark job to [OpenTelemetry Collector][ot-col], or directly to any [supported backend][ot-export].

## Status

Expand Down Expand Up @@ -67,6 +67,10 @@ If the OpenTelemetry Autoconfigure mechanism doesn't meet your requirements, you

## Design Choices

### Why not simply use Spark's built-in DropWizard support?

Because that's something that already exists, and this is something I wanted to build. If the DropWizard metrics in Spark meet your needs, you should consider using those.

### Crash on initialization failure

If the OpenTelemetry SDK cannot be obtained during startup, we allow the listener –and enclosing spark job– to crash.
Expand Down

0 comments on commit 91fbe1e

Please sign in to comment.