The Flink integration uses OpenLineage to collect and send metadata to Grai. Complete documentation for integrating OpenLineage with Flink can be found here (opens in a new tab).

Web App

Flink Integration

Fields

FieldValueExample
sourceThe name of the source, see sourcesFlink
NameName for connectionproduction
NamespaceNamespace for the connection, see namespacesdefault
namespacesOptional

Webhook

ℹ️

In order to authenticate your webhook, you will need to create an API key in the Grai web app.

Grai will open an endpoint at /api/v1/openlineage/<connection_id>/ which can be used to receive OpenLineage events.

See the OpenLineage docs (opens in a new tab) for how to configure your client to send OpenLineage events. As part of the configuration settings you'll need to define an openlineage.yml file for the Flink OpenLineage flink client.

An example config:

transport:
  type: "http"
  url: "https://api.grai.io"
  endpoint: "api/v1/openlineage/<connection_id>/"
  auth:
    type: "api_key"
    api_key: "<your_grai_api_key>"