Skip to content

Latest commit

 

History

History
91 lines (63 loc) · 4.82 KB

README.md

File metadata and controls

91 lines (63 loc) · 4.82 KB
Raw

Java Analytics for Snowplow

maintained Build Release License

Overview

Add analytics to your Java software with the Snowplow event tracker for Java. See also: Snowplow Android Tracker.

With this tracker you can collect event data from your Java-based desktop and server apps, servlets and games. Supports JDK8+.

Find out more

Snowplow Docs API Docs Contributing
i1 i1 i4
Snowplow Docs Javadoc Docs Contributing

Maintainer Quickstart

Feedback and contributions are very welcome. If you have identified a bug, please log an issue on this repo. For all other feedback, discussion or questions please open a thread on our Discourse forum. Feel free to make Pull Requests for new features, if you can code them yourself!

Clone this repo and navigate into the cloned folder. To run the tests locally, you will need Docker or Java installed. Using either method, the build will fail if there are failing tests.

To run the tests using Docker, run:

$ docker build . -t snowplow-java-tracker

To run the tests using your installed JDK, run:

$ ./gradlew build

We have also included a simple demo, found in the examples/simple-console folder. You will need a JDK installed to run it. When run, it sends several events to your event collector. For a simple event collector, we advise using the Snowplow Micro testing pipeline.

To run simple-console using the current Maven Central version of the Java tracker:

$ cd examples/simple-console
$ ./gradlew jar
$ java -jar ./build/libs/simple-console-all-0.0.1.jar "http://<your-collector-domain>"

To run simple-console using a local version of the Java tracker:

$ ./gradlew publishToMavenLocal
$ cd examples/simple-console
$ ./gradlew jar
$ java -jar ./build/libs/simple-console-all-0.0.1.jar "http://<your-collector-domain>"

Copyright and license

The Snowplow Java Tracker is copyright 2014-present Snowplow Analytics Ltd.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this software except in compliance with the License.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.