https://github.com/noel-archive/analytics-jvm
🌂 Client and server implementation of Noelware Analytics in Kotlin using Ktor
https://github.com/noel-archive/analytics-jvm
analytics java kotlin noelware-analytics
Last synced: 3 months ago
JSON representation
🌂 Client and server implementation of Noelware Analytics in Kotlin using Ktor
- Host: GitHub
- URL: https://github.com/noel-archive/analytics-jvm
- Owner: noel-archive
- License: mit
- Archived: true
- Created: 2022-05-09T08:11:03.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-06-08T02:32:50.000Z (almost 2 years ago)
- Last Synced: 2025-03-16T08:14:17.895Z (3 months ago)
- Topics: analytics, java, kotlin, noelware-analytics
- Language: Java
- Homepage: https://docs.noelware.org/analytics/jvm
- Size: 311 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# 🐻❄️🌂 Noelware Analytics for JVM
> *JVM support for using [Noelware Analytics](https://analytics.noelware.org) for your applications.*
>
> v0.1-beta | [:scroll: **Documentation**](https://analytics.noelware.org/docs/support/jvm)
**Noelware Analytics for JVM** (`analytics-jvm`) is a library to support client and server support of the Noelware Analytics
[protocol](https://analytics.noelware.org/docs/protocol) for the JVM with Kotlin support.
The library comes in a form of plugins to plug in external sources to include in your Noelware Analytics instance that can be visualised
on the web dashboard.
## Usage
### Client
You will need the instance service token to use the client for yourself.
```java
// Add the "org.noelware.analytics:client:" to the project before
// copying.
import org.noelware.analytics.jvm.client.blocking.BlockingAnalyticsClient;
import org.noelware.analytics.jvm.client.responses.ConnectionAckResponse;
import org.noelware.analytics.jvm.client.responses.InstanceStatsResponse;
import org.noelware.analytics.jvm.client.query.QueryBuilder;
// The client also supports asynchronous clients that use the CompletableFuture
// API. This will only demonstrate the blocking APIs.
public class Program {
public static void main(String[] args) {
final BlockingAnalyticsClient client = new BlockingAnalyticsClient.Builder()
.withServiceToken("")
.withChannelBuilder(builder -> {
// builder => the gRPC channel builder
builder.usePlaintext();
})
.build();
final ConnectionAckResponse res = client.connect();
System.out.println("connected? " + res.connected() ? "yes" : "no");
final InstanceStatsResponse stats = client.collectStats();
System.out.println(stats);
}
}
```
### Server
You will still need your instance service token to validate requests from incoming traffic. The service token holds as a way to
block traffic that isn't from any client that doesn't have the service token available.
```java
import org.noelware.analytics.jvm.server.extensions.jvm.JvmMemoryPoolExtension;
import org.noelware.analytics.jvm.server.extensions.jvm.JvmThreadsPluginExtension;
import org.noelware.analytics.jvm.server.AnalyticsServerBuilder;
import org.noelware.analytics.jvm.server.AnalyticsServer;
public class Program {
public static void main(String[] args) {
final AnalyticsServer server = new AnalyticsServerBuilder(55123)
.withExtensions(new JvmMemoryPoolPlugin(), new JvmThreadsPlugin())
.withServiceToken("")
.build();
server.start();
}
}
```
## Installation
### Gradle (Groovy)
```groovy
repositories {
maven 'https://maven.noelware.org'
gradlePluginPortal()
mavenCentral()
}
dependencies {
implementation 'org.noelware.analytics:bom:'
}
```
### Gradle (Kotlin DSL)
```kotlin
repositories {
maven("https://maven.noelware.org")
gradlePluginPortal()
mavenCentral()
}
dependencies {
implementation("org.noelware.analytics:analytics-bom:")
implementation("org.noelware.analytics:client")
}
```
### Maven
```xml
https://maven.noelware.org
org.noelware.analytics
analytics-bom
{VERSION}
pom
```
## Contributing
Thanks for considering contributing to **analytics-jvm**! Before you boop your heart out on your keyboard ✧ ─=≡Σ((( つ•̀ω•́)つ, we recommend you to do the following:
- Read the [Code of Conduct](./.github/CODE_OF_CONDUCT.md)
- Read the [Contributing Guide](./.github/CONTRIBUTING.md)
If you read both if you're a new time contributor, now you can do the following:
- [Fork me! ＊*♡( ⁎ᵕᴗᵕ⁎ ）](https://github.com/Noelware/analytics-jvm/fork)
- Clone your fork on your machine: `git clone https://github.com/your-username/analytics-jvm`
- Create a new branch: `git checkout -b some-branch-name`
- BOOP THAT KEYBOARD!!!! ♡┉ˏ͛ (❛ 〰 ❛)ˊˎ┉♡
- Commit your changes onto your branch: `git commit -am "add features （｡>‿‿<｡ ）"`
- Push it to the fork you created: `git push -u origin some-branch-name`
- Submit a Pull Request and then cry! ｡･ﾟﾟ･(థ Д థ。)･ﾟﾟ･｡
## License
**Noelware Analytics for JVM** (`analytics-jvm`) is released under the **MIT License** by Noelware, with love. :3