|
| 1 | +package datadog.trace.instrumentation.spark; |
| 2 | + |
| 3 | +import datadog.trace.api.DDTags; |
| 4 | +import datadog.trace.api.sampling.PrioritySampling; |
| 5 | +import datadog.trace.api.sampling.SamplingMechanism; |
| 6 | +import datadog.trace.bootstrap.instrumentation.api.AgentSpan; |
| 7 | +import datadog.trace.bootstrap.instrumentation.api.AgentTracer; |
| 8 | +import java.lang.reflect.Field; |
| 9 | +import java.util.Map; |
| 10 | +import org.apache.spark.launcher.SparkAppHandle; |
| 11 | +import org.slf4j.Logger; |
| 12 | +import org.slf4j.LoggerFactory; |
| 13 | + |
| 14 | +public class SparkLauncherListener implements SparkAppHandle.Listener { |
| 15 | + |
| 16 | + private static final Logger log = LoggerFactory.getLogger(SparkLauncherListener.class); |
| 17 | + |
| 18 | + static volatile AgentSpan launcherSpan; |
| 19 | + |
| 20 | + private static volatile boolean shutdownHookRegistered = false; |
| 21 | + |
| 22 | + public static synchronized void createLauncherSpan(Object launcher) { |
| 23 | + if (launcherSpan != null) { |
| 24 | + return; |
| 25 | + } |
| 26 | + |
| 27 | + AgentTracer.TracerAPI tracer = AgentTracer.get(); |
| 28 | + AgentSpan span = |
| 29 | + tracer |
| 30 | + .buildSpan("spark.launcher.launch") |
| 31 | + .withSpanType("spark") |
| 32 | + .withResourceName("SparkLauncher.startApplication") |
| 33 | + .start(); |
| 34 | + span.setSamplingPriority(PrioritySampling.USER_KEEP, SamplingMechanism.DATA_JOBS); |
| 35 | + setLauncherConfigTags(span, launcher); |
| 36 | + launcherSpan = span; |
| 37 | + |
| 38 | + |
| 39 | + if (!shutdownHookRegistered) { |
| 40 | + shutdownHookRegistered = true; |
| 41 | + Runtime.getRuntime() |
| 42 | + .addShutdownHook( |
| 43 | + new Thread( |
| 44 | + () -> { |
| 45 | + synchronized (SparkLauncherListener.class) { |
| 46 | + AgentSpan s = launcherSpan; |
| 47 | + if (s != null) { |
| 48 | + log.info("Finishing spark.launcher span from shutdown hook"); |
| 49 | + s.finish(); |
| 50 | + launcherSpan = null; |
| 51 | + } |
| 52 | + } |
| 53 | + })); |
| 54 | + } |
| 55 | + } |
| 56 | + |
| 57 | + public static synchronized void finishSpan(boolean isError, String errorMessage) { |
| 58 | + AgentSpan span = launcherSpan; |
| 59 | + if (span == null) { |
| 60 | + return; |
| 61 | + } |
| 62 | + if (isError) { |
| 63 | + span.setError(true); |
| 64 | + span.setTag(DDTags.ERROR_TYPE, "Spark Launcher Failed"); |
| 65 | + span.setTag(DDTags.ERROR_MSG, errorMessage); |
| 66 | + } |
| 67 | + span.finish(); |
| 68 | + launcherSpan = null; |
| 69 | + } |
| 70 | + |
| 71 | + public static synchronized void finishSpanWithThrowable(Throwable throwable) { |
| 72 | + AgentSpan span = launcherSpan; |
| 73 | + if (span == null) { |
| 74 | + return; |
| 75 | + } |
| 76 | + if (throwable != null) { |
| 77 | + span.addThrowable(throwable); |
| 78 | + } |
| 79 | + span.finish(); |
| 80 | + launcherSpan = null; |
| 81 | + } |
| 82 | + |
| 83 | + @Override |
| 84 | + public void stateChanged(SparkAppHandle handle) { |
| 85 | + SparkAppHandle.State state = handle.getState(); |
| 86 | + AgentSpan span = launcherSpan; |
| 87 | + if (span != null) { |
| 88 | + span.setTag("spark.launcher.app_state", state.toString()); |
| 89 | + |
| 90 | + String appId = handle.getAppId(); |
| 91 | + if (appId != null) { |
| 92 | + span.setTag("spark.app_id", appId); |
| 93 | + span.setTag("app_id", appId); |
| 94 | + } |
| 95 | + |
| 96 | + if (state.isFinal()) { |
| 97 | + if (state == SparkAppHandle.State.FAILED |
| 98 | + || state == SparkAppHandle.State.KILLED |
| 99 | + || state == SparkAppHandle.State.LOST) { |
| 100 | + // Set error tags but don't finish yet — RunMainAdvice may add the throwable |
| 101 | + // with the full stack trace. The span will be finished by RunMainAdvice or |
| 102 | + // the shutdown hook. |
| 103 | + span.setError(true); |
| 104 | + span.setTag(DDTags.ERROR_TYPE, "Spark Launcher Failed"); |
| 105 | + span.setTag(DDTags.ERROR_MSG, "Application " + state); |
| 106 | + } else { |
| 107 | + finishSpan(false, null); |
| 108 | + } |
| 109 | + } |
| 110 | + } |
| 111 | + } |
| 112 | + |
| 113 | + @Override |
| 114 | + public void infoChanged(SparkAppHandle handle) { |
| 115 | + AgentSpan span = launcherSpan; |
| 116 | + if (span != null) { |
| 117 | + String appId = handle.getAppId(); |
| 118 | + if (appId != null) { |
| 119 | + span.setTag("spark.app_id", appId); |
| 120 | + span.setTag("app_id", appId); |
| 121 | + } |
| 122 | + } |
| 123 | + } |
| 124 | + |
| 125 | + private static void setLauncherConfigTags(AgentSpan span, Object launcher) { |
| 126 | + try { |
| 127 | + Field builderField = launcher.getClass().getSuperclass().getDeclaredField("builder"); |
| 128 | + builderField.setAccessible(true); |
| 129 | + Object builder = builderField.get(launcher); |
| 130 | + if (builder == null) { |
| 131 | + return; |
| 132 | + } |
| 133 | + |
| 134 | + Class<?> builderClass = builder.getClass(); |
| 135 | + Class<?> abstractBuilderClass = builderClass.getSuperclass(); |
| 136 | + |
| 137 | + setStringFieldAsTag(span, builder, abstractBuilderClass, "master", "master"); |
| 138 | + setStringFieldAsTag(span, builder, abstractBuilderClass, "deployMode", "deploy_mode"); |
| 139 | + setStringFieldAsTag(span, builder, abstractBuilderClass, "appName", "application_name"); |
| 140 | + setStringFieldAsTag(span, builder, abstractBuilderClass, "mainClass", "main_class"); |
| 141 | + setStringFieldAsTag(span, builder, abstractBuilderClass, "appResource", "app_resource"); |
| 142 | + |
| 143 | + try { |
| 144 | + Field confField = abstractBuilderClass.getDeclaredField("conf"); |
| 145 | + confField.setAccessible(true); |
| 146 | + @SuppressWarnings("unchecked") |
| 147 | + Map<String, String> conf = (Map<String, String>) confField.get(builder); |
| 148 | + if (conf != null) { |
| 149 | + for (Map.Entry<String, String> entry : conf.entrySet()) { |
| 150 | + if (SparkConfAllowList.canCaptureJobParameter(entry.getKey())) { |
| 151 | + String value = SparkConfAllowList.redactValue(entry.getKey(), entry.getValue()); |
| 152 | + span.setTag("config." + entry.getKey().replace('.', '_'), value); |
| 153 | + } |
| 154 | + } |
| 155 | + } |
| 156 | + } catch (NoSuchFieldException e) { |
| 157 | + log.debug("Could not find conf field on builder", e); |
| 158 | + } |
| 159 | + } catch (Exception e) { |
| 160 | + log.debug("Failed to extract SparkLauncher configuration", e); |
| 161 | + } |
| 162 | + } |
| 163 | + |
| 164 | + private static void setStringFieldAsTag( |
| 165 | + AgentSpan span, Object obj, Class<?> clazz, String fieldName, String tagName) { |
| 166 | + try { |
| 167 | + Field field = clazz.getDeclaredField(fieldName); |
| 168 | + field.setAccessible(true); |
| 169 | + Object value = field.get(obj); |
| 170 | + if (value != null) { |
| 171 | + span.setTag(tagName, value.toString()); |
| 172 | + } |
| 173 | + } catch (Exception e) { |
| 174 | + log.debug("Could not read field {} from builder", fieldName, e); |
| 175 | + } |
| 176 | + } |
| 177 | +} |
0 commit comments