Scala Shell
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
project
src
.gitignore
.travis.yml
CONTRIBUTING.md
LICENSE
README.md
build.sbt
travis-test.sh
version.sbt

README.md

JDBC Integration Build Status

Gitter Maven Central

The kamon-jdbc module brings bytecode instrumentation to trace jdbc-compatible database requests

The kamon-jdbc module requires you to start your application using the AspectJ Weaver Agent. Kamon will warn you at startup if you failed to do so.

The bytecode instrumentation provided by the kamon-jdbc module hooks into the JDBC API to automatically start and finish segments for requests that are issued within a trace. This translates into you having metrics about how the requests you are doing are behaving.

Getting Started

Kamon scala module is currently available for Scala 2.10, 2.11 and 2.12.

Supported releases and dependencies are shown below.

kamon-jdbc status jdk scala akka
0.6.5 stable 1.7+, 1.8+ 2.10, 2.11, 2.12 2.3.x, 2.4.x

To get started with SBT, simply add the following to your build.sbt file:

libraryDependencies += "kamon.io" %% "kamon-jdbc" % "0.6.5"

Metrics

The following metrics will be recorded:

  • reads: a histogram that tracks the reads requests latency (SELECT statement).
  • writes: a histogram that tracks the writes requests latency (INSERT, UPDATE, and DELETE statements).
  • slows: a simple counter with the number of measured slow requests.
  • errors: a simple counter with the number of failures.

Naming Segments

By default, the name generator bundled with the kamon-jdbc module will use the statement name as tge name to the automatically generated segment (i.e SELECT, INSERT, etc). Currently, the only way to override that name would be to provide your own implementation of kamon.jdbc.JdbcNameGenerator which is used to assign the segment name

Slow Requests

Requests that take longer to execute than the configured kamon.jdbc.slow-query-threshold can be processed by user-defined kamon.jdbc.DefaultSlowQueryProcessor. The default processor logs a warning message

Error Processor

Requests that error can be processed by user-defined kamon.jdbc.SqlErrorProcessor. The default processor logs an error message

Configuration

kamon {
  jdbc {
    slow-query-threshold = 2 seconds

    # Fully qualified name of the implementation of kamon.jdbc.SlowQueryProcessor.
    slow-query-processor = kamon.jdbc.DefaultSlowQueryProcessor

    # Fully qualified name of the implementation of kamon.jdbc.SqlErrorProcessor.
    sql-error-processor = kamon.jdbc.DefaultSqlErrorProcessor

    # Fully qualified name of the implementation of kamon.jdbc.JdbcNameGenerator that will be used for assigning names to segments.
    name-generator = kamon.jdbc.DefaultJdbcNameGenerator
  }
}