Abacn commented on code in PR #36781:
URL: https://github.com/apache/beam/pull/36781#discussion_r3016869617
##########
sdks/java/core/src/main/java/org/apache/beam/sdk/metrics/Lineage.java:
##########
@@ -17,51 +17,142 @@
*/
package org.apache.beam.sdk.metrics;
+import static
org.apache.beam.vendor.guava.v32_1_2_jre.com.google.common.base.Preconditions.checkNotNull;
+
import java.util.ArrayList;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Set;
+import java.util.concurrent.atomic.AtomicReference;
import java.util.regex.Pattern;
import org.apache.beam.sdk.annotations.Internal;
+import org.apache.beam.sdk.lineage.LineageBase;
+import org.apache.beam.sdk.lineage.LineageOptions;
import org.apache.beam.sdk.metrics.Metrics.MetricsFlag;
+import org.apache.beam.sdk.options.PipelineOptions;
+import org.apache.beam.sdk.options.PipelineOptionsFactory;
+import org.apache.beam.sdk.values.KV;
import
org.apache.beam.vendor.guava.v32_1_2_jre.com.google.common.annotations.VisibleForTesting;
import
org.apache.beam.vendor.guava.v32_1_2_jre.com.google.common.base.Splitter;
-import
org.apache.beam.vendor.guava.v32_1_2_jre.com.google.common.collect.ImmutableList;
import org.checkerframework.checker.nullness.qual.Nullable;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
/**
* Standard collection of metrics used to record source and sinks information
for lineage tracking.
*/
public class Lineage {
-
public static final String LINEAGE_NAMESPACE = "lineage";
- private static final Lineage SOURCES = new Lineage(Type.SOURCE);
- private static final Lineage SINKS = new Lineage(Type.SINK);
+ private static final Logger LOG = LoggerFactory.getLogger(Lineage.class);
+ private static final AtomicReference<Lineage> SOURCES = new
AtomicReference<>();
+ private static final AtomicReference<Lineage> SINKS = new
AtomicReference<>();
+
+ private static final AtomicReference<KV<Long, Integer>> LINEAGE_REVISION =
+ new AtomicReference<>();
+
// Reserved characters are backtick, colon, whitespace (space, \t, \n) and
dot.
private static final Pattern RESERVED_CHARS = Pattern.compile("[:\\s.`]");
- private final Metric metric;
+ private final LineageBase delegate;
- private Lineage(Type type) {
- if (MetricsFlag.lineageRollupEnabled()) {
- this.metric =
- Metrics.boundedTrie(
- LINEAGE_NAMESPACE,
- type == Type.SOURCE ? Type.SOURCEV2.toString() :
Type.SINKV2.toString());
- } else {
- this.metric = Metrics.stringSet(LINEAGE_NAMESPACE, type.toString());
+ public enum LineageDirection {
+ SOURCE,
+ SINK
+ }
+
+ private Lineage(LineageBase delegate) {
+ this.delegate = checkNotNull(delegate, "delegate cannot be null");
+ }
+
+ @Internal
+ public static void setDefaultPipelineOptions(PipelineOptions options) {
+ checkNotNull(options, "options cannot be null");
+ long optionsId = options.getOptionsId();
+ int nextRevision = options.revision();
+
+ while (true) {
+ KV<Long, Integer> currentRevision = LINEAGE_REVISION.get();
+
+ if (currentRevision != null
+ && currentRevision.getKey().equals(optionsId)
+ && currentRevision.getValue() >= nextRevision) {
+ LOG.debug(
+ "Lineage already initialized with options ID {} revision {},
skipping",
+ optionsId,
+ currentRevision.getValue());
+ return;
+ }
+
+ if (LINEAGE_REVISION.compareAndSet(currentRevision, KV.of(optionsId,
nextRevision))) {
+ Lineage sources = createLineage(options, LineageDirection.SOURCE);
+ Lineage sinks = createLineage(options, LineageDirection.SINK);
+
+ SOURCES.set(sources);
+ SINKS.set(sinks);
+
+ if (currentRevision == null) {
+ LOG.info("Lineage initialized with options ID {} revision {}",
optionsId, nextRevision);
+ } else {
+ LOG.info(
+ "Lineage re-initialized from options ID {} to {} (revision {} ->
{})",
+ currentRevision.getKey(),
+ optionsId,
+ currentRevision.getValue(),
+ nextRevision);
+ }
+ return;
+ }
+ }
+ }
+
+ private static Lineage createLineage(PipelineOptions options,
LineageDirection direction) {
+ Class<? extends LineageBase> lineageClass =
options.as(LineageOptions.class).getLineageType();
+
+ if (lineageClass != null) {
+ try {
+ LineageBase lineage =
+ lineageClass
+ .getDeclaredConstructor(PipelineOptions.class,
LineageDirection.class)
+ .newInstance(options, direction);
+ LOG.info("Using {} for lineage direction {}", lineageClass.getName(),
direction);
+ return new Lineage(lineage);
+ } catch (ReflectiveOperationException e) {
+ throw new IllegalArgumentException(
+ "Failed to instantiate lineage implementation: "
+ + lineageClass.getName()
+ + ". The class must have a public constructor accepting "
+ + "(PipelineOptions, Lineage.LineageDirection).",
+ e);
+ }
}
+
+ LOG.info("Using default Metrics-based lineage for direction {}",
direction);
Review Comment:
This adds another log for default settings. Consider make it `LOG.debug`
##########
sdks/java/core/src/test/java/org/apache/beam/sdk/lineage/LineagePluginTest.java:
##########
@@ -0,0 +1,294 @@
+/*
+ * 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 static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.hasItem;
+import static org.hamcrest.Matchers.hasSize;
+import static org.hamcrest.Matchers.instanceOf;
+import static org.hamcrest.Matchers.notNullValue;
+import static org.junit.Assert.assertEquals;
+
+import java.util.Arrays;
+import java.util.List;
+import org.apache.beam.sdk.PipelineResult;
+import org.apache.beam.sdk.metrics.Lineage;
+import org.apache.beam.sdk.options.PipelineOptionsFactory;
+import org.apache.beam.sdk.testing.NeedsRunner;
+import org.apache.beam.sdk.testing.TestPipeline;
+import org.apache.beam.sdk.transforms.Create;
+import org.apache.beam.sdk.transforms.DoFn;
+import org.apache.beam.sdk.transforms.ParDo;
+import
org.apache.beam.vendor.guava.v32_1_2_jre.com.google.common.collect.ImmutableList;
+import org.junit.Before;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.experimental.categories.Category;
+import org.junit.rules.TestWatcher;
+import org.junit.runner.Description;
+import org.junit.runner.RunWith;
+import org.junit.runners.JUnit4;
+
+/** Tests for {@link LineageBase} pipeline option selection and DirectRunner
integration. */
+@RunWith(JUnit4.class)
+public class LineagePluginTest {
+
+ /**
+ * TestWatcher that logs detailed lineage diagnostics only when tests fail.
This keeps successful
+ * test output clean while providing deep debugging for failures.
+ */
+ @Rule
+ public TestWatcher lineageDebugLogger =
+ new TestWatcher() {
+ @Override
+ protected void failed(Throwable e, Description description) {
+ System.err.println("=== Lineage Test Failure Diagnostics ===");
Review Comment:
We usually do not use "System.err.println" in shipped codes. Consider using
slf4j Logger as other sources, or remove them if it's test leftover
##########
sdks/java/core/src/main/java/org/apache/beam/sdk/metrics/Lineage.java:
##########
@@ -17,51 +17,142 @@
*/
package org.apache.beam.sdk.metrics;
+import static
org.apache.beam.vendor.guava.v32_1_2_jre.com.google.common.base.Preconditions.checkNotNull;
+
import java.util.ArrayList;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Set;
+import java.util.concurrent.atomic.AtomicReference;
import java.util.regex.Pattern;
import org.apache.beam.sdk.annotations.Internal;
+import org.apache.beam.sdk.lineage.LineageBase;
+import org.apache.beam.sdk.lineage.LineageOptions;
import org.apache.beam.sdk.metrics.Metrics.MetricsFlag;
+import org.apache.beam.sdk.options.PipelineOptions;
+import org.apache.beam.sdk.options.PipelineOptionsFactory;
+import org.apache.beam.sdk.values.KV;
import
org.apache.beam.vendor.guava.v32_1_2_jre.com.google.common.annotations.VisibleForTesting;
import
org.apache.beam.vendor.guava.v32_1_2_jre.com.google.common.base.Splitter;
-import
org.apache.beam.vendor.guava.v32_1_2_jre.com.google.common.collect.ImmutableList;
import org.checkerframework.checker.nullness.qual.Nullable;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
/**
* Standard collection of metrics used to record source and sinks information
for lineage tracking.
*/
public class Lineage {
-
public static final String LINEAGE_NAMESPACE = "lineage";
- private static final Lineage SOURCES = new Lineage(Type.SOURCE);
- private static final Lineage SINKS = new Lineage(Type.SINK);
+ private static final Logger LOG = LoggerFactory.getLogger(Lineage.class);
+ private static final AtomicReference<Lineage> SOURCES = new
AtomicReference<>();
+ private static final AtomicReference<Lineage> SINKS = new
AtomicReference<>();
+
+ private static final AtomicReference<KV<Long, Integer>> LINEAGE_REVISION =
+ new AtomicReference<>();
+
// Reserved characters are backtick, colon, whitespace (space, \t, \n) and
dot.
private static final Pattern RESERVED_CHARS = Pattern.compile("[:\\s.`]");
- private final Metric metric;
+ private final LineageBase delegate;
- private Lineage(Type type) {
- if (MetricsFlag.lineageRollupEnabled()) {
- this.metric =
- Metrics.boundedTrie(
- LINEAGE_NAMESPACE,
- type == Type.SOURCE ? Type.SOURCEV2.toString() :
Type.SINKV2.toString());
- } else {
- this.metric = Metrics.stringSet(LINEAGE_NAMESPACE, type.toString());
+ public enum LineageDirection {
+ SOURCE,
+ SINK
+ }
+
+ private Lineage(LineageBase delegate) {
+ this.delegate = checkNotNull(delegate, "delegate cannot be null");
+ }
+
+ @Internal
+ public static void setDefaultPipelineOptions(PipelineOptions options) {
+ checkNotNull(options, "options cannot be null");
+ long optionsId = options.getOptionsId();
+ int nextRevision = options.revision();
+
+ while (true) {
+ KV<Long, Integer> currentRevision = LINEAGE_REVISION.get();
+
+ if (currentRevision != null
+ && currentRevision.getKey().equals(optionsId)
+ && currentRevision.getValue() >= nextRevision) {
Review Comment:
Current "already initialized" condition sounds too tight. There might be
caller invoking `FileSystems.setDefaultPipelineOptions` after mutating pipeline
options and it will cause previous Lineage gets lost. Consider only
re-initialize when the given Lineage type is different from what being held in
SOURCES and SINKS
##########
sdks/java/core/src/main/java/org/apache/beam/sdk/metrics/Lineage.java:
##########
@@ -17,51 +17,142 @@
*/
package org.apache.beam.sdk.metrics;
+import static
org.apache.beam.vendor.guava.v32_1_2_jre.com.google.common.base.Preconditions.checkNotNull;
+
import java.util.ArrayList;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Set;
+import java.util.concurrent.atomic.AtomicReference;
import java.util.regex.Pattern;
import org.apache.beam.sdk.annotations.Internal;
+import org.apache.beam.sdk.lineage.LineageBase;
+import org.apache.beam.sdk.lineage.LineageOptions;
import org.apache.beam.sdk.metrics.Metrics.MetricsFlag;
+import org.apache.beam.sdk.options.PipelineOptions;
+import org.apache.beam.sdk.options.PipelineOptionsFactory;
+import org.apache.beam.sdk.values.KV;
import
org.apache.beam.vendor.guava.v32_1_2_jre.com.google.common.annotations.VisibleForTesting;
import
org.apache.beam.vendor.guava.v32_1_2_jre.com.google.common.base.Splitter;
-import
org.apache.beam.vendor.guava.v32_1_2_jre.com.google.common.collect.ImmutableList;
import org.checkerframework.checker.nullness.qual.Nullable;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
/**
* Standard collection of metrics used to record source and sinks information
for lineage tracking.
*/
public class Lineage {
-
public static final String LINEAGE_NAMESPACE = "lineage";
- private static final Lineage SOURCES = new Lineage(Type.SOURCE);
- private static final Lineage SINKS = new Lineage(Type.SINK);
+ private static final Logger LOG = LoggerFactory.getLogger(Lineage.class);
+ private static final AtomicReference<Lineage> SOURCES = new
AtomicReference<>();
+ private static final AtomicReference<Lineage> SINKS = new
AtomicReference<>();
+
+ private static final AtomicReference<KV<Long, Integer>> LINEAGE_REVISION =
+ new AtomicReference<>();
+
// Reserved characters are backtick, colon, whitespace (space, \t, \n) and
dot.
private static final Pattern RESERVED_CHARS = Pattern.compile("[:\\s.`]");
- private final Metric metric;
+ private final LineageBase delegate;
- private Lineage(Type type) {
- if (MetricsFlag.lineageRollupEnabled()) {
- this.metric =
- Metrics.boundedTrie(
- LINEAGE_NAMESPACE,
- type == Type.SOURCE ? Type.SOURCEV2.toString() :
Type.SINKV2.toString());
- } else {
- this.metric = Metrics.stringSet(LINEAGE_NAMESPACE, type.toString());
+ public enum LineageDirection {
+ SOURCE,
+ SINK
+ }
+
+ private Lineage(LineageBase delegate) {
+ this.delegate = checkNotNull(delegate, "delegate cannot be null");
+ }
+
+ @Internal
+ public static void setDefaultPipelineOptions(PipelineOptions options) {
+ checkNotNull(options, "options cannot be null");
+ long optionsId = options.getOptionsId();
+ int nextRevision = options.revision();
+
+ while (true) {
+ KV<Long, Integer> currentRevision = LINEAGE_REVISION.get();
+
+ if (currentRevision != null
+ && currentRevision.getKey().equals(optionsId)
+ && currentRevision.getValue() >= nextRevision) {
+ LOG.debug(
+ "Lineage already initialized with options ID {} revision {},
skipping",
+ optionsId,
+ currentRevision.getValue());
+ return;
+ }
+
+ if (LINEAGE_REVISION.compareAndSet(currentRevision, KV.of(optionsId,
nextRevision))) {
+ Lineage sources = createLineage(options, LineageDirection.SOURCE);
+ Lineage sinks = createLineage(options, LineageDirection.SINK);
+
+ SOURCES.set(sources);
+ SINKS.set(sinks);
+
+ if (currentRevision == null) {
+ LOG.info("Lineage initialized with options ID {} revision {}",
optionsId, nextRevision);
Review Comment:
same here, possible log spam
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
