This application demonstrates a simple Honeycomb instrumentation of a Spring Boot application. It is CRUD interface for managing a TODOs list. The backend is an in-memory H2 database.

Events are created per-HTTP-request (following the Honeycomb one event per unit of work model) using a Spring Handler Interceptor to capture request/response data and use the libhoney-java SDK to send events to HoneyComb. A request context is propagated throughout the app (using Spring's request scope) allowing other parts of the request processing to be instrumented. Calls to the SQL backend are instrumented as an example. This is a straightforward approach to context propagation which you can enhance using other parts of the Spring framework. For example, the Spring Data repository calls could be instrumented using AOP (as in this example given by Spring).

Set your HoneyComb write key and the dataset you want to report to by using the application.properties file.

This application requires Java 8.

You can build an executable jar in the module target directory using gradle wapper:

./gradlew build

open console and execute command to run .jar file created:

java -jar PATH_PROJECT/build/libs/libhoney-java-example-webapp-1.0.2-capsule.jar

open browser:

http://localhost:8080

The project is running.

You can set other 'global' SDK properties in the application.properties file, including setting any 'global fields'. These are fields that will be included in any event sent (unless overridden at a more specific scope, e.g. the event level). See the SDK documentation for more detail on how 'global fields' are resolved.

The default configuration adds two global fields as follows:

honeycomb.global-fields.app.name: example-web-app
honeycomb.global-fields.app.region: us-west-1

app.name: example-web-app
app.region: us-west-1

$ curl \
    -H 'Content-Type: application/json' \
    -X POST -d '{"description": "Walk the dog", "due": 1518816723}' \
    localhost:8080/todos/
...

$ curl localhost:8080/todos/
[
  {
    "completed": false,
    "description": "Walk the dog",
    "due": "Fri, 16 Feb 2018 21:32:03 GMT",
    "id": 1
  }
]

$ curl -X PUT \
    -H 'Content-Type: application/json' \
    -d '{"description": "Walk the cat"}' \
    localhost:8080/todos/1/
{
  "completed": false,
  "description": "Walk the cat",
  "due": "Fri, 16 Feb 2018 21:32:03 GMT",
  "id": 1
}

$ curl -X DELETE localhost:8080/todos/1/
{
  "id": 1,
  "success": true
}

$ curl localhost:8080/todos/
[]