如何在Scala应用中集成AWS XRAY？恳请提供参考示例

Scala 应用可直接兼容 AWS X-Ray 的 Java SDK，以下是具体集成步骤和示例代码：

1. 添加依赖 #

在 SBT 项目的 build.sbt 中添加必要的 X-Ray SDK 依赖（版本号可按需调整）：

libraryDependencies ++= Seq(
  "com.amazonaws" % "aws-xray-recorder-sdk-core" % "2.16.0",
  // 使用 Apache HttpClient 时添加该依赖
  "com.amazonaws" % "aws-xray-recorder-sdk-apache-http" % "2.16.0",
  // 使用 PostgreSQL 时添加该数据库追踪依赖，其他数据库可替换对应 SDK
  "com.amazonaws" % "aws-xray-recorder-sdk-sql-postgres" % "2.16.0"
)

2. 初始化 X-Ray 追踪器 #

在应用启动入口完成 X-Ray 初始化：

import com.amazonaws.xray.AWSXRay

object AppInitializer {
  def initXRay(): Unit = {
    // 初始化全局追踪器，默认自动读取环境变量或 IAM 角色配置
    val recorder = AWSXRay.getGlobalRecorder
    recorder.beginSegment("scala-application-root")
    recorder.endSegment()
  }
}

// 在应用 main 方法中调用初始化逻辑
object Main extends App {
  AppInitializer.initXRay()
  // 其他应用启动逻辑
}

3. 自动追踪 HTTP 请求（以 Play Framework 为例） #

通过自定义 Action 过滤器，自动追踪所有 HTTP 请求：

import play.api.mvc._
import scala.concurrent.{ExecutionContext, Future}
import com.amazonaws.xray.AWSXRay

class XRayRequestFilter(implicit ec: ExecutionContext) extends ActionFilter[Request] {
  override protected def filter[A](request: Request[A]): Future[Option[Result]] = {
    // 启动请求子段
    AWSXRay.beginSubsegment(s"HTTP-${request.method}-${request.uri}")
    // 记录请求元数据
    AWSXRay.getCurrentSubsegment.putMetadata("request-details", Map(
      "method" -> request.method,
      "path" -> request.path,
      "remote-addr" -> request.remoteAddress
    ))

    // 请求完成后关闭子段
    Future.successful(None).andThen {
      case _ => AWSXRay.endSubsegment()
    }
  }
}

// 在控制器中使用过滤器
class UserController @Inject()(cc: ControllerComponents, xRayFilter: XRayRequestFilter)
  extends AbstractController(cc) {
  
  def getUser(id: Long) = Action.andThen(xRayFilter) { implicit request =>
    // 业务逻辑实现
    Ok(s"User ID: $id")
  }
}

4. 追踪数据库操作 #

以 PostgreSQL 为例，使用 X-Ray 包装的 JDBC 驱动自动追踪数据库操作：

import java.sql.DriverManager
import com.amazonaws.xray.sql.postgres.PostgreSQLXRayDriver

// 加载 X-Ray 代理驱动
Class.forName(classOf[PostgreSQLXRayDriver].getName)

// 连接数据库时使用 xray 前缀的 URL
val dbUrl = "jdbc:xray:postgresql://your-db-host:5432/your-db-name"
val conn = DriverManager.getConnection(dbUrl, "db-user", "db-password")

// 执行的 SQL 操作会自动被 X-Ray 追踪
val stmt = conn.createStatement()
val rs = stmt.executeQuery("SELECT name FROM users WHERE id = 1")
if (rs.next()) {
  println(s"User name: ${rs.getString("name")}")
}

// 关闭资源
rs.close()
stmt.close()
conn.close()

5. 手动追踪自定义业务逻辑 #

对于需要单独追踪的代码块，可手动创建子段：

import com.amazonaws.xray.AWSXRay

def calculateTotal(prices: List[Double]): Double = {
  AWSXRay.beginSubsegment("calculate-total")
  try {
    val total = prices.sum
    // 记录计算元数据
    AWSXRay.getCurrentSubsegment.putMetadata("input-size", prices.size)
    AWSXRay.getCurrentSubsegment.putMetadata("total", total)
    total
  } finally {
    // 确保子段关闭，避免内存泄漏
    AWSXRay.endSubsegment()
  }
}

内容的提问来源于stack exchange，提问作者Dinesh Kumar