supports opentelemetry

Co-authored-by: zhuxiaolong37 <[email protected]>

Author: huiguangjun

pom.xml

@@ -4,7 +4,7 @@
 
     <groupId>com.aliyun.oss</groupId>
     <artifactId>aliyun-sdk-oss</artifactId>
-    <version>3.18.0</version>
+    <version>3.18.1-SNAPSHOT</version>
     <packaging>jar</packaging>
     <name>Aliyun OSS SDK for Java</name>
     <description>The Aliyun OSS SDK for Java used for accessing Aliyun Object Storage Service</description>
@@ -65,6 +65,11 @@
             <version>0.1.0</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>com.aliyun</groupId>
+            <artifactId>java-trace-api</artifactId>
+            <version>0.2.11-beta</version>
+        </dependency>
     </dependencies>
 
     <reporting>

src/main/java/com/aliyun/oss/ClientConfiguration.java

@@ -125,6 +125,8 @@ public class ClientConfiguration {
 
     private boolean verifyObjectStrict = true;
 
+    private boolean tracerEnabled = false;
+
     public ClientConfiguration() {
         super();
         AppendDefaultExcludeList(this.cnameExcludeList);
@@ -971,5 +973,22 @@ public boolean isVerifyObjectStrict() {
         return verifyObjectStrict;
     }
 
+    /**
+     * Gets the flag of tracer.
+     *
+     * @return  True if it's enabled; False if it's disabled.
+     */
+    public boolean isTracerEnabled() {
+        return tracerEnabled;
+    }
 
+    /**
+     * Sets the flag of tracer.
+     *
+     * @param enabled
+     *            True if it's enabled; False if it's disabled.
+     */
+    public void setTracerEnabled(boolean enabled) {
+        this.tracerEnabled = enabled;
+    }
 }

src/main/java/com/aliyun/oss/internal/OSSOperation.java

@@ -27,6 +27,7 @@
 import java.net.URI;
 import java.util.List;
 
+import com.aliyun.core.tracing.*;
 import com.aliyun.oss.*;
 import com.aliyun.oss.common.auth.Credentials;
 import com.aliyun.oss.common.auth.CredentialsProvider;
@@ -40,6 +41,8 @@
 import com.aliyun.oss.internal.signer.OSSSignerBase;
 import com.aliyun.oss.internal.signer.OSSSignerParams;
 import com.aliyun.oss.model.WebServiceRequest;
+import io.opentelemetry.api.common.Attributes;
+import io.opentelemetry.api.trace.Span;
 
 /**
  * Abstract base class that provides some common functionalities for OSS
@@ -157,6 +160,23 @@ protected <T> T doOperation(RequestMessage request, ResponseParser<T> parser, St
             boolean keepResponseOpen, List<RequestHandler> requestHandlers, List<ResponseHandler> reponseHandlers)
             throws OSSException, ClientException {
 
+        Span span = null;
+        if (client.getClientConfiguration().isTracerEnabled()){
+            AlibabaCloudTracer alibabaCloudTracer = AlibabaCloudTracerProvider.getInstance().getTracer();
+            AlibabaCloudAttributesBuilder AttributesBuilder = new AlibabaCloudAttributesBuilder();
+            Attributes attributes = AttributesBuilder.getAttributesBuilder()
+                    .put("alibaba.cloud.service", getProduct())
+                    .put("alibaba.cloud.signature_version", client.getClientConfiguration().getSignatureVersion().toString())
+                    .put("alibaba.cloud.resource.type", "OSS")
+                    .put("http.request.method", request.getMethod().name())
+                    .build();
+
+            AlibabaCloudSpanBuilder alibabaCloudSpanBuilder = alibabaCloudTracer.spanBuilder(bucketName);
+            if (alibabaCloudSpanBuilder != null) {
+                span = alibabaCloudSpanBuilder.setAllAttributes(attributes).startSpan();
+            }
+        }
+
         final WebServiceRequest originalRequest = request.getOriginalRequest();
         request.getHeaders().putAll(client.getClientConfiguration().getDefaultHeaders());
         request.getHeaders().putAll(originalRequest.getHeaders());
@@ -189,15 +209,37 @@ protected <T> T doOperation(RequestMessage request, ResponseParser<T> parser, St
             }
         }
 
-        ResponseMessage response = send(request, context, keepResponseOpen);
-
+        ResponseMessage response = null;
         try {
+            response = send(request, context, keepResponseOpen);
             return parser.parse(response);
         } catch (ResponseParseException rpe) {
             OSSException oe = ExceptionFactory.createInvalidResponseException(response.getRequestId(), rpe.getMessage(),
                     rpe);
             logException("Unable to parse response error: ", rpe);
+            if (span != null) {
+                span.setAttribute("alibaba.cloud.error.code", "ParseResponseError");
+            }
             throw oe;
+        } catch (OSSException e) {
+            if (span != null) {
+                span.setAttribute("alibaba.cloud.error.code", e.getErrorCode());
+                span.setAttribute("alibaba.cloud.request_id", e.getRequestId());
+            }
+            throw e;
+        } catch (ClientException ce) {
+            if (span != null) {
+                span.setAttribute("alibaba.cloud.error.code", ce.getErrorCode());
+            }
+            throw ce;
+        } finally {
+            if (span != null) {
+                if (response != null) {
+                    span.setAttribute("alibaba.cloud.request_id", response.getRequestId());
+                    span.setAttribute("http.response.status_code", String.valueOf(response.getStatusCode()));
+                }
+                span.end();
+            }
         }
     }
 

src/main/resources/versioninfo.properties

@@ -1 +1 @@
-version=3.18.0
+version=3.18.1-SNAPSHOT