Skip to content

NIFI-16204 Add KafkaProvenanceReportingTask #11544

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
thomews wants to merge 1 commit into
base: main
Choose a base branch
from
Open

NIFI-16204 Add KafkaProvenanceReportingTask #11544

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions nifi-extension-bundles/nifi-kafka-bundle/nifi-kafka-nar/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,11 @@
<artifactId>nifi-kafka-processors</artifactId>
<version>2.12.0-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>org.apache.nifi</groupId>
<artifactId>nifi-kafka-provenance-reporting-task</artifactId>
<version>2.12.0-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>org.apache.nifi</groupId>
<artifactId>nifi-kafka-service-api-nar</artifactId>
Expand Down
65 changes: 65 additions & 0 deletions nifi-extension-bundles/nifi-kafka-bundle/nifi-kafka-provenance-reporting-task/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.apache.nifi</groupId>
<artifactId>nifi-kafka-bundle</artifactId>
<version>2.12.0-SNAPSHOT</version>
</parent>
<artifactId>nifi-kafka-provenance-reporting-task</artifactId>
<packaging>jar</packaging>
<dependencies>
<dependency>
<groupId>org.apache.nifi</groupId>
<artifactId>nifi-kafka-service-api</artifactId>
<version>2.12.0-SNAPSHOT</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.apache.nifi</groupId>
<artifactId>nifi-reporting-utils</artifactId>
<version>2.12.0-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>org.apache.nifi</groupId>
<artifactId>nifi-utils</artifactId>
</dependency>
<dependency>
<groupId>org.apache.nifi</groupId>
<artifactId>nifi-record-serialization-service-api</artifactId>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.apache.nifi</groupId>
<artifactId>nifi-record</artifactId>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.apache.nifi</groupId>
<artifactId>nifi-mock</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.apache.nifi</groupId>
<artifactId>nifi-data-provenance-utils</artifactId>
<version>2.12.0-SNAPSHOT</version>
<scope>test</scope>
</dependency>
</dependencies>
</project>
1,066 changes: 1,066 additions & 0 deletions ...ting-task/src/main/java/org/apache/nifi/kafka/reporting/KafkaProvenanceReportingTask.java
View file
Open in desktop

Large diffs are not rendered by default.

16 changes: 16 additions & 0 deletions ...porting-task/src/main/resources/META-INF/services/org.apache.nifi.reporting.ReportingTask
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

org.apache.nifi.kafka.reporting.KafkaProvenanceReportingTask
217 changes: 217 additions & 0 deletions ...g.apache.nifi.kafka.reporting.KafkaProvenanceReportingTask/additionalDetails.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,217 @@
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->

# KafkaProvenanceReportingTask

The Kafka Provenance Reporting Task publishes NiFi Provenance Events directly to a Kafka topic using the Kafka
Connection Service. On each scheduling trigger the task reads a configurable batch of events from the provenance
repository and publishes them to Kafka. The ID of the last published event is stored in local state so that the
task resumes from the correct position after a restart.

Events can be filtered by event type, component type, component name, and component ID before publishing.

A configurable message key field controls how Kafka assigns events to partitions, which is useful for grouping
related events (e.g. all events for the same FlowFile or lineage) on the same partition for ordered consumption.

Each event is published as an individual Kafka message. By default events are serialized as JSON objects. When a
Record Writer controller service is configured, the serialization format is delegated to that writer, allowing
formats such as Avro or Parquet. The user can also control which fields are written by defining a schema on the
Record Writer (e.g. a subset of the full reporting task schema), giving full control over the output format and
data. The record schema used as input to the Record Writer is defined as follows:

```json
{
"type": "record",
"name": "provenance",
"namespace": "provenance",
"fields": [
{
"name": "eventId",
"type": "string"
},
{
"name": "eventOrdinal",
"type": "long"
},
{
"name": "eventType",
"type": "string"
},
{
"name": "timestampMillis",
"type": "long"
},
{
"name": "durationMillis",
"type": "long"
},
{
"name": "lineageStart",
"type": {
"type": "long",
"logicalType": "timestamp-millis"
}
},
{
"name": "details",
"type": [
"null",
"string"
]
},
{
"name": "componentId",
"type": [
"null",
"string"
]
},
{
"name": "componentType",
"type": [
"null",
"string"
]
},
{
"name": "componentName",
"type": [
"null",
"string"
]
},
{
"name": "processGroupId",
"type": [
"null",
"string"
]
},
{
"name": "processGroupName",
"type": [
"null",
"string"
]
},
{
"name": "entityId",
"type": [
"null",
"string"
]
},
{
"name": "entityType",
"type": [
"null",
"string"
]
},
{
"name": "entitySize",
"type": [
"null",
"long"
]
},
{
"name": "previousEntitySize",
"type": [
"null",
"long"
]
},
{
"name": "updatedAttributes",
"type": {
"type": "map",
"values": "string"
}
},
{
"name": "previousAttributes",
"type": {
"type": "map",
"values": "string"
}
},
{
"name": "actorHostname",
"type": [
"null",
"string"
]
},
{
"name": "contentURI",
"type": [
"null",
"string"
]
},
{
"name": "previousContentURI",
"type": [
"null",
"string"
]
},
{
"name": "parentIds",
"type": {
"type": "array",
"items": "string"
}
},
{
"name": "childIds",
"type": {
"type": "array",
"items": "string"
}
},
{
"name": "platform",
"type": "string"
},
{
"name": "application",
"type": "string"
},
{
"name": "remoteIdentifier",
"type": [
"null",
"string"
]
},
{
"name": "alternateIdentifier",
"type": [
"null",
"string"
]
},
{
"name": "transitUri",
"type": [
"null",
"string"
]
}
]
}
```
Loading
Loading