Skip to content

Commit 7aa31b4

Browse files
committed
add more java docs
1 parent 3b0c1ab commit 7aa31b4

File tree

4 files changed

+12
-2
lines changed

4 files changed

+12
-2
lines changed

awsagentprovider/src/main/java/software/amazon/opentelemetry/javaagent/providers/exporter/aws/common/BaseEmfExporter.java

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,20 @@
4040
import java.util.logging.Logger;
4141
import software.amazon.opentelemetry.javaagent.providers.exporter.aws.common.emitter.LogEventEmitter;
4242

43+
/**
44+
* Base class for EMF metric exporters that converts OpenTelemetry metrics to CloudWatch EMF format.
45+
*/
4346
public abstract class BaseEmfExporter<T> implements MetricExporter {
4447
private static final Logger logger = Logger.getLogger(BaseEmfExporter.class.getName());
4548
private final String namespace;
4649
protected final LogEventEmitter<T> emitter;
4750

51+
/**
52+
* Creates a new EMF exporter with the specified namespace and log emitter.
53+
*
54+
* @param namespace the CloudWatch metric namespace, defaults to "default" if null
55+
* @param emitter the log event emitter for sending EMF logs
56+
*/
4857
protected BaseEmfExporter(String namespace, LogEventEmitter<T> emitter) {
4958
this.namespace = namespace != null ? namespace : "default";
5059
this.emitter = emitter;

awsagentprovider/src/main/java/software/amazon/opentelemetry/javaagent/providers/exporter/aws/common/emitter/CloudWatchLogsClientEmitter.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
import software.amazon.awssdk.services.cloudwatchlogs.model.*;
2727

2828
/**
29-
* CloudWatch Logs client for batching and sending log events.
29+
* A log event emitter that sends Log Events to CloudWatch Logs.
3030
*
3131
* <p>This class handles the batching logic and CloudWatch Logs API interactions for sending EMF
3232
* logs while respecting CloudWatch Logs constraints.

awsagentprovider/src/main/java/software/amazon/opentelemetry/javaagent/providers/exporter/aws/common/emitter/ConsoleEmitter.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
import java.util.logging.Level;
2121
import java.util.logging.Logger;
2222

23+
/** A log event emitter that prints Log Events to Standard Out. */
2324
public class ConsoleEmitter implements LogEventEmitter<PrintStream> {
2425
private static final Logger logger = Logger.getLogger(ConsoleEmitter.class.getName());
2526
private final PrintStream emitter;

awsagentprovider/src/main/java/software/amazon/opentelemetry/javaagent/providers/exporter/aws/common/emitter/LogEventEmitter.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
import java.util.Map;
1919

2020
/**
21-
* Generic interface for log emitters.
21+
* Generic interface for log event emitters.
2222
*
2323
* @param <T> The type of the underlying emitter client
2424
*/

0 commit comments

Comments
 (0)