aboutsummaryrefslogtreecommitdiff
path: root/site/src/main/jekyll/get-started.md
diff options
context:
space:
mode:
authorIvan Topolnjak <ivantopo@gmail.com>2014-03-05 08:04:57 -0300
committerIvan Topolnjak <ivantopo@gmail.com>2014-03-16 23:24:23 -0300
commit34f38dc1cc22b20f007f19a28f8c42c26e034a69 (patch)
tree68b2d31a1b64d4ab0ff7801c1bfacd64577447e8 /site/src/main/jekyll/get-started.md
parenta8b465358fac2534f98dcbcac6c076ac98015abc (diff)
downloadKamon-34f38dc1cc22b20f007f19a28f8c42c26e034a69.tar.gz
Kamon-34f38dc1cc22b20f007f19a28f8c42c26e034a69.tar.bz2
Kamon-34f38dc1cc22b20f007f19a28f8c42c26e034a69.zip
basic traces documentation
Diffstat (limited to 'site/src/main/jekyll/get-started.md')
-rw-r--r--site/src/main/jekyll/get-started.md60
1 files changed, 60 insertions, 0 deletions
diff --git a/site/src/main/jekyll/get-started.md b/site/src/main/jekyll/get-started.md
new file mode 100644
index 00000000..d27428cc
--- /dev/null
+++ b/site/src/main/jekyll/get-started.md
@@ -0,0 +1,60 @@
+---
+title: Kamon | Get Started
+layout: default
+---
+
+Get Started with Kamon
+======================
+
+Kamon is distrubuted as a set of libraries that you include in your application classpath. This libraries contain all the
+required pointcuts and advices (yeap, Kamon uses Aspectj!) for instrumenting Akka actors message passing, dispatchers, futures,
+Spray components and much more.
+
+To get started just follow this steps:
+
+
+First: Include the modules you want in your project.
+----------------------------------------------------
+
+All Kamon libraries are available through the official Kamon repository:
+
+```scala
+ "Kamon Repository" at "http://repo.kamon.io"
+```
+
+Then, add the libraries to your project. If you are using SBT this minimal build.sbt file should be helpful:
+
+```scala
+
+resolvers += "Kamon Repository" at "http://repo.kamon.io"
+
+libraryDependencies += "kamon" %% "kamon-core" % "0.0.11"
+
+```
+
+Additionally you can add any modules you want to your app:
+
+- kamon-core
+- kamon-spray
+- kamon-newrelic
+- kamon-dashboard (coming soon)
+
+
+Second: Start your app with the AspectJ Weaver
+----------------------------------------------
+
+Starting your app with the AspectJ weaver is dead simple, just add the `-javaagent` JVM startup parameter pointing to the
+weaver's file location and you are done:
+
+```
+-javaagent:/path-to-aspectj-weaver.jar
+```
+
+In case you want to keep the AspectJ related settings in your build and enjoy using `run` from the console, take a look at
+the [sbt-aspectj](https://github.com/sbt/sbt-aspectj/) plugin.
+
+
+Third: Enjoy!
+-------------
+
+Refer to modules documentation (coming soon) to find out what Kamon is doing for you. \ No newline at end of file