Package io.openlineage.client

Class OpenLineageClient

java.lang.Object

io.openlineage.client.OpenLineageClient

All Implemented Interfaces:

AutoCloseable

public final class OpenLineageClient
extends Object
implements AutoCloseable

HTTP client used to emit OpenLineage.RunEvents to HTTP backend.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OpenLineageClient.Builder	Builder for OpenLineageClient instances.

Constructor Summary

Constructors

Constructor	Description
OpenLineageClient()	Creates a new OpenLineageClient object.
OpenLineageClient(@NonNull Transport transport)
OpenLineageClient(@NonNull Transport transport, CircuitBreaker circuitBreaker, io.micrometer.core.instrument.MeterRegistry meterRegistry, String... disabledFacets)
OpenLineageClient(@NonNull Transport transport, String... disabledFacets)

Method Summary

Modifier and Type	Method	Description
static OpenLineageClient.Builder	builder()
void	close()	Shutdown the underlying transport, waiting for all events to complete.
void	emit(OpenLineage.DatasetEvent datasetEvent)	Emit the given dataset event to HTTP backend.
void	emit(OpenLineage.JobEvent jobEvent)	Emit the given run event to HTTP backend.
void	emit(OpenLineage.RunEvent runEvent)	Emit the given run event to HTTP backend.
void	initializeMetrics()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OpenLineageClient

public OpenLineageClient()

Creates a new OpenLineageClient object.

OpenLineageClient

public OpenLineageClient(@NonNull
 @NonNull Transport transport)

OpenLineageClient

public OpenLineageClient(@NonNull
 @NonNull Transport transport,
 String... disabledFacets)

OpenLineageClient

public OpenLineageClient(@NonNull
 @NonNull Transport transport,
 CircuitBreaker circuitBreaker,
 io.micrometer.core.instrument.MeterRegistry meterRegistry,
 String... disabledFacets)

Method Details

emit

public void emit(@NonNull
 OpenLineage.RunEvent runEvent)

Emit the given run event to HTTP backend. The method will return successfully after the run event has been emitted, regardless of any exceptions thrown by the HTTP backend.

Parameters:

runEvent - The run event to emit.

emit

public void emit(@NonNull
 OpenLineage.DatasetEvent datasetEvent)

Emit the given dataset event to HTTP backend. The method will return successfully after the dataset event has been emitted, regardless of any exceptions thrown by the HTTP backend.

Parameters:

datasetEvent - The dataset event to emit.

emit

public void emit(@NonNull
 OpenLineage.JobEvent jobEvent)

Emit the given run event to HTTP backend. The method will return successfully after the run event has been emitted, regardless of any exceptions thrown by the HTTP backend.

Parameters:

jobEvent - The job event to emit.

initializeMetrics

public void initializeMetrics()

close

public void close()
           throws Exception

Shutdown the underlying transport, waiting for all events to complete.

Specified by:

close in interface AutoCloseable

Throws:

Exception

builder

public static OpenLineageClient.Builder builder()

Returns:

an new OpenLineageClient.Builder object for building OpenLineageClients.