ForVic commented on code in PR #52068: URL: https://github.com/apache/spark/pull/52068#discussion_r2440649270
########## resource-managers/kubernetes/core/src/main/scala/org/apache/spark/deploy/k8s/SparkKubernetesDiagnosticsSetter.scala: ########## @@ -0,0 +1,83 @@ +/* + * 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.spark.deploy.k8s + +import io.fabric8.kubernetes.api.model.{Pod, PodBuilder} +import io.fabric8.kubernetes.client.KubernetesClient +import org.apache.hadoop.util.StringUtils + +import org.apache.spark.SparkConf +import org.apache.spark.deploy.SparkDiagnosticsSetter +import org.apache.spark.deploy.k8s.Config._ +import org.apache.spark.deploy.k8s.Constants.DIAGNOSTICS_ANNOTATION +import org.apache.spark.deploy.k8s.SparkKubernetesClientFactory.ClientType +import org.apache.spark.internal.Logging +import org.apache.spark.util.{SparkStringUtils, Utils} + +/** + * We use this trait and its implementation to allow for mocking the static + * client creation in tests. + */ +private[spark] trait KubernetesClientProvider { + def create(conf: SparkConf): KubernetesClient +} + +private[spark] class DefaultKubernetesClientProvider extends KubernetesClientProvider { + override def create(conf: SparkConf): KubernetesClient = { + SparkKubernetesClientFactory.createKubernetesClient( + conf.get(KUBERNETES_DRIVER_MASTER_URL), + Option(conf.get(KUBERNETES_NAMESPACE)), + KUBERNETES_AUTH_DRIVER_MOUNTED_CONF_PREFIX, + ClientType.Driver, + conf, + None) + } +} + +private[spark] class SparkKubernetesDiagnosticsSetter( + clientProvider: KubernetesClientProvider + ) extends SparkDiagnosticsSetter with Logging { + + private val KUBERNETES_DIAGNOSTICS_MESSAGE_LIMIT_BYTES = 64 * 1024 // 64 KiB + + def this() = { + this(new DefaultKubernetesClientProvider) + } + + override def setDiagnostics(throwable: Throwable, conf: SparkConf): Unit = { + require(conf.get(KUBERNETES_DRIVER_POD_NAME).isDefined, + "Driver pod name must be set in order to set diagnostics on the driver pod.") + val diagnostics = SparkStringUtils.abbreviate(StringUtils.stringifyException(throwable), + KUBERNETES_DIAGNOSTICS_MESSAGE_LIMIT_BYTES) + Utils.tryWithResource(clientProvider.create(conf)) { client => + conf.get(KUBERNETES_DRIVER_POD_NAME).foreach { podName => + client.pods() + .inNamespace(conf.get(KUBERNETES_NAMESPACE)) + .withName(podName) + .edit((p: Pod) => new PodBuilder(p) + .editOrNewMetadata() + .addToAnnotations(DIAGNOSTICS_ANNOTATION, diagnostics) Review Comment: There is a limit on the total size (across all annotations) which is 256 KiB. I wanted to be conservative here, so I'm limiting to 64 KiB. -- 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] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
