PHP-SDK之如何实现设置访问日志?

开启、查看与关闭阿里云OSS Bucket访问日志的详细操作指南

开启Bucket日志

1. 前提条件：

   • 确保您的Bucket位于支持OSS服务的地域中，如华东1（杭州）等。
   • 您已拥有阿里云OSS的访问权限和凭证（AccessKey ID和AccessKey Secret）。

2. 操作步骤：

   • 使用阿里云OSS SDK（以PHP为例），首先实例化OssClient，并配置好凭证信息及Endpoint。

   use OSS\OssClient;
   use OSS\Core\OssUtil;
   
   $accessKeyId = "<yourAccessKeyId>";
   $accessKeySecret = "<yourAccessKeySecret>";
   $bucket = "<yourBucketName>";
   $endpoint = "<yourEndpoint>";
   
   $ossClient = new OssClient($accessKeyId, $accessKeySecret, $endpoint);
   

   • 调用putBucketLogging方法开启日志记录。指定目标Bucket（通常为同一账号下的另一个Bucket）和日志文件前缀。

   function putBucketLogging($ossClient, $bucket, $targetBucket, $targetPrefix){
      try {
          $ossClient->putBucketLogging($bucket, [
              'TargetBucket' => $targetBucket,
              'TargetPrefix' => $targetPrefix
          ]);
          echo "日志功能已成功开启。\n";
      } catch (OssException $e) {
          printf(__FUNCTION__ . ": FAILED\n");
          printf($e->getMessage() . "\n");
      }
   }
   
   // 示例调用
   putBucketLogging($ossClient, $bucket, $bucket, "access-logs/");
   

查看Bucket日志设置

1. 操作步骤：

   • 通过调用getBucketLogging方法获取当前Bucket的日志配置。

   function getBucketLogging($ossClient, $bucket){
      try {
          $loggingConfig = $ossClient->getBucketLogging($bucket);
          echo "当前Bucket日志配置：\n" . $loggingConfig->serializeToXml() . "\n";
      } catch (OssException $e) {
          printf(__FUNCTION__ . ": FAILED\n");
          printf($e->getMessage() . "\n");
      }
   }
   
   // 示例调用
   getBucketLogging($ossClient, $bucket);
   

关闭Bucket日志

1. 操作步骤：

   • 直接调用deleteBucketLogging方法删除日志配置，实现关闭日志记录功能。

   function deleteBucketLogging($ossClient, $bucket){
      try {
          $ossClient->deleteBucketLogging($bucket);
          echo "Bucket日志功能已关闭。\n";
      } catch (OssException $e) {
          printf(__FUNCTION__ . ": FAILED\n");
          printf($e->getMessage() . "\n");
      }
   }
   
   // 示例调用
   deleteBucketLogging($ossClient, $bucket);
   

注意事项：

• 日志文件命名遵循规则<TargetPrefix><SourceBucket>YYYY-mm-DD-HH-MM-SS-UniqueString。
• 确保源Bucket和目标Bucket属于同一账号且位于相同地域，除非源Bucket无地域属性。
• 定期清理日志以减少存储费用，建议设置生命周期规则自动删除。
• 避免在OSS-HDFS服务启用的Bucket中将日志前缀设为.dlsdata/。

参考以上代码示例和注意事项，您可以根据实际需求管理阿里云OSS Bucket的访问日志功能。