initial

Author: tak-nakamura-m3

.gitignore

@@ -0,0 +1,6 @@
+# .gitignore
+
+/.idea/
+/.env
+target/
+

README.md

@@ -0,0 +1,113 @@
+Play2向け Sentryログ出力サポート
+=====
+
+Play2においてSentryへのログ出力にHTTPリクエストの内容を記録させるためのモジュールです。  
+Play2では、Java Servletとは違う独自の構造でHTTPリクエスト情報を保持しているため、それをSentry向けに変換する必要があります、
+  
+また、１リクエスト内でもマルチスレッドで処理することが多いため、スレッド内でのログにリクエスト情報を付与するためにはスレッド間でリクエスト情報を共有する必要があります。
+
+これらに対処するため、本モジュールでは主に以下のことを行っています。
+
+  * PlayのHTTPリクエスト情報をSentryに送信するためのフォーマット変換処理を実装
+  * 本モジュールを有効化したSentryClientを生成するための独自SentryClientFactoryを定義
+  * Playのリクエスト情報をスレッドローカル変数に保存するためのフィルタを定義
+  * Akkaでのスレッド起動時に、HTTP情報を持つスレッドローカル変数とlogbackのMDCを引き継ぐようにする処理を追加
+
+使い方
+----
+
+本モジュールの導入方法は以下のとおりです。
+
+1. Playアプリの依存に追加する
+
+```
+libraryDependencies ++= Seq(
+    "com.m3.play2" % "play2-sentry" % "X.Y.Z"
+)
+```
+
+2. sentry設定でfactoryを指定する
+
+**sentry.properties**
+```
+factory=com.m3.play2.sentry.PlaySentryFactory
+```
+
+3. Akkaのデフォルトdispatcherを本モジュールのクラスに指定する
+
+**application.conf**
+
+```
+play {
+  akka {
+    actor {
+      default-dispatcher = {
+        // Dispatcherを指定する
+        type = "com.m3.play2.sentry.SentryDispatcherConfigurator"
+      }
+    }
+  }
+}
+```
+
+4. HTTPフィルタにSentryLoggingFilterを追加
+
+```
+import com.m3.play2.sentry.SentryLoggingFilter
+
+class ApplicationComponents(context: Context) extends BuiltInComponentsFromContext(context) {
+  // filter を追加
+  override lazy val httpFilters = Seq(
+    new SentryLoggingFilter()
+  )
+}
+```
+
+5. Sentryの標準的な導入設定を行う
+
+参考: https://docs.sentry.io/clients/java/
+
+   * ログ出力設定でSentryAppenderを指定する
+   * アプリケーション固有のパッケージ名を明記
+   * etc...
+
+
+本モジュールの開発方法
+----
+
+### ビルド
+
+```
+$ sbt package
+```
+
+### ローカル環境での動作確認
+
+1. モジュールをivyのローカルキャッシュにインストールする
+
+```
+$ sbt publishLocal
+```
+
+2. 動作確認用Playアプリで、resolvers にローカルキャッシュディレクトリを追加する
+
+**build.sbt**
+
+```
+resolvers += "MyLocalIvy" at "file://"+Path.userHome.absolutePath+"/.ivy2/local"
+```
+
+3. アプリに組み込む
+
+4. アプリを実行する
+
+
+### artifactory にデプロイ
+
+以下のコマンドでartifactoryにjarを登録します
+
+```
+$ export REPOSITORY_URL={{デプロイ先のartifactoryのURL}}
+$ sbt clean package publish
+```
+

build.sbt

@@ -0,0 +1,29 @@
+
+scalaVersion := "2.11.8"
+
+javacOptions ++= Seq("-source", "1.7", "-target", "1.7")
+
+crossPaths := false
+
+organization := "com.m3.play2"
+
+name := "play2-sentry"
+
+version := "2.0.1-SNAPSHOT"
+
+libraryDependencies ++= Seq(
+  "io.sentry" % "sentry-logback" % "1.7.5",
+  "com.typesafe.play" % "play_2.11" % "2.4.11" % "provided"
+)
+
+publishTo := version { v: String =>
+  sys.env.get("REPOSITORY_URL").map { base =>
+    if (v.trim.endsWith("SNAPSHOT"))
+      "snapshots" at base + "libs-snapshots"
+    else
+      "releases" at base + "libs-releases"
+  }
+}.value
+
+resolvers += Resolver.typesafeRepo("releases")
+

