|
| 1 | +/* |
| 2 | + * Copyright Amazon.com, Inc. or its affiliates. |
| 3 | + * |
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"). |
| 5 | + * You may not use this file except in compliance with the License. |
| 6 | + * A copy of the License is located at |
| 7 | + * |
| 8 | + * http://aws.amazon.com/apache2.0 |
| 9 | + * |
| 10 | + * or in the "license" file accompanying this file. This file is distributed |
| 11 | + * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either |
| 12 | + * express or implied. See the License for the specific language governing |
| 13 | + * permissions and limitations under the License. |
| 14 | + */ |
| 15 | + |
| 16 | +package software.amazon.opentelemetry.javaagent.providers; |
| 17 | + |
| 18 | +import io.opentelemetry.exporter.internal.otlp.traces.TraceRequestMarshaler; |
| 19 | +import io.opentelemetry.exporter.otlp.http.trace.OtlpHttpSpanExporter; |
| 20 | +import io.opentelemetry.sdk.common.CompletableResultCode; |
| 21 | +import io.opentelemetry.sdk.common.export.MemoryMode; |
| 22 | +import io.opentelemetry.sdk.trace.data.SpanData; |
| 23 | +import io.opentelemetry.sdk.trace.export.SpanExporter; |
| 24 | +import java.io.ByteArrayInputStream; |
| 25 | +import java.io.ByteArrayOutputStream; |
| 26 | +import java.net.URI; |
| 27 | +import java.util.ArrayList; |
| 28 | +import java.util.Collection; |
| 29 | +import java.util.HashMap; |
| 30 | +import java.util.List; |
| 31 | +import java.util.Map; |
| 32 | +import java.util.function.Supplier; |
| 33 | +import javax.annotation.concurrent.Immutable; |
| 34 | +import org.slf4j.Logger; |
| 35 | +import org.slf4j.LoggerFactory; |
| 36 | +import software.amazon.awssdk.auth.credentials.AwsCredentials; |
| 37 | +import software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider; |
| 38 | +import software.amazon.awssdk.http.SdkHttpFullRequest; |
| 39 | +import software.amazon.awssdk.http.SdkHttpMethod; |
| 40 | +import software.amazon.awssdk.http.SdkHttpRequest; |
| 41 | +import software.amazon.awssdk.http.auth.aws.signer.AwsV4HttpSigner; |
| 42 | +import software.amazon.awssdk.http.auth.spi.signer.SignedRequest; |
| 43 | + |
| 44 | +/** |
| 45 | + * This exporter extends the functionality of the OtlpHttpSpanExporter to allow spans to be exported |
| 46 | + * to the XRay OTLP endpoint https://xray.[AWSRegion].amazonaws.com/v1/traces. Utilizes the AWSSDK |
| 47 | + * library to sign and directly inject SigV4 Authentication to the exported request's headers. <a |
| 48 | + * href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-OTLPEndpoint.html">...</a> |
| 49 | + */ |
| 50 | +@Immutable |
| 51 | +public class OtlpAwsSpanExporter implements SpanExporter { |
| 52 | + private static final String SERVICE_NAME = "xray"; |
| 53 | + private static final Logger logger = LoggerFactory.getLogger(OtlpAwsSpanExporter.class); |
| 54 | + |
| 55 | + private final SpanExporter parentExporter; |
| 56 | + private final String awsRegion; |
| 57 | + private final String endpoint; |
| 58 | + private Collection<SpanData> spanData; |
| 59 | + |
| 60 | + public OtlpAwsSpanExporter(OtlpHttpSpanExporter parentExporter, String endpoint) { |
| 61 | + this.parentExporter = |
| 62 | + parentExporter.toBuilder() |
| 63 | + .setMemoryMode(MemoryMode.IMMUTABLE_DATA) |
| 64 | + .setEndpoint(endpoint) |
| 65 | + .setHeaders(new SigV4AuthHeaderSupplier()) |
| 66 | + .build(); |
| 67 | + |
| 68 | + this.awsRegion = endpoint.split("\\.")[1]; |
| 69 | + this.endpoint = endpoint; |
| 70 | + this.spanData = new ArrayList<>(); |
| 71 | + } |
| 72 | + |
| 73 | + /** |
| 74 | + * Overrides the upstream implementation of export. All behaviors are the same except if the |
| 75 | + * endpoint is an XRay OTLP endpoint, we will sign the request with SigV4 in headers before |
| 76 | + * sending it to the endpoint. Otherwise, we will skip signing. |
| 77 | + */ |
| 78 | + @Override |
| 79 | + public CompletableResultCode export(Collection<SpanData> spans) { |
| 80 | + this.spanData = spans; |
| 81 | + return this.parentExporter.export(spans); |
| 82 | + } |
| 83 | + |
| 84 | + @Override |
| 85 | + public CompletableResultCode flush() { |
| 86 | + return this.parentExporter.flush(); |
| 87 | + } |
| 88 | + |
| 89 | + @Override |
| 90 | + public CompletableResultCode shutdown() { |
| 91 | + return this.parentExporter.shutdown(); |
| 92 | + } |
| 93 | + |
| 94 | + @Override |
| 95 | + public String toString() { |
| 96 | + return this.parentExporter.toString(); |
| 97 | + } |
| 98 | + |
| 99 | + private final class SigV4AuthHeaderSupplier implements Supplier<Map<String, String>> { |
| 100 | + |
| 101 | + @Override |
| 102 | + public Map<String, String> get() { |
| 103 | + try { |
| 104 | + ByteArrayOutputStream encodedSpans = new ByteArrayOutputStream(); |
| 105 | + TraceRequestMarshaler.create(OtlpAwsSpanExporter.this.spanData).writeBinaryTo(encodedSpans); |
| 106 | + |
| 107 | + SdkHttpRequest httpRequest = |
| 108 | + SdkHttpFullRequest.builder() |
| 109 | + .uri(URI.create(OtlpAwsSpanExporter.this.endpoint)) |
| 110 | + .method(SdkHttpMethod.POST) |
| 111 | + .putHeader("Content-Type", "application/x-protobuf") |
| 112 | + .contentStreamProvider(() -> new ByteArrayInputStream(encodedSpans.toByteArray())) |
| 113 | + .build(); |
| 114 | + |
| 115 | + AwsCredentials credentials = DefaultCredentialsProvider.create().resolveCredentials(); |
| 116 | + |
| 117 | + SignedRequest signedRequest = |
| 118 | + AwsV4HttpSigner.create() |
| 119 | + .sign( |
| 120 | + b -> |
| 121 | + b.identity(credentials) |
| 122 | + .request(httpRequest) |
| 123 | + .putProperty(AwsV4HttpSigner.SERVICE_SIGNING_NAME, SERVICE_NAME) |
| 124 | + .putProperty( |
| 125 | + AwsV4HttpSigner.REGION_NAME, OtlpAwsSpanExporter.this.awsRegion) |
| 126 | + .payload(() -> new ByteArrayInputStream(encodedSpans.toByteArray()))); |
| 127 | + |
| 128 | + Map<String, String> result = new HashMap<>(); |
| 129 | + |
| 130 | + Map<String, List<String>> headers = signedRequest.request().headers(); |
| 131 | + headers.forEach( |
| 132 | + (key, values) -> { |
| 133 | + if (!values.isEmpty()) { |
| 134 | + result.put(key, values.get(0)); |
| 135 | + } |
| 136 | + }); |
| 137 | + |
| 138 | + return result; |
| 139 | + |
| 140 | + } catch (Exception e) { |
| 141 | + logger.error( |
| 142 | + "Failed to sign/authenticate the given exported Span request to OTLP CloudWatch endpoint with error: {}", |
| 143 | + e.getMessage()); |
| 144 | + |
| 145 | + return new HashMap<>(); |
| 146 | + } |
| 147 | + } |
| 148 | + } |
| 149 | +} |
0 commit comments