Updated on 2023-11-09 GMT+08:00

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 must be in the same region.
  • Before configuring bucket logging, you need to create an agency for OBS on IAM and obtain the agency name. For details, see Creating an IAM Agency.
  • 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:

// Import the OBS library.
// Use npm to install the client.
const ObsClient = require('esdk-obs-nodejs');
// Use the source code to install the client.
// const ObsClient = require('./lib/obs');

// Create an ObsClient instance.
const obsClient = new ObsClient({
    //Obtain an AK/SK pair using environment variables or import the AK/SK pair in other ways. Using hard coding may result in leakage.
    //Obtain an AK/SK pair on the management console. For details, see https://support.huaweicloud.com/intl/en-us/usermanual-ca/ca_01_0003.html.
    access_key_id: process.env.ACCESS_KEY_ID,
    secret_access_key: process.env.SECRET_ACCESS_KEY,
   //Replace the following region with the one in use. Here uses the CN-Hong Kong region as an example.
    server: 'https://obs.ap-southeast-1.myhuaweicloud.com'
    
});

// 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/',
    }
}, (err, result) => {
    if(err){
        console.log('Error-->' + err);
    }else{
        console.log('Status-->' + result.CommonMsg.Status);
        console.log('RequestId-->' + result.CommonMsg.RequestId);
    }
});

Use the LoggingEnabled parameter to configure logging for a bucket.

Setting ACLs for Objects to Be Logged

Sample code:

// Import the OBS library.
// Use npm to install the client.
var ObsClient = require('esdk-obs-nodejs');
// Use the source code to install the client.
// var ObsClient = require('./lib/obs');

// Create an ObsClient instance.
const obsClient = new ObsClient({
    //Obtain an AK/SK pair using environment variables or import the AK/SK pair in other ways. Using hard coding may result in leakage.
    //Obtain an AK/SK pair on the management console. For details, see https://support.huaweicloud.com/intl/en-us/usermanual-ca/ca_01_0003.html.
    access_key_id: process.env.ACCESS_KEY_ID,
    secret_access_key: process.env.SECRET_ACCESS_KEY,
   //Replace the following region with the one in use. Here uses the CN-Hong Kong region as an example.
    server: 'https://obs.ap-southeast-1.myhuaweicloud.com'
    
});

// 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}
        ]
     }
}, (err, result) => {
    if(err){
        console.log('Error-->' + err);
    }else{
        console.log('Status-->' + result.CommonMsg.Status);
        console.log('RequestId-->' + result.CommonMsg.RequestId);
    }
});