diff options
author | Ivan Topolnjak <ivantopo@gmail.com> | 2014-05-25 18:31:17 -0300 |
---|---|---|
committer | Ivan Topolnjak <ivantopo@gmail.com> | 2014-05-25 18:31:17 -0300 |
commit | 05007f1011de8ea352ee23725ae46c51f5d67338 (patch) | |
tree | 2a3b044adfadf0caa5fcc4c3de84c2fe8baf97ef /site/src/main/jekyll/integrations | |
parent | bcba7829a885813b0f67e396faf044cda14a798f (diff) | |
download | Kamon-05007f1011de8ea352ee23725ae46c51f5d67338.tar.gz Kamon-05007f1011de8ea352ee23725ae46c51f5d67338.tar.bz2 Kamon-05007f1011de8ea352ee23725ae46c51f5d67338.zip |
! site: introduce a navigation tree on documentation pages and reorder the site structure accordingly
Diffstat (limited to 'site/src/main/jekyll/integrations')
5 files changed, 121 insertions, 0 deletions
diff --git a/site/src/main/jekyll/integrations/akka/index.md b/site/src/main/jekyll/integrations/akka/index.md new file mode 100644 index 00000000..6ca89409 --- /dev/null +++ b/site/src/main/jekyll/integrations/akka/index.md @@ -0,0 +1,97 @@ +--- +title: kamon | Akka Toolkit | Documentation +layout: documentation +--- + +Akka Module +=== + +--- +Dependencies +--- + +Apart from scala library kamon depends on: + +- aspectj +- spray-io +- akka-actor + + +Installation +--- +Kamon works with SBT, so you need to add Kamon.io repository to your resolvers. + +Configuration +--- +Just like other products in the scala ecosystem, it relies on the typesafe configuration library. + +Since kamon uses the same configuration technique as [Spray](http://spray.io/documentation "Spray") / [Akka](http://akka.io/docs "Akka") you might want to check out the [Akka-Documentation-configuration](http://doc.akka.io/docs/akka/2.1.4/general/configuration.html "Akka Documentation on configuration") +. + +In order to see Kamon in action you need first to set up your sbt project. + +1) Add Kamon repository to resolvers + +```scala +"Kamon Repository" at "http://repo.kamon.io" +``` + +2) Add libraryDepenency + +```scala + "kamon" %% "kamon-spray" % "0.0.11", +``` + +In addition we suggest to create aspectj.sbt file and add this content + +```scala + import com.typesafe.sbt.SbtAspectj._ + + aspectjSettings + + javaOptions <++= AspectjKeys.weaverOptions in Aspectj +``` + +3) Add to your plugins.sbt in project folder (if you don't have one yet, create the file) and add the Kamon release to the resolver and the aspecj. + +```scala + resolvers += Resolver.url("Kamon Releases", url("http://repo.kamon.io"))(Resolver.ivyStylePatterns) + + addSbtPlugin("com.typesafe.sbt" % "sbt-aspectj" % "0.9.2") +``` +**application.conf** + +```scala + akka { + loggers = ["akka.event.slf4j.Slf4jLogger"] + + actor { + debug { + unhandled = on + } + } + } +``` + +Examples +--- + +TODO: (to be published) The example will start a spray server with akka and logback configuration. Adjust it to your needs. + +Follow the steps in order to clone the repository + +1. git clone git://github.com/kamon/kamon.git + +2. cd kamon + +For the first example run + +```bash + sbt "project kamon-uow-example" +``` + +In order to see how it works, you need to send a message to the rest service + +```bash + curl -v --header 'X-UOW:YOUR_TRACER_ID' -X GET 'http://0.0.0.0:6666/fibonacci' +``` diff --git a/site/src/main/jekyll/integrations/play/applications.md b/site/src/main/jekyll/integrations/play/applications.md new file mode 100644 index 00000000..97918dc5 --- /dev/null +++ b/site/src/main/jekyll/integrations/play/applications.md @@ -0,0 +1,4 @@ +--- +title: kamon | Play | Documentation +layout: documentation +---
\ No newline at end of file diff --git a/site/src/main/jekyll/integrations/play/ws-library.md b/site/src/main/jekyll/integrations/play/ws-library.md new file mode 100644 index 00000000..97918dc5 --- /dev/null +++ b/site/src/main/jekyll/integrations/play/ws-library.md @@ -0,0 +1,4 @@ +--- +title: kamon | Play | Documentation +layout: documentation +---
\ No newline at end of file diff --git a/site/src/main/jekyll/integrations/spray/client-side.md b/site/src/main/jekyll/integrations/spray/client-side.md new file mode 100644 index 00000000..15b41c72 --- /dev/null +++ b/site/src/main/jekyll/integrations/spray/client-side.md @@ -0,0 +1,8 @@ +--- +title: kamon | Spray | Documentation +layout: documentation +--- + +Spray Module(TODO) +=== + diff --git a/site/src/main/jekyll/integrations/spray/server-side.md b/site/src/main/jekyll/integrations/spray/server-side.md new file mode 100644 index 00000000..15b41c72 --- /dev/null +++ b/site/src/main/jekyll/integrations/spray/server-side.md @@ -0,0 +1,8 @@ +--- +title: kamon | Spray | Documentation +layout: documentation +--- + +Spray Module(TODO) +=== + |