Log Management

Last updated: 2020-08-11 10:07:51

    Overview

    This document provides an overview of APIs and SDK code samples related to logging.

    API Operation Description
    PUT Bucket logging Setting logging Enables logging for a source bucket
    GET Bucket logging Querying logging Queries the logging configuration of a source bucket

    SDK API References

    For the parameters and method descriptions of all the APIs in the SDK, see SDK API References.

    Setting Logging

    API description

    This API is used to enable logging for a source bucket and store the access logs in a specified destination bucket.

    Sample code

    String srcBucket = "examplebucket-1250000000"; //Format: BucketName-APPID
    String targetBucket = "examplebucket-1250000000"; //Format: BucketName-APPID
    PutBucketLoggingRequest putBucketLoggingRequest =
            new PutBucketLoggingRequest(srcBucket);
    // Destination bucket
    putBucketLoggingRequest.setTargetBucket(targetBucket);
    // Specified location in which to store the logs
    putBucketLoggingRequest.setTargetPrefix("dir/");
    
    cosXmlService.putBucketLoggingAsync(putBucketLoggingRequest,
            new CosXmlResultListener() {
        @Override
        public void onSuccess(CosXmlRequest request, CosXmlResult result) {
            PutBucketLoggingResult putBucketLoggingResult =
                    (PutBucketLoggingResult) result;
        }
    
        @Override
        public void onFail(CosXmlRequest cosXmlRequest,
                           CosXmlClientException clientException,
                           CosXmlServiceException serviceException) {
            if (clientException != null) {
                clientException.printStackTrace();
            } else {
                serviceException.printStackTrace();
            }
        }
    });

    Note:

    For more samples, go to GitHub.

    Querying Logging

    API description

    This API is used to query the logging configuration of a specified bucket.

    Sample code

    String bucket = "examplebucket-1250000000"; // Format: BucketName-APPID
    GetBucketLoggingRequest getBucketLoggingRequest =
            new GetBucketLoggingRequest(bucket);
    
    cosXmlService.getBucketLoggingAsync(getBucketLoggingRequest,
            new CosXmlResultListener() {
        @Override
        public void onSuccess(CosXmlRequest request, CosXmlResult result) {
            GetBucketLoggingResult getBucketLoggingResult =
                    (GetBucketLoggingResult) result;
        }
    
        @Override
        public void onFail(CosXmlRequest cosXmlRequest,
                           CosXmlClientException clientException,
                           CosXmlServiceException serviceException) {
            if (clientException != null) {
                clientException.printStackTrace();
            } else {
                serviceException.printStackTrace();
            }
        }
    });

    Note:

    For more samples, go to GitHub.

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help