1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
|
---
title: kamon | NewRelic Module | Documentation
layout: default
---
NewRelic Module
===
A simple module to report some application metrics like External Services, Errors and Apdex.
## Usage
### SBT settings
Add the following sbt dependencies to your project settings:
```scala
libraryDependencies += "org.kamon" % "kamon-newrelic" % "0.1.0"
libraryDependencies += "com.newrelic.agent.java" % "newrelic-api" % "3.1.0"
```
### Configuration
```scala
-javaagent:/path-to-newrelic-agent.jar, -Dnewrelic.environment=production, -Dnewrelic.config.file=/path-to-newrelic.yml
```
### Screenshot
## Limitations
* The first implementation only supports a subset of NewRelic metrics
## Licensing
NewRelic has [its own, separate licensing](http://newrelic.com/terms).
Documentation
===
Dependencies
---
Apart from scala library kamon depends on:
- aspectj
- new relic agent
- 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. If you are a new relic user, you will requiere to add a logger to the application.conf file
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. Add the following sbt dependencies to your project settings:
1. Add Kamon repository to resolvers
```scala
"Kamon Repository" at "http://repo.kamon.io"
```
2. Add libraryDepenency
```scala
"kamon" %% "kamon-spray" % "0.0.11",
"kamon" %% "kamon-newrelic" % "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. You need to add the sbt-newrelic plugin
```scala
resolvers += Resolver.url("Kamon Releases",
url("http://repo.kamon.io"))(Resolver.ivyStylePatterns)
addSbtPlugin("com.ivantopo.sbt" %% "sbt-newrelic" % "0.0.1")
addSbtPlugin("com.typesafe.sbt" % "sbt-aspectj" % "0.9.2")
```
In addittion, you have to provide the new relic agent and configure a logger in application.conf file.
**application.conf**
```scala
akka {
loggers = ["akka.event.slf4j.Slf4jLogger","kamon.newrelic.NewRelicErrorLogger"]
extensions = ["kamon.newrelic.NewRelic"]
actor {
debug {
unhandled = on
}
}
}
```
Examples
---
The examples will start a spray server with akka, new relic and logback configuration. Adjust it to your needs in order to see the data in your new relic service.
Follow the steps in order to clone the repository
1. git clone git://github.com/kamon/kamon.git
2. cd kamon
run
```bash
sbt "project kamon-new-relic-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'
```
|