project/build.properties

@@ -0,0 +1 @@
+sbt.version=1.2.1

src/main/scala/com/m3/play2/sentry/PlayHttpEventBuilderHelper.scala

@@ -0,0 +1,12 @@
+package com.m3.play2.sentry
+
+import io.sentry.event.EventBuilder
+import io.sentry.event.helper.EventBuilderHelper
+
+class PlayHttpEventBuilderHelper() extends EventBuilderHelper {
+
+  override def helpBuildingEvent(eventBuilder: EventBuilder): Unit = {
+    val hiOpt = SentryDispatcher.httpInterfaceValue.value
+    hiOpt.foreach( eventBuilder.withSentryInterface(_, false) )
+  }
+}

src/main/scala/com/m3/play2/sentry/PlayHttpInterface.scala

@@ -0,0 +1,66 @@
+package com.m3.play2.sentry
+
+import java.net.InetAddress
+
+import io.sentry.event.interfaces.SentryInterface
+import play.api.mvc.RequestHeader
+
+import scala.collection.Seq
+import scala.util.Try
+
+/**
+ * The HTTP interface of an Play2 HTTP request
+ */
+object PlayHttpInterface {
+  private val HTTP_INTERFACE = "sentry.interfaces.Http"
+
+  def apply(request: RequestHeader): PlayHttpInterface = {
+    val localHostAddress: Try[InetAddress] = Try(InetAddress.getLocalHost)
+
+    new PlayHttpInterface(
+      requestUrl = getRequestFullURL(request),
+      method = request.method,
+      parameters = request.queryString,
+      queryString = request.rawQueryString,
+      cookies = request.cookies.map { cookie => (cookie.name, cookie.value) }.toSeq,
+      headers = request.headers.toMap,
+      remoteAddr = request.remoteAddress,
+      serverName = request.host,
+      localAddr = localHostAddress.map(_.getHostAddress).getOrElse(""),
+      localName = localHostAddress.map(_.getHostName).getOrElse(""),
+      secure = request.secure
+    )
+  }
+
+  private def getRequestFullURL(request: RequestHeader) =
+    (if (request.secure) "https" else "http") + "://" + request.host + request.uri
+}
+
+/**
+ * Creates a an HTTP interface
+ */
+case class PlayHttpInterface(
+        // arguments of HTTP interface
+        requestUrl: String,
+        method: String,
+        parameters: Map[String, Seq[String]],
+        queryString: String,
+        cookies: Seq[(String, String)],
+        headers: Map[String, Seq[String]],
+
+        // environment data
+        remoteAddr: String,
+        serverName: String,
+        localAddr: String,
+        localName: String,
+        secure: Boolean) extends SentryInterface {
+
+  override def getInterfaceName: String = PlayHttpInterface.HTTP_INTERFACE
+
+  override def toString: String =
+    "PlayHttpInterface{" +
+    "requestUrl='" + requestUrl + "', " +
+    "method='" + method + "', " +
+    "parameters=" + parameters + '}'
+
+}

src/main/scala/com/m3/play2/sentry/PlayHttpInterfaceBinding.scala

