Object Storage Service:Logging

1. Log on to the OSS console.

2. In the left-side navigation pane, choose Data Service > OSS on CloudBox Buckets.

3. On the OSS on CloudBox Buckets page, click the OSS on CloudBox bucket for which you want to enable logging.

4. In the left-side navigation pane, choose Logging > Logging.

5. On the Logging tab, turn on Logging and specify Log Storage Bucket and Log Prefix.

   • Log Storage Bucket: Select an OSS on CloudBox bucket from the drop-down list. You can select only a destination OSS on CloudBox bucket that is located in the same region as the OSS on CloudBox bucket for which logging is enabled within the same Alibaba Cloud account.

   • Log Prefix: Enter the directory in which logs are stored. If you specify this parameter, the logs are stored in the specified directory of the destination OSS on CloudBox bucket. If you do not specify this parameter, the logs are stored in the root directory of the destination OSS on CloudBox bucket. For example, if you enter log/ in the Log Prefix field, the logs are stored in the log/ directory.

6. Click Save.

You can enable logging only by using OSS SDK for Java. The version of OSS SDK for Java must be 3.15.0 or later.

import com.aliyun.oss.ClientException;
import com.aliyun.oss.OSS;
import com.aliyun.oss.OSSClientBuilder;
import com.aliyun.oss.OSSException;
import com.aliyun.oss.model.SetBucketLoggingRequest;
import com.aliyun.oss.common.auth.DefaultCredentialProvider;
import com.aliyun.oss.common.comm.SignVersion;
import com.aliyun.oss.ClientBuilderConfiguration;
import com.aliyun.oss.common.auth.CredentialsProviderFactory;
import com.aliyun.oss.common.auth.EnvironmentVariableCredentialsProvider;

public class Demo {

    public static void main(String[] args) throws Exception {
        // Specify the data endpoint of the OSS on CloudBox bucket. 
        String endpoint = "https://cb-f8z7yvzgwfkl9q0h****.cn-hangzhou.oss-cloudbox.aliyuncs.com";
        // Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured. 
        EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();
        // Specify the name of the OSS on CloudBox bucket for which you want to enable logging. Example: examplebucket. 
        String bucketName = "examplebucket";
        // Specify the name of the OSS on CloudBox bucket that stores logs. The source and destination OSS on CloudBox buckets can be the same OSS on CloudBox bucket or different OSS on CloudBox buckets. 
        String targetBucketName = "destbucket";
        // Set the directory in which you want to store the log objects to log/. If you specify this parameter, the logs are stored in the specified directory of the destination OSS on CloudBox bucket. If you do not specify this parameter, the logs are stored in the root directory of the destination OSS on CloudBox bucket. 
        String targetPrefix = "log/";
        // Specify the region in which the OSS on CloudBox bucket is located. 
        String region = "cn-hangzhou";
        // Specify the ID of the cloud box. 
        String cloudBoxId = "cb-f8z7yvzgwfkl9q0h****";

        // Create an OSSClient instance.
        // Call the shutdown method to release resources when the OSSClient is no longer in use. 
        ClientBuilderConfiguration conf = new ClientBuilderConfiguration();
        conf.setSignatureVersion(SignVersion.V4);
        OSS ossClient = OSSClientBuilder.create()
                .endpoint(endpoint)
                .credentialsProvider(new DefaultCredentialProvider(credentialsProvider.getCredentials()))
                .clientConfiguration(conf)
                .region(region)
                .cloudBoxId(cloudBoxId)
                .build();

        try {
            SetBucketLoggingRequest request = new SetBucketLoggingRequest(bucketName);
            request.setTargetBucket(targetBucketName);
            request.setTargetPrefix(targetPrefix);
            ossClient.setBucketLogging(request);
        } catch (OSSException oe) {
            System.out.println("Caught an OSSException, which means your request made it to OSS, "
                    + "but was rejected with an error response for some reason.");
            System.out.println("Error Message:" + oe.getErrorMessage());
            System.out.println("Error Code:" + oe.getErrorCode());
            System.out.println("Request ID:" + oe.getRequestId());
            System.out.println("Host ID:" + oe.getHostId());
        } catch (ClientException ce) {
            System.out.println("Caught an ClientException, which means the client encountered "
                    + "a serious internal problem while trying to communicate with OSS, "
                    + "such as not being able to access the network.");
            System.out.println("Error Message:" + ce.getMessage());
        } finally {
            if (ossClient != null) {
                ossClient.shutdown();
            }
        }
    }
}