rkhachatryan commented on code in PR #28799: URL: https://github.com/apache/flink/pull/28799#discussion_r3661489974
########## flink-core/src/main/java/org/apache/flink/util/JobMdcRegistry.java: ########## @@ -0,0 +1,72 @@ +/* + * 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.flink.util; + +import org.apache.flink.annotation.Internal; +import org.apache.flink.annotation.VisibleForTesting; +import org.apache.flink.api.common.JobID; +import org.apache.flink.configuration.Configuration; + +import javax.annotation.Nullable; +import javax.annotation.concurrent.ThreadSafe; + +import java.util.Map; +import java.util.concurrent.ConcurrentHashMap; + +/** + * Process-wide registry mapping {@link JobID} to enriched MDC context, populated where the job + * {@link Configuration} is available and consulted by {@link MdcUtils#asContextData(JobID)}. + */ +@Internal +@ThreadSafe +public final class JobMdcRegistry { + + private static final Map<JobID, Map<String, String>> REGISTRY = new ConcurrentHashMap<>(); + + private JobMdcRegistry() {} + + /** + * Registers enriched MDC context if the configuration carries any MDC key mappings; clears any + * stale entry otherwise. Equivalent to {@link #unregister} when the config is unenriched. + */ + public static void registerOrClear(final JobID jobID, final Configuration jobConfiguration) { + final Map<String, String> context = MdcUtils.asContextData(jobID, jobConfiguration); + if (context.size() > 1) { + REGISTRY.put(jobID, context); + } else { + unregister(jobID); + } + } + + /** Remove the registered context for the job. */ + public static void unregister(final JobID jobID) { + REGISTRY.remove(jobID); + } + + /** Return the registered context for the job, or {@code null} if none. */ + @Nullable + public static Map<String, String> lookup(final JobID jobID) { + return REGISTRY.get(jobID); Review Comment: NIT: wrap into immutable map? Or is it immutable already? ########## flink-core/src/main/java/org/apache/flink/configuration/MdcOptions.java: ########## @@ -0,0 +1,48 @@ +/* + * 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.flink.configuration; + +import org.apache.flink.annotation.PublicEvolving; + +import java.util.Collections; +import java.util.Map; + +import static org.apache.flink.configuration.ConfigOptions.key; + +/** Configuration options for MDC (Mapped Diagnostic Context) enrichment. */ +@PublicEvolving +public final class MdcOptions { + + /** + * Maps job configuration keys to MDC key names. Keys absent or blank in the job configuration + * are skipped. + */ + @PublicEvolving + public static final ConfigOption<Map<String, String>> JOB_CONFIGURATION_TO_MDC_KEYS = + key("mdc.job-configuration-to-mdc-keys") + .mapType() + .defaultValue(Collections.emptyMap()) + .withDescription( + "Maps job configuration keys to MDC key names. " + + "At job start, each listed configuration key is looked up; " + + "if the value is present and non-blank it is emitted into MDC under the mapped name. " + + "Keys absent or blank in the job configuration are skipped."); Review Comment: NIT: would be nice to give an example value and also mention that job ID will be added anyways? -- 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]
