Update javadoc

opensearch-project · Jul 21, 2023 · 4ea9921 · 4ea9921
1 parent fc22f60
commit 4ea9921
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/...elemetry/src/main/java/org/opensearch/telemetry/diagnostics/DiagnosticsEventListener.java b/...elemetry/src/main/java/org/opensearch/telemetry/diagnostics/DiagnosticsEventListener.java
@@ -18,6 +18,8 @@
 import org.opensearch.telemetry.tracing.listeners.TraceEventsService;
 
 /**
+ * One of the pre-defined TraceEventListener for recording the thread usage using {@link ThreadResourceRecorder} and
+ * emitting metrics using {@link MetricEmitter}.
  * When a {@link Tracer} is wrapped with {@link TraceEventsService#wrapAndSetTracer(Tracer)}
  * and all Runnable associated with a trace are wrapped with {@link TraceEventsService#wrapRunnable(Runnable)},
  * this class records the resource consumption of the complete trace using provided {@link ThreadResourceRecorder} and emits corresponding metrics using