feat: [Java] EMF Exporter Implementation #1209
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -65,6 +65,7 @@ | |
| import java.util.logging.Level; | ||
| import java.util.logging.Logger; | ||
| import javax.annotation.concurrent.Immutable; | ||
| import software.amazon.opentelemetry.javaagent.providers.exporter.aws.metrics.AwsCloudWatchEmfExporter; | ||
| import software.amazon.opentelemetry.javaagent.providers.exporter.otlp.aws.logs.OtlpAwsLogsExporterBuilder; | ||
| import software.amazon.opentelemetry.javaagent.providers.exporter.otlp.aws.traces.OtlpAwsSpanExporterBuilder; | ||
|
|
||
|
|
@@ -86,6 +87,9 @@ | |
| @Immutable | ||
| public final class AwsApplicationSignalsCustomizerProvider | ||
| implements AutoConfigurationCustomizerProvider { | ||
| // https://docs.aws.amazon.com/cli/v1/userguide/cli-configure-envvars.html | ||
| static final String AWS_REGION = "aws.region"; | ||
| static final String AWS_DEFAULT_REGION = "aws.default.region"; | ||
| static final String AWS_LAMBDA_FUNCTION_NAME_CONFIG = "AWS_LAMBDA_FUNCTION_NAME"; | ||
| static final String LAMBDA_APPLICATION_SIGNALS_REMOTE_ENVIRONMENT = | ||
| "LAMBDA_APPLICATION_SIGNALS_REMOTE_ENVIRONMENT"; | ||
|
|
@@ -103,6 +107,7 @@ public final class AwsApplicationSignalsCustomizerProvider | |
| // https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-OTLPEndpoint.html#CloudWatch-LogsEndpoint | ||
| static final String AWS_OTLP_LOGS_GROUP_HEADER = "x-aws-log-group"; | ||
| static final String AWS_OTLP_LOGS_STREAM_HEADER = "x-aws-log-stream"; | ||
| static final String AWS_EMF_METRICS_NAMESPACE = "x-aws-metric-namespace"; | ||
|
|
||
| private static final String DEPRECATED_SMP_ENABLED_CONFIG = "otel.smp.enabled"; | ||
| private static final String DEPRECATED_APP_SIGNALS_ENABLED_CONFIG = | ||
|
|
@@ -132,7 +137,7 @@ public final class AwsApplicationSignalsCustomizerProvider | |
| private static final String OTEL_BSP_MAX_EXPORT_BATCH_SIZE_CONFIG = | ||
| "otel.bsp.max.export.batch.size"; | ||
|
|
||
| static final String OTEL_METRICS_EXPORTER = "otel.metrics.exporter"; | ||
| static final String OTEL_LOGS_EXPORTER = "otel.logs.exporter"; | ||
| static final String OTEL_TRACES_EXPORTER = "otel.traces.exporter"; | ||
| static final String OTEL_EXPORTER_OTLP_TRACES_PROTOCOL = "otel.exporter.otlp.traces.protocol"; | ||
|
|
@@ -161,6 +166,7 @@ public final class AwsApplicationSignalsCustomizerProvider | |
| private static final int LAMBDA_SPAN_EXPORT_BATCH_SIZE = 10; | ||
|
|
||
| private Sampler sampler; | ||
| private boolean isEmfExporterEnabled = false; | ||
|
|
||
| public void customize(AutoConfigurationCustomizer autoConfiguration) { | ||
| autoConfiguration.addPropertiesCustomizer(this::customizeProperties); | ||
|
|
@@ -171,6 +177,15 @@ public void customize(AutoConfigurationCustomizer autoConfiguration) { | |
| autoConfiguration.addMeterProviderCustomizer(this::customizeMeterProvider); | ||
| autoConfiguration.addSpanExporterCustomizer(this::customizeSpanExporter); | ||
| autoConfiguration.addLogRecordExporterCustomizer(this::customizeLogsExporter); | ||
| autoConfiguration.addMetricExporterCustomizer(this::customizeMetricExporter); | ||
| } | ||
|
|
||
| private static Optional<String> getAwsRegionFromConfig(ConfigProperties configProps) { | ||
| String region = configProps.getString(AWS_REGION); | ||
| if (region != null) { | ||
| return Optional.of(region); | ||
| } | ||
| return Optional.ofNullable(configProps.getString(AWS_DEFAULT_REGION)); | ||
| } | ||
|
|
||
| static boolean isLambdaEnvironment() { | ||
|
|
@@ -190,10 +205,18 @@ private boolean isApplicationSignalsRuntimeEnabled(ConfigProperties configProps) | |
| && configProps.getBoolean(APPLICATION_SIGNALS_RUNTIME_ENABLED_CONFIG, true); | ||
| } | ||
|
|
||
| Map<String, String> customizeProperties(ConfigProperties configProps) { | ||
| Map<String, String> propsOverride = new HashMap<>(); | ||
| boolean isLambdaEnvironment = isLambdaEnvironment(); | ||
|
|
||
| // Check if awsemf was specified and remove it from OTEL_METRICS_EXPORTER | ||
| Optional<String> filteredExporters = | ||
| AwsApplicationSignalsConfigUtils.removeEmfExporterIfEnabled(configProps); | ||
| if (filteredExporters.isPresent()) { | ||
| this.isEmfExporterEnabled = true; | ||
| propsOverride.put(OTEL_METRICS_EXPORTER, filteredExporters.get()); | ||
| } | ||
|
|
||
| // Enable AWS Resource Providers | ||
| propsOverride.put(OTEL_RESOURCE_PROVIDERS_AWS_ENABLED, "true"); | ||
|
|
||
|
|
@@ -394,7 +417,6 @@ private SdkTracerProviderBuilder customizeTracerProviderBuilder( | |
|
|
||
| private SdkMeterProviderBuilder customizeMeterProvider( | ||
| SdkMeterProviderBuilder sdkMeterProviderBuilder, ConfigProperties configProps) { | ||
| if (isApplicationSignalsRuntimeEnabled(configProps)) { | ||
| Set<String> registeredScopeNames = new HashSet<>(1); | ||
| String jmxRuntimeScopeName = "io.opentelemetry.jmx"; | ||
|
|
@@ -434,7 +456,7 @@ SpanExporter customizeSpanExporter(SpanExporter spanExporter, ConfigProperties c | |
| } | ||
| } | ||
|
|
||
| if (AwsApplicationSignalsConfigUtils.isSigV4EnabledTraces(configProps)) { | ||
| // can cast here since we've checked that the configuration for OTEL_TRACES_EXPORTER is otlp | ||
| // and OTEL_EXPORTER_OTLP_TRACES_PROTOCOL is http/protobuf | ||
| // so the given spanExporter will be an instance of OtlpHttpSpanExporter | ||
|
|
@@ -480,7 +502,7 @@ private boolean isOtlpSpanExporter(SpanExporter spanExporter) { | |
|
|
||
| LogRecordExporter customizeLogsExporter( | ||
| LogRecordExporter logsExporter, ConfigProperties configProps) { | ||
| if (AwsApplicationSignalsConfigUtils.isSigV4EnabledLogs(configProps)) { | ||
| // can cast here since we've checked that the configuration for OTEL_LOGS_EXPORTER is otlp and | ||
| // OTEL_EXPORTER_OTLP_LOGS_PROTOCOL is http/protobuf | ||
| // so the given logsExporter will be an instance of OtlpHttpLogRecorderExporter | ||
|
|
@@ -509,6 +531,41 @@ LogRecordExporter customizeLogsExporter( | |
| return logsExporter; | ||
| } | ||
|
|
||
| MetricExporter customizeMetricExporter( | ||
| MetricExporter metricExporter, ConfigProperties configProps) { | ||
| if (isEmfExporterEnabled) { | ||
| Map<String, String> headers = | ||
| AwsApplicationSignalsConfigUtils.parseOtlpHeaders( | ||
| configProps.getString(OTEL_EXPORTER_OTLP_LOGS_HEADERS)); | ||
| Optional<String> awsRegion = getAwsRegionFromConfig(configProps); | ||
|
|
||
| if (awsRegion.isPresent()) { | ||
| if (headers.containsKey(AWS_OTLP_LOGS_GROUP_HEADER) | ||
|
Contributor
There was a problem hiding this comment. Does customer have to set all 3 headers?
Contributor
Author
There was a problem hiding this comment. It looks like from Python implementation they don't need
Contributor
Author
There was a problem hiding this comment. Removed validation for namespace header. |
||
| && headers.containsKey(AWS_OTLP_LOGS_STREAM_HEADER) | ||
| && headers.containsKey(AWS_EMF_METRICS_NAMESPACE)) { | ||
| String namespace = headers.get(AWS_EMF_METRICS_NAMESPACE); | ||
| String logGroup = headers.get(AWS_OTLP_LOGS_GROUP_HEADER); | ||
| String logStream = headers.get(AWS_OTLP_LOGS_STREAM_HEADER); | ||
| return new AwsCloudWatchEmfExporter(namespace, logGroup, logStream, awsRegion.get()); | ||
| } | ||
| logger.warning( | ||
| String.format( | ||
| "Improper configuration: Please configure the environment variable OTEL_EXPORTER_OTLP_LOGS_HEADERS to have values for %s, %s, and %s", | ||
| AWS_OTLP_LOGS_GROUP_HEADER, | ||
| AWS_OTLP_LOGS_STREAM_HEADER, | ||
| AWS_EMF_METRICS_NAMESPACE)); | ||
|
|
||
| } else { | ||
| logger.warning( | ||
| String.format( | ||
| "Improper configuration: AWS region not found in environment variables please set %s or %s", | ||
| AWS_REGION, AWS_DEFAULT_REGION)); | ||
| } | ||
| } | ||
|
|
||
| return metricExporter; | ||
| } | ||
|
|
||
| static AwsXrayAdaptiveSamplingConfig parseConfigString(String config) | ||
| throws JsonProcessingException { | ||
| if (config == null) { | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
think about simplify the logic, improve readability
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
added some comments to clarify the method logic