@@ -0,0 +1,100 @@
+package com.m3.play2.sentry
+
+import java.io.IOException
+
+import com.fasterxml.jackson.core.JsonGenerator
+import io.sentry.marshaller.json.InterfaceBinding
+
+object PlayHttpInterfaceBinding {
+  private val URL = "url"
+  private val METHOD = "method"
+  private val DATA = "data"
+  private val QUERY_STRING = "query_string"
+  private val COOKIES = "cookies"
+  private val HEADERS = "headers"
+  private val ENVIRONMENT = "env"
+  private val ENV_REMOTE_ADDR = "REMOTE_ADDR"
+  private val ENV_SERVER_NAME = "SERVER_NAME"
+  private val ENV_LOCAL_ADDR = "LOCAL_ADDR"
+  private val ENV_LOCAL_NAME = "LOCAL_NAME"
+  private val ENV_REQUEST_SECURE = "REQUEST_SECURE"
+}
+
+class PlayHttpInterfaceBinding extends InterfaceBinding[PlayHttpInterface] {
+  import PlayHttpInterfaceBinding._
+
+  @throws[IOException]
+  override def writeInterface(generator: JsonGenerator, playHttpInterface: PlayHttpInterface): Unit = {
+    generator.writeStartObject()
+    generator.writeStringField(URL, playHttpInterface.requestUrl)
+    generator.writeStringField(METHOD, playHttpInterface.method)
+
+    generator.writeFieldName(DATA)
+    writeParameters(generator, playHttpInterface.parameters)
+
+    generator.writeStringField(QUERY_STRING, playHttpInterface.queryString)
+
+    generator.writeFieldName(COOKIES)
+    writeCookies(generator, playHttpInterface.cookies)
+
+    generator.writeFieldName(HEADERS)
+    writeHeaders(generator, playHttpInterface.headers)
+
+    generator.writeFieldName(ENVIRONMENT)
+    writeEnvironment(generator, playHttpInterface)
+
+    generator.writeEndObject()
+  }
+
+  @throws[IOException]
+  private def writeEnvironment(generator: JsonGenerator, playHttpInterface: PlayHttpInterface): Unit = {
+    generator.writeStartObject()
+    generator.writeStringField(ENV_REMOTE_ADDR, playHttpInterface.remoteAddr)
+    generator.writeStringField(ENV_SERVER_NAME, playHttpInterface.serverName)
+    generator.writeStringField(ENV_LOCAL_ADDR, playHttpInterface.localAddr)
+    generator.writeStringField(ENV_LOCAL_NAME, playHttpInterface.localName)
+    generator.writeBooleanField(ENV_REQUEST_SECURE, playHttpInterface.secure)
+    generator.writeEndObject()
+  }
+
+  @throws[IOException]
+  private def writeHeaders(generator: JsonGenerator, headers: Map[String, Seq[String]]): Unit = {
+    generator.writeStartObject()
+    headers.foreach {case (key, values) =>
+      generator.writeStringField(key, values.mkString(","))
+    }
+    generator.writeEndObject()
+  }
+
+  @throws[IOException]
+  private def writeCookies(generator: JsonGenerator, cookies: Seq[(String, String)]): Unit = {
+    if (cookies.isEmpty) {
+      generator.writeNull()
+
+    } else {
+      generator.writeStartObject()
+      cookies.foreach { case (key, value) =>
+        generator.writeStringField(key, value)
+      }
+      generator.writeEndObject()
+    }
+  }
+
+  @throws[IOException]
+  private def writeParameters(generator: JsonGenerator, parameterMap: Map[String, Seq[String]]): Unit = {
+    if (parameterMap.isEmpty) {
+      generator.writeNull()
+
+    } else {
+      generator.writeStartObject()
+
+      parameterMap.foreach { case (key, values) =>
+        generator.writeArrayFieldStart(key)
+        values.foreach { value => generator.writeString(value) }
+        generator.writeEndArray()
+      }
+
+      generator.writeEndObject()
+    }
+  }
+}

src/main/scala/com/m3/play2/sentry/PlaySentryFactory.scala

@@ -0,0 +1,26 @@
+package com.m3.play2.sentry
+
+import io.sentry._
+import io.sentry.dsn.Dsn
+import io.sentry.marshaller.Marshaller
+import io.sentry.marshaller.json.JsonMarshaller
+
+/**
+ * Custom sentry client factory for Play
+ *
+ * You need specify this class in the sentry settings (default sentry.properties file on classpath)
+ */
+class PlaySentryFactory extends DefaultSentryClientFactory {
+
+  override def createSentryClient(dsn: Dsn): SentryClient = {
+    val sentry = super.createSentryClient(dsn)
+    sentry.addBuilderHelper(new PlayHttpEventBuilderHelper)
+    sentry
+  }
+
+  override protected def createMarshaller(dsn: Dsn): Marshaller = {
+    val marshaller = super.createMarshaller(dsn).asInstanceOf[JsonMarshaller]
+    marshaller.addInterfaceBinding(classOf[PlayHttpInterface], new PlayHttpInterfaceBinding)
+    marshaller
+  }
+}