Help Center/ Object Storage Service/ SDK Reference/ BrowserJS/ Access Logging/ Enabling Bucket Logging
Updated on 2024-04-26 GMT+08:00
View PDF

Enabling Bucket Logging

If you have any questions during development, post them on the Issues page of GitHub. For details about parameters and usage of each API, see the API Reference.

You can call ObsClient.setBucketLogging to enable bucket logging.

  • The source bucket and target bucket of logging must be in the same region.
  • If the bucket is in the OBS Infrequent Access or Archive storage class, it cannot be used as the target bucket.

Enabling Bucket Logging

Sample code:

// Create an ObsClient instance.
var obsClient = new ObsClient({
    // Hard-coded or plaintext AK/SK are risky. For security purposes, encrypt your AK/SK and store them in the configuration file or environment variables. In this example, the AK/SK are stored in environment variables for identity authentication. Before running this example, configure environment variables AccessKeyID and SecretAccessKey.
    // The front-end code does not have the process environment variable, so you need to use a module bundler like webpack to define the process variable.
    // Obtain an AK/SK pair on the management console. For details, see https://support.huaweicloud.com/eu/usermanual-ca/ca_01_0003.html.
    access_key_id: process.env.AccessKeyID,
    secret_access_key: process.env.SecretAccessKey,
    // Replace the example endpoint with the actual one in your case.
    server: 'https://obs.eu-west-101.myhuaweicloud.eu'
});

// Configure logging for the bucket.
obsClient.setBucketLogging({
    Bucket:'bucketname',
    // Name of the agency created on IAM.
    Agency: 'Agency name'
    LoggingEnabled:{
        // Name of the bucket for storing the generated log file.
        TargetBucket: 'logBucketName',
        // Specify the name prefix of the generated log file.
        TargetPrefix: 'logs/',
    }
}, function(err, result) {
    if(err){
        console.log('Error-->' + err);
    }else{
        console.log('Status-->' + result.CommonMsg.Status);
    }
});

Use the LoggingEnabled parameter to configure logging for a bucket.

Setting ACLs for Objects to Be Logged

Sample code: 
// Create an ObsClient instance.
var obsClient = new ObsClient({
    // Hard-coded or plaintext AK/SK are risky. For security purposes, encrypt your AK/SK and store them in the configuration file or environment variables. In this example, the AK/SK are stored in environment variables for identity authentication. Before running this example, configure environment variables AccessKeyID and SecretAccessKey.
    // The front-end code does not have the process environment variable, so you need to use a module bundler like webpack to define the process variable.
    // Obtain an AK/SK pair on the management console. For details, see https://support.huaweicloud.com/eu/usermanual-ca/ca_01_0003.html.
    access_key_id: process.env.AccessKeyID,
    secret_access_key: process.env.SecretAccessKey,
    // Replace the example endpoint with the actual one in your case.
    server: 'https://obs.eu-west-101.myhuaweicloud.eu'
});

// Configure logging for the bucket.
obsClient.setBucketLogging({
    Bucket:'bucketname',
    // Name of the OBS agency created by the owner of the target bucket on IAM.
    Agency: 'Agency name',
    LoggingEnabled:{
        // Name of the bucket for storing the generated log file.
        TargetBucket: 'LogBucketName',
        // Specify the name prefix of the generated log file.
        TargetPrefix: 'logs/',
        TargetGrants:[
            // Grant all users the READ permission on the logs.
           { Grantee:{Type:'Group',URI:obsClient.enums.GroupAllUsers},Permission:obsClient.enums.PermissionRead },
            // Grant all users the WRITE permission on the logs.
           { Grantee:{Type:'Group',URI:obsClient.enums.GroupAllUsers},Permission:obsClient.enums.PermissionWrite }
        ]
     }
}, function(err, result) {
    if(err){
        console.log('Error-->' + err);
    }else{
        console.log('Status-->' + result.CommonMsg.Status);
    }
});
Parent topic: Access Logging