added usage

agorapulse · May 24, 2024 · d38f6d7 · d38f6d7
1 parent 4f68a18
commit d38f6d7
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/docs/guide/src/docs/asciidoc/usage.adoc b/docs/guide/src/docs/asciidoc/usage.adoc
@@ -21,3 +21,7 @@ WARNING: If you use the library in a non-Micronaut environment (e.g., Grails), e
 
 The events can optionally implement the `NewRelicInsightsEvent` interface,
 which let you fine-tune the `eventType` and `timestamp` properties.
+
+There might be some HTTP communication issues when communicating with the NewRelic Insights API when using the HTTP client. By default, the error is only logged as a warning. You can fine tune the logging level by setting `newrelic.log-level` Micronaut property to one of the possible values: `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`, `OFF`.
+
+You can mark your events with `@Critical` annotation to try to retry the event delivery when there is any communication issue such as connection timeout or reset. The default number of retries is 3, but you can change it by setting the `newrelic.retry-count` Micronaut property. If you are using `NewRelicInsightsEvent` interface, you can also mark your event critical by returning `true` from the `isCritical` method. If you are not implementing the `NewRelicInsightsEvent` interface then you can still add `critical` property to your event and set it to `true`.