Yicong-Huang commented on code in PR #5375:
URL: https://github.com/apache/texera/pull/5375#discussion_r4225421842
##########
notebook-migration-service/src/main/scala/org/apache/texera/service/NotebookMigrationService.scala:
##########
@@ -62,6 +62,7 @@ class NotebookMigrationService
configuration: NotebookMigrationServiceConfiguration,
environment: Environment
): Unit = {
+ org.apache.texera.observability.OtelInit.init("notebook-migration-service")
Review Comment:
**Advisory:**
This service now runs `OtelInit.init`, so its logs reach the collector, but
`notebook-migration-service-web-config.yaml` lacks the framework log caps
(`org.apache.pekko`, `io.grpc`, etc. at WARN) that the other eight service
configs carry. Without them, a TRACE or DEBUG `TEXERA_SERVICE_LOG_LEVEL`
forwards the framework firehose to the OTel backend. Add the same caps the
other configs got when they landed.
##########
common/observability/src/main/scala/org/apache/texera/observability/OtelInit.scala:
##########
@@ -0,0 +1,418 @@
+/*
+ * 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.texera.observability
+
+import com.typesafe.scalalogging.LazyLogging
+import org.apache.texera.common.config.{EnvironmentalVariable,
ObservabilityConfig}
+import io.opentelemetry.api.{GlobalOpenTelemetry, OpenTelemetry}
+import io.opentelemetry.api.common.{AttributeKey, Attributes}
+import io.opentelemetry.exporter.otlp.logs.OtlpGrpcLogRecordExporter
+import io.opentelemetry.exporter.otlp.metrics.OtlpGrpcMetricExporter
+import io.opentelemetry.exporter.otlp.trace.OtlpGrpcSpanExporter
+import io.opentelemetry.sdk.OpenTelemetrySdk
+import io.opentelemetry.sdk.logs.SdkLoggerProvider
+import io.opentelemetry.sdk.logs.`export`.{BatchLogRecordProcessor,
LogRecordExporter}
+import io.opentelemetry.sdk.metrics.SdkMeterProvider
+import io.opentelemetry.sdk.metrics.`export`.{MetricExporter,
PeriodicMetricReader}
+import io.opentelemetry.sdk.resources.Resource
+import io.opentelemetry.sdk.trace.SdkTracerProvider
+import io.opentelemetry.sdk.trace.`export`.{BatchSpanProcessor, SpanExporter}
+
+import java.net.URI
+import java.time.Duration
+import scala.util.{Failure, Success, Try}
+
+/**
+ * Bootstraps the OpenTelemetry SDK for a Texera service.
+ *
+ * Disabled by default; set OTEL_SDK_DISABLED=false to enable it. Reads its
+ * settings from observability.conf (each defaulted, each OTEL_*-overridable),
+ * validates the endpoint against an allowlist, builds tracer/log/metric
+ * providers, and attaches a Logback appender. Returns None when disabled or
+ * misconfigured; never throws.
+ */
+object OtelInit extends LazyLogging {
+
+ /** Endpoint schemes we accept. OTLP-over-gRPC uses http/https endpoints;
+ * the exporter rejects a `grpc://` scheme outright, so it is not allowed.
+ */
+ private[observability] val AllowedSchemes: Set[String] = Set("http", "https")
+
+ /** Hosts we accept for the OTLP endpoint by default. */
+ private[observability] val DefaultAllowedHosts: Set[String] = Set(
+ "localhost",
+ "127.0.0.1",
+ "[::1]"
+ )
+
+ /** Default endpoint. 127.0.0.1 (not "localhost") to force IPv4 so a
+ * natively-run service reaches the collector on dual-stack hosts.
+ */
+ private val DefaultEndpoint = "http://127.0.0.1:4317";
+
+ /** Metric export interval bounds; out-of-range values fall back to the
+ * default (see clampIntervalMs).
+ */
+ private[observability] val MinMetricIntervalMs: Long = 1000L
+ private[observability] val MaxMetricIntervalMs: Long = 10L * 60L * 1000L
+ private[observability] val DefaultMetricIntervalMs: Long = 30L * 1000L
+
+ // Idempotency guard: init() is a no-op after the first call.
+ @volatile private var initialized: Option[OpenTelemetry] = None
+
+ /**
+ * Initialize the SDK for the given service name. Returns Some on
+ * success, None when disabled or misconfigured. When enabled, also
+ * attaches a [[TexeraOtelLogAppender]] to the Logback ROOT logger.
+ */
+ def init(serviceName: String): Option[OpenTelemetry] =
+ synchronized {
+ if (initialized.isDefined) return initialized
+
+ // Guard the whole body: reading observability.conf
(ObservabilityConfig's
+ // eager vals) and building the SDK are the fallible steps. A missing or
+ // malformed config would otherwise escape as
ExceptionInInitializerError,
+ // even when telemetry is disabled, breaking init()'s "never throws"
+ // contract. On any failure, disable telemetry with one WARN and return
None.
+ Try {
+ // Source the OTEL_* settings from observability.conf (HOCON defaults
+ // already merged with any env override); fall back to the raw
environment
+ // for anything else.
+ val env = (key: String) =>
+ key match {
+ case EnvironmentalVariable.ENV_OTEL_SDK_DISABLED =>
+ Some(ObservabilityConfig.sdkDisabled)
+ case EnvironmentalVariable.ENV_OTEL_EXPORTER_OTLP_ENDPOINT =>
+ Some(ObservabilityConfig.endpoint)
+ case EnvironmentalVariable.ENV_OTEL_RESOURCE_ATTRIBUTES =>
+ Some(ObservabilityConfig.resourceAttributes)
+ case EnvironmentalVariable.ENV_TEXERA_OTEL_ALLOWED_HOSTS =>
+ Some(ObservabilityConfig.allowedHosts)
+ case EnvironmentalVariable.ENV_OTEL_METRIC_EXPORT_INTERVAL =>
+ Some(ObservabilityConfig.metricExportIntervalMs)
+ case other => Option(System.getenv(other))
+ }
+ val result = initInternal(
+ serviceName = serviceName,
+ envProvider = env,
+ spanExporterFactory = buildOtlpSpanExporter,
+ logExporterFactory = endpoint =>
Some(buildOtlpLogExporter(endpoint)),
+ metricExporterFactory = endpoint =>
Some(buildOtlpMetricExporter(endpoint)),
+ logbackAttacher = LogbackBinder.attach
+ )
+ // Register globally so OTel-aware code can use GlobalOpenTelemetry
+ // without threading the SDK through callsites. set() throws on a
+ // second call; wrap defensively.
+ result.foreach { sdk =>
+ Try(GlobalOpenTelemetry.set(sdk)).failed.foreach { t =>
+ logger.warn(
+ s"GlobalOpenTelemetry already set; using the existing instance:
${t.getMessage}"
+ )
+ }
+ }
+ result
+ } match {
+ case Success(result) => result
+ case Failure(t) =>
+ logger.warn(
+ s"OpenTelemetry SDK initialization failed; continuing without
telemetry: ${t.getMessage}"
+ )
+ None
+ }
+ }
+
+ /**
+ * Test-only entry point: injects an env-var map and exporters so the
+ * SDK makes no network connection. Does not attach the Logback appender.
+ */
+ private[observability] def initForTest(
+ serviceName: String,
+ envOverride: Map[String, String],
+ exporter: SpanExporter,
+ metricExporter: Option[MetricExporter] = None
+ ): Option[OpenTelemetry] =
+ synchronized {
+ initInternal(
+ serviceName = serviceName,
+ envProvider = envOverride.get,
+ spanExporterFactory = _ => exporter,
+ logExporterFactory = _ => None,
+ metricExporterFactory = _ => metricExporter,
+ logbackAttacher = (_, _) => () // no-op in tests
+ )
+ }
+
+ /** Test-only: forget any previously-installed SDK. Does not unregister
+ * shutdown hooks (the previous SDK is closed instead).
+ */
+ private[observability] def resetForTest(): Unit =
+ synchronized {
+ initialized.foreach {
+ case sdk: OpenTelemetrySdk =>
+ Try(sdk.getSdkTracerProvider.close())
+ Try(sdk.getSdkLoggerProvider.close())
+ Try(sdk.getSdkMeterProvider.close())
+ case _ => ()
+ }
+ initialized = None
+ }
+
+ private def initInternal(
+ serviceName: String,
+ envProvider: String => Option[String],
+ spanExporterFactory: String => SpanExporter,
+ logExporterFactory: String => Option[LogRecordExporter],
+ metricExporterFactory: String => Option[MetricExporter],
+ logbackAttacher: (String, OpenTelemetry) => Unit
+ ): Option[OpenTelemetry] = {
+ if (initialized.isDefined) return initialized
+
+ // Disabled by default (issue #5367): stay inert unless OTEL_SDK_DISABLED
is
+ // explicitly false. An unreachable endpoint drops records without
crashing.
+ val disabled =
envProvider(EnvironmentalVariable.ENV_OTEL_SDK_DISABLED).getOrElse("true")
+ if (!disabled.equalsIgnoreCase("false")) {
+ logger.info(
+ "OpenTelemetry SDK disabled (OTEL_SDK_DISABLED not false). No
telemetry will be emitted."
+ )
+ return None
+ }
+
+ val endpoint =
+
envProvider(EnvironmentalVariable.ENV_OTEL_EXPORTER_OTLP_ENDPOINT).getOrElse(DefaultEndpoint)
+ val extraAllowed =
envProvider(EnvironmentalVariable.ENV_TEXERA_OTEL_ALLOWED_HOSTS)
+
.map(_.split(',').iterator.map(_.trim.toLowerCase).filter(_.nonEmpty).toSet)
+ .getOrElse(Set.empty)
+ val allowedHosts = DefaultAllowedHosts ++ extraAllowed
+
+ validateEndpoint(endpoint, allowedHosts) match {
+ case Left(reason) =>
+ // One WARN; no telemetry is emitted.
+ logger.warn(
+ s"OpenTelemetry SDK disabled: invalid OTEL_EXPORTER_OTLP_ENDPOINT —
$reason. " +
+ "Set TEXERA_OTEL_ALLOWED_HOSTS to extend the allowlist."
+ )
+ return None
+ case Right(_) => // ok
+ }
+
+ val rawAttrs =
envProvider(EnvironmentalVariable.ENV_OTEL_RESOURCE_ATTRIBUTES).getOrElse("")
+ val resource = buildResource(serviceName, rawAttrs)
+
+ val spanExporter = spanExporterFactory(endpoint)
+ val tracerProvider = SdkTracerProvider
+ .builder()
+ .setResource(resource)
+ .addSpanProcessor(BatchSpanProcessor.builder(spanExporter).build())
+ .build()
+
+ val sdkBuilder =
OpenTelemetrySdk.builder().setTracerProvider(tracerProvider)
+
+ // Logger provider is optional; the factory returns None in tests.
+ val loggerProviderOpt = logExporterFactory(endpoint).map { logExporter =>
+ val lp = SdkLoggerProvider
+ .builder()
+ .setResource(resource)
+
.addLogRecordProcessor(BatchLogRecordProcessor.builder(logExporter).build())
+ .build()
+ sdkBuilder.setLoggerProvider(lp)
+ lp
+ }
+
+ // Meter provider is optional too; interval falls back to the default
+ // when out of range.
+ val intervalMs =
+
clampIntervalMs(envProvider(EnvironmentalVariable.ENV_OTEL_METRIC_EXPORT_INTERVAL))
+ val meterProviderOpt = metricExporterFactory(endpoint).map {
metricExporter =>
+ val reader = PeriodicMetricReader
+ .builder(metricExporter)
+ .setInterval(Duration.ofMillis(intervalMs))
+ .build()
+ val mp = SdkMeterProvider
+ .builder()
+ .setResource(resource)
+ .registerMetricReader(reader)
+ .build()
+ sdkBuilder.setMeterProvider(mp)
+ mp
+ }
+
+ val sdk = sdkBuilder.build()
+
+ // One startup span carrying only service.name.
+ val span =
sdk.getTracer("texera.bootstrap").spanBuilder("service.start").startSpan()
+ Try(span.setAttribute("service.name", serviceName))
+ span.end()
+
+ // Wire the Logback appender; failure here must not crash the service.
+ Try(logbackAttacher(serviceName, sdk)).failed.foreach { t =>
+ logger.warn(s"Failed to attach OTel Logback appender (logs not
exported): ${t.getMessage}")
+ }
+
+ // Flush providers on shutdown. Added after the SDK is fully built.
+ Runtime.getRuntime.addShutdownHook(
+ new Thread(
+ () => {
+ Try(tracerProvider.close())
+ loggerProviderOpt.foreach(lp => Try(lp.close()))
+ meterProviderOpt.foreach(mp => Try(mp.close()))
+ ()
+ },
+ "otel-shutdown"
+ )
+ )
+
+ initialized = Some(sdk)
+ logger.info(s"OpenTelemetry SDK initialized for service '$serviceName'
(endpoint=$endpoint).")
+ initialized
+ }
+
+ /**
+ * Validate the endpoint is parseable and uses an allowlisted scheme
+ * and host. Pure function.
+ */
+ private[observability] def validateEndpoint(
+ endpoint: String,
+ allowedHosts: Set[String]
+ ): Either[String, Unit] = {
+ Try(URI.create(endpoint)) match {
+ case Failure(e) =>
+ Left(s"unparseable URI (${e.getClass.getSimpleName})")
+ case Success(uri) =>
+ val scheme = Option(uri.getScheme).map(_.toLowerCase).getOrElse("")
+ if (scheme.isEmpty) {
+ Left("missing scheme")
+ } else if (!AllowedSchemes.contains(scheme)) {
+ Left(
+ s"scheme '$scheme' not in allowlist
${AllowedSchemes.toSeq.sorted.mkString("{", ",", "}")}"
+ )
+ } else {
+ val host = Option(uri.getHost).map(_.toLowerCase).getOrElse("")
+ if (host.isEmpty) {
+ Left("missing host")
+ } else if (!allowedHosts.contains(host)) {
+ Left(s"host '$host' not in allowlist")
+ } else {
+ Right(())
+ }
+ }
+ }
+ }
+
+ /**
+ * Build a Resource from the service name and OTEL_RESOURCE_ATTRIBUTES.
+ * Every parsed attribute is applied so new resource fields need no edit
+ * here; the one exception is service.name, which the argument controls
+ * and env cannot override.
+ */
+ private[observability] def buildResource(serviceName: String, rawAttrs:
String): Resource = {
Review Comment:
**Advisory:**
The description's guard table still claims a "Resource-attribute allowlist".
`buildResource` applies every parsed `OTEL_RESOURCE_ATTRIBUTES` entry as
passthrough (per the earlier review discussion), protecting only `service.name`
from override. The table should say passthrough, not allowlist. (The same
table's "Body cap (16 KiB)" is also slightly off: the cap is 16384 chars via
`MaxBodyChars`, not bytes.)
--
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]
