https://github.com/exceptionless/exceptionless.java
Exceptionless Java client
https://github.com/exceptionless/exceptionless.java
Last synced: 10 months ago
JSON representation
Exceptionless Java client
- Host: GitHub
- URL: https://github.com/exceptionless/exceptionless.java
- Owner: exceptionless
- License: apache-2.0
- Created: 2021-03-19T10:51:52.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-01-03T19:16:45.000Z (about 1 year ago)
- Last Synced: 2025-03-21T08:05:52.551Z (11 months ago)
- Language: Java
- Size: 319 KB
- Stars: 5
- Watchers: 4
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Exceptionless.Java
The definition of the word exceptionless is: to be without exception. [Exceptionless](https://exceptionless.io) provides
real-time error reporting for your Java apps. It organizes the gathered information into simple actionable data that
will help your app become exceptionless!
## Using Exceptionless
Refer to the Exceptionless documentation here: [Exceptionless Docs](http://docs.exceptionless.io).
This project is available to install through Maven.
```
com.exceptionless
exceptionless-client
0.1.0
```
Check the latest version of the library [here](https://mvnrepository.com/artifact/com.exceptionless/exceptionless-client)
## Show me the code
```java
class ExampleApp {
public static void main(String[] args) {
private static final ExceptionlessClient client =
ExceptionlessClient.from(
System.getenv("EXCEPTIONLESS_SAMPLE_APP_API_KEY"),
System.getenv("EXCEPTIONLESS_SAMPLE_APP_SERVER_URL"));
// Submit different events using submitXXX methods
client.submitLog("Test log");
// Submit custom methods using our createXXX methods
client.submitEvent(
EventPluginContext.from(
client.createLog("test-log").referenceId("test-reference-id").build()));
}
}
```
**Builder Pattern**
We love our builders!!! This project heavily utilized the use of builders instead of traditional object creation
using `new`. We do this with the help of Project Lombok's `@Builder` annotation. Read more about the
project [here](https://projectlombok.org/features/all). Read more about the
annotation [here](https://projectlombok.org/features/Builder). Read more about the builder
pattern [here](https://refactoring.guru/design-patterns/builder).
_Example: Customizing your Event Queue implementation_
```
EventQueueIF queue = //get your implementation
Configuration configuration = Configuration.builder()
.serverUrl("http://your-server-url")
.apiKey("your-api-key")
.queue(queue)
.build();
ExceptionlessClient client = ExceptionlessClient.builder().configuration(configuration).build();
```
In this library we have made sure that all the values which are not set by builders fallback to reasonable defaults. So
don't feel the pressure to supply values for all the fields. **Note:** Whenever customizing the client
using `Configuration` never forget to supply your `serverUrl` and `apiKey` using a `Configuration` object as
shown above.
## Getting Started (Development)
### Intellij
1. You will need to install:
* [Intellij](https://www.jetbrains.com/idea/download/)
* **Note:** In Intellij you can directly [download JDK 11 from the IDE](https://www.jetbrains.com/help/idea/sdk.html#jdk-from-ide). Intellij also comes with a bundled Maven installation and built-in Lombok support.
2. Clone the repo
3. Verify your setup using `mvn clean verify`
### VSCode
1. You will need to install:
* [VSCode](https://code.visualstudio.com/download)
* [JDK 11](https://www.oracle.com/ie/java/technologies/javase-downloads.html). Make sure that your `java --version` and `$JAVA_HOME` environment variable point to the correct jdk.
* [VSCode Java extension pack](https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-java-pack)
* [VSCode Lombok extension](https://marketplace.visualstudio.com/items?itemName=GabrielBB.vscode-lombok)
2. Clone the repo
3. Verify your setup using `mvn clean verify`
## Spring Boot Users
You can observe `NoClassDefFoundError` in your Spring-boot apps because Spring-boot uses v3 of `OkHttpClient` while this
client uses v4. In that case you have to explicitly declare v4 of the library in you `pom.xml/build.gradle`.
```xml
com.exceptionless
exceptionless-client
0.1.0
org.springframework.boot
spring-boot-starter-web
com.squareup.okhttp3
okhttp
4.9.1
```
## VSCode Users
We are using [Project Lombok](https://projectlombok.org/) to automatically generate a lot of code. Intellij can give you IntelliSense by default but for VSCode you may have to install [this extension](https://marketplace.visualstudio.com/items?itemName=GabrielBB.vscode-lombok).
## General Data Protection Regulation
By default the Exceptionless Client will report all available metadata including potential PII data. You can fine tune
the collection of information via Data Exclusions or turning off collection completely.
Please visit
the [docs](https://exceptionless.com/docs/clients/javascript/client-configuration/#general-data-protection-regulation)
for detailed information on how to configure the client to meet your requirements.
## Support
If you need help, please contact us via in-app
support, [open an issue](https://github.com/exceptionless/Exceptionless.Java/issues/new)
or [join our chat on Discord](https://discord.gg/6HxgFCx). We’re always here to help if you have any questions!
## Thanks
Thanks to all the people who have contributed!
[](https://github.com/exceptionless/Exceptionless.Java/graphs/contributors)