Implement pluggable Lineage in Java SDK #36781
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| /* | ||
| * 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. | ||
| */ | ||
| package org.apache.beam.sdk.lineage; | ||
|
|
||
| import org.apache.beam.sdk.annotations.Internal; | ||
|
|
||
| /** | ||
| * Plugin interface for lineage implementations. | ||
| * | ||
| * <p>This is the core contract that lineage plugins must implement. Plugins should implement this | ||
| * interface and register via {@link LineageRegistrar}. | ||
| * | ||
| * <p>End users should use the {@link org.apache.beam.sdk.metrics.Lineage} facade class instead of | ||
| * implementing this interface directly. | ||
| */ | ||
| @Internal | ||
| public interface LineageBase { | ||
| /** | ||
| * Adds the given FQN as lineage. | ||
| * | ||
| * @param rollupSegments should be an iterable of strings whose concatenation is a valid <a | ||
| * href="https://cloud.google.com/data-catalog/docs/fully-qualified-names">Dataplex FQN </a> | ||
| * which is already escaped. | ||
| * <p>In particular, this means they will often have trailing delimiters. | ||
| */ | ||
| void add(Iterable<String> rollupSegments); | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| /* | ||
| * 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. | ||
| */ | ||
| package org.apache.beam.sdk.lineage; | ||
|
|
||
| import javax.annotation.Nullable; | ||
| import org.apache.beam.sdk.metrics.Lineage; | ||
| import org.apache.beam.sdk.options.PipelineOptions; | ||
|
|
||
| /** Interface for discovering and creating lineage plugin implementations. */ | ||
| public interface LineageRegistrar { | ||
|
|
||
| @Nullable | ||
| LineageBase fromOptions(PipelineOptions options, Lineage.LineageDirection direction); | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| /* | ||
| * 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. | ||
| */ | ||
| /** | ||
| * Lineage tracking support for Apache Beam pipelines. | ||
| * | ||
| * <p>This package provides a plugin mechanism to support different lineage implementations through | ||
| * the {@link org.apache.beam.sdk.lineage.LineageRegistrar} interface. Lineage implementations can | ||
| * be registered and discovered at runtime to track data lineage information during pipeline | ||
| * execution. | ||
| * | ||
| * <p>For lineage capabilities, see {@link org.apache.beam.sdk.metrics.Lineage}. | ||
| */ | ||
| package org.apache.beam.sdk.lineage; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| /* | ||
| * 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. | ||
| */ | ||
| package org.apache.beam.sdk.metrics; | ||
|
|
||
| import org.apache.beam.sdk.lineage.LineageBase; | ||
| import org.apache.beam.sdk.metrics.Metrics.MetricsFlag; | ||
| import org.apache.beam.vendor.guava.v32_1_2_jre.com.google.common.collect.ImmutableList; | ||
|
|
||
| /** | ||
| * Default lineage implementation that stores lineage information in Beam metrics. | ||
| * | ||
| * <p>This implementation uses either {@link BoundedTrie} or {@link StringSet} metrics depending on | ||
| * the {@link MetricsFlag#lineageRollupEnabled()} flag. | ||
| */ | ||
| public class MetricsLineage implements LineageBase { | ||
|
|
||
| private final Metric metric; | ||
|
|
||
| public MetricsLineage(final Lineage.LineageDirection direction) { | ||
| // Derive Metrics-specific Type from LineageDirection | ||
| Lineage.Type type = | ||
| (direction == Lineage.LineageDirection.SOURCE) ? Lineage.Type.SOURCE : Lineage.Type.SINK; | ||
|
|
||
| if (MetricsFlag.lineageRollupEnabled()) { | ||
| this.metric = | ||
| Metrics.boundedTrie( | ||
| Lineage.LINEAGE_NAMESPACE, | ||
| direction == Lineage.LineageDirection.SOURCE | ||
| ? Lineage.Type.SOURCEV2.toString() | ||
| : Lineage.Type.SINKV2.toString()); | ||
| } else { | ||
| this.metric = Metrics.stringSet(Lineage.LINEAGE_NAMESPACE, type.toString()); | ||
| } | ||
| } | ||
|
Comment on lines
+34
to
+49
Contributor
There was a problem hiding this comment. The constructor logic can be simplified for better readability. The public MetricsLineage(Lineage.LineageDirection direction) {
if (MetricsFlag.lineageRollupEnabled()) {
Lineage.Type metricType =
(direction == Lineage.LineageDirection.SOURCE)
? Lineage.Type.SOURCEV2
: Lineage.Type.SINKV2;
this.metric = Metrics.boundedTrie(Lineage.LINEAGE_NAMESPACE, metricType.toString());
} else {
Lineage.Type metricType =
(direction == Lineage.LineageDirection.SOURCE) ? Lineage.Type.SOURCE : Lineage.Type.SINK;
this.metric = Metrics.stringSet(Lineage.LINEAGE_NAMESPACE, metricType.toString());
}
} |
||
|
|
||
| @Override | ||
| public void add(final Iterable<String> rollupSegments) { | ||
| ImmutableList<String> segments = ImmutableList.copyOf(rollupSegments); | ||
| if (MetricsFlag.lineageRollupEnabled()) { | ||
| ((BoundedTrie) this.metric).add(segments); | ||
|
Contributor
There was a problem hiding this comment. There was an assumption (and coupling) between lineageRollupEnabled<->BoundedTrie. With common interface we can now avoid unchecked cast by implementing CounterMetricsLineage and TrieMetricsLineage separately. |
||
| } else { | ||
| ((StringSet) this.metric).add(String.join("", segments)); | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FYI
We are using
Lineageas a facade aroundLineageBase, so we don't expose the latter and we avoid any (breaking) changes in other parts of Beam