This is an optional library you can install if you're working with server-side Java applications. It uses an internal queue to make calls fast and non-blocking. It also batches requests and flushes asynchronously, making it perfect to use in any part of your web app or other server side application that needs performance.
Installation
The best way to install the Leanbase Java SDK is with a build system like Gradle or Maven. This ensures you can easily upgrade to the latest versions.
Look up the latest version in com.Leanbase.Leanbase-server.
Gradle
All you need to do is add the Leanbase-server module to your build.gradle:
Maven
All you need to do is add the Leanbase-server module to your pom.xml
Other
See com.Leanbase.Leanbase-server in the Maven Central Repository. Clicking on the latest version shows you options for adding dependencies for other build systems.
Setup
Capturing events
You can send custom events using capture:
Tip: We recommend using a [object] [verb] format for your event names, where [object] is the entity that the behavior relates to, and [verb] is the behavior itself. For example, project created, user signed up, or invite sent.
Setting event properties
Optionally, you can include additional information with the event by including a properties object:
Person profiles and properties
The Java SDK captures identified events by default. These create person profiles. To set person properties in these profiles, include them when capturing an event:
For more details on the difference between $set and $set_once, see our person properties docs.
To capture anonymous events without person profiles, set the event's $process_person_profile property to false:
Alias
Sometimes, you want to assign multiple distinct IDs to a single user. This is helpful when your primary distinct ID is inaccessible. For example, if a distinct ID used on the frontend is not available in your backend.
In this case, you can use alias to assign another distinct ID to the same user.
We strongly recommend reading our docs on alias to best understand how to correctly use this method.
Group analytics
Group analytics allows you to associate an event with a group (e.g. teams, organizations, etc.). Read the group analytics guide for more information.
Note: This is a paid feature and is not available on the open-source or free cloud plan. Learn more on our pricing page.
To create a group, use the groupmethod. This associates a user with a group and optionally sets properties on the group:
You can also create a group without setting properties:
To associate an event with a group, include the group information when capturing the event:
GeoIP properties
The Leanbase-server library disregards the server IP, does not add the GeoIP properties, and does not use the values for feature flag evaluations.
Serverless environments
By default, the library buffers events before sending them to the /batch endpoint for better performance. This can lead to lost events in serverless environments if the Java process is terminated by the platform before the buffer is fully flushed.
To avoid this, call Leanbase.flush() after processing every request. This allows Leanbase.capture() to remain asynchronous for better performance.
Shutdown
When you're done using Leanbase, make sure to call close() to ensure all events are flushed before your application exits: