Skip to content

Commit 0861db1

Browse files
committed
Update documentation
1 parent c808e0c commit 0861db1

File tree

2 files changed

+27
-27
lines changed

2 files changed

+27
-27
lines changed

README.md

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Exceptionless.Java
22

3-
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!
3+
The definition of the word exceptionless is: to be without exception. [Exceptionless](https://exceptionless.io) provides
4+
real-time error reporting for your Java apps. It organizes the gathered information into simple actionable data that
5+
will help your app become exceptionless!
46

57
## Using Exceptionless
68

@@ -11,7 +13,7 @@ Refer to the Exceptionless documentation here: [Exceptionless Docs](http://docs.
1113
## Show me the code
1214

1315
```java
14-
class ExampleApp{
16+
class ExampleApp {
1517
public static void main(String[] args) {
1618
private static final ExceptionlessClient client =
1719
ExceptionlessClient.from(
@@ -44,24 +46,26 @@ _Example: Customizing your Event Queue implementation_
4446

4547
```
4648
EventQueueIF queue = //get your implementation
47-
Configuration configuration =
48-
Configuration.builder().serverUrl("http://your-server-url").apiKey("your-api-key").build();
49-
ConfigurationManager configuration =
50-
ConfigurationManager.builder().queue(queue).configuration(configuration).build();
51-
ExceptionlessClient client =
52-
ExceptionlessClient.builder().configuration(configuration).build();
49+
Configuration configuration = Configuration.builder()
50+
.serverUrl("http://your-server-url")
51+
.apiKey("your-api-key")
52+
.queue(queue)
53+
.build();
54+
ExceptionlessClient client = ExceptionlessClient.builder().configuration(configuration).build();
5355
```
5456

5557
In this library we have made sure that all the values which are not set by builders fallback to reasonable defaults. So
5658
don't feel the pressure to supply values for all the fields. **Note:** Whenever customizing the client
57-
using `ConfigurationManager` never forget to supply your `serverUrl` and `apiKey` using a `Configuration` object as
59+
using `Configuration` never forget to supply your `serverUrl` and `apiKey` using a `Configuration` object as
5860
shown above.
5961

6062
## Spring Boot Users
6163

62-
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`.
64+
You can observe `NoClassDefFoundError` in your Spring-boot apps because Spring-boot uses v3 of `OkHttpClient` while this
65+
client uses v4. In that case you have to explicitly declare v4 of the library in you `pom.xml/build.gradle`.
6366

6467
```xml
68+
6569
<dependencies>
6670
<dependency>
6771
<groupId>com.exceptionless</groupId>
@@ -83,15 +87,18 @@ You can observe `NoClassDefFoundError` in your Spring-boot apps because Spring-b
8387

8488
## General Data Protection Regulation
8589

86-
By default the Exceptionless Client will report all available metadata including potential PII data.
87-
You can fine tune the collection of information via Data Exclusions or turning off collection completely.
90+
By default the Exceptionless Client will report all available metadata including potential PII data. You can fine tune
91+
the collection of information via Data Exclusions or turning off collection completely.
8892

89-
Please visit the [docs](https://exceptionless.com/docs/clients/javascript/client-configuration/#general-data-protection-regulation)
93+
Please visit
94+
the [docs](https://exceptionless.com/docs/clients/javascript/client-configuration/#general-data-protection-regulation)
9095
for detailed information on how to configure the client to meet your requirements.
9196

9297
## Support
9398

94-
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!
99+
If you need help, please contact us via in-app
100+
support, [open an issue](https://github.com/exceptionless/Exceptionless.Java/issues/new)
101+
or [join our chat on Discord](https://discord.gg/6HxgFCx). We’re always here to help if you have any questions!
95102

96103
## Thanks
97104

src/main/java/com/exceptionless/exceptionlessclient/ExceptionlessClient.java

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -35,19 +35,16 @@ public class ExceptionlessClient {
3535
@Builder
3636
public ExceptionlessClient(Configuration configuration, Integer nThreads) {
3737
this(
38-
configuration,
38+
configuration,
3939
UPDATE_SETTINGS_TIMER_INITIAL_DELAY,
4040
nThreads == null ? DEFAULT_NTHREADS : nThreads);
4141
}
4242

4343
@VisibleForTesting
4444
ExceptionlessClient(
45-
Configuration configuration,
46-
long updateSettingsTimerInitialDelay,
47-
Integer nThreads) {
45+
Configuration configuration, long updateSettingsTimerInitialDelay, Integer nThreads) {
4846
this.configuration = configuration;
49-
this.eventPluginRunner =
50-
EventPluginRunner.builder().configuration(this.configuration).build();
47+
this.eventPluginRunner = EventPluginRunner.builder().configuration(this.configuration).build();
5148
this.updateSettingsTimer = new Timer(UPDATE_SETTINGS_TIMER_NAME);
5249
this.executorService = Executors.newFixedThreadPool(nThreads);
5350
init(updateSettingsTimerInitialDelay);
@@ -68,8 +65,7 @@ public void run() {
6865
delay,
6966
configuration.getUpdateSettingsWhenIdleInterval().get());
7067

71-
configuration.onChanged(
72-
ignored -> configuration.getSettingsManager().updateSettings());
68+
configuration.onChanged(ignored -> configuration.getSettingsManager().updateSettings());
7369
configuration
7470
.getQueue()
7571
.onEventsPosted(
@@ -78,8 +74,7 @@ public void run() {
7874

7975
public static ExceptionlessClient from(String apiKey, String serverUrl) {
8076
return ExceptionlessClient.builder()
81-
.configuration(
82-
Configuration.builder().apiKey(apiKey).serverUrl(serverUrl).build())
77+
.configuration(Configuration.builder().apiKey(apiKey).serverUrl(serverUrl).build())
8378
.build();
8479
}
8580

@@ -220,9 +215,7 @@ public Event.EventBuilder createSessionStart() {
220215
}
221216

222217
public Event.EventBuilder createEvent() {
223-
return Event.builder()
224-
.dataExclusions(configuration.getDataExclusions())
225-
.date(LocalDate.now());
218+
return Event.builder().dataExclusions(configuration.getDataExclusions()).date(LocalDate.now());
226219
}
227220

228221
public CompletableFuture<Void> submitEventAsync(Event event) {

0 commit comments

Comments
 (0)