如何通過Go SDK V2進行日誌轉存 - Object Storage Service

訪問OSS的過程中會產生大量的訪問日誌。您可以通過日誌轉存功能將這些日誌按照固定命名規則，以小時為單位組建記錄檔檔案寫入您指定的儲存空間（Bucket）。

注意事項

本文範例程式碼以華東1（杭州）的地區IDcn-hangzhou為例，預設使用外網Endpoint，如果您希望通過與OSS同地區的其他阿里雲產品訪問OSS，請使用內網Endpoint。關於OSS支援的Region與Endpoint的對應關係，請參見OSS地區和訪問網域名稱。
本文以從環境變數讀取存取憑證為例。如何配置訪問憑證，請參見配置訪問憑證。
要開啟日誌轉存，您必須有oss:PutBucketLogging許可權；要查看日誌轉存配置，您必須有oss:GetBucketLogging許可權；要關閉日誌轉存，您必須有oss:DeleteBucketLogging許可權。具體操作，請參見為RAM使用者授予自訂的權限原則。

範例程式碼

開啟日誌轉存

以下代碼用於開啟日誌轉存功能。

package main

import (
	"context"
	"flag"
	"log"

	"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss"
	"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss/credentials"
)

// 定義全域變數
var (
	region     string // 儲存地區
	bucketName string // 儲存空間名稱
)

// init函數用於初始化命令列參數
func init() {
	flag.StringVar(&region, "region", "", "The region in which the bucket is located.")
	flag.StringVar(&bucketName, "bucket", "", "The name of the bucket.")
}

func main() {
	// 解析命令列參數
	flag.Parse()

	// 檢查bucket名稱是否為空白
	if len(bucketName) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, bucket name required")
	}

	// 檢查region是否為空白
	if len(region) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, region required")
	}

	// 載入預設配置並設定憑證提供者和地區
	cfg := oss.LoadDefaultConfig().
		WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
		WithRegion(region)

	// 建立OSS用戶端
	client := oss.NewClient(cfg)

	// 建立開啟儲存空間日誌轉存功能的請求
	putRequest := &oss.PutBucketLoggingRequest{
		Bucket: oss.Ptr(bucketName), // 填寫待開啟日誌轉存功能的Bucket名稱
		BucketLoggingStatus: &oss.BucketLoggingStatus{
			LoggingEnabled: &oss.LoggingEnabled{
				TargetBucket: oss.Ptr("TargetBucket"), // 填寫存放記錄檔的目標Bucket。targetBucketName與bucketName必須處於相同地區，可以是相同或不同的Bucket。
				TargetPrefix: oss.Ptr("log"),          // 設定記錄檔儲存的目錄。如果指定此項，則記錄檔將儲存在目標Bucket的指定目錄下。如果不指定此項，則記錄檔將儲存在目標Bucket的根目錄下。
			},
		},
	}

	// 執行開啟儲存空間日誌轉存功能的請求
	putResult, err := client.PutBucketLogging(context.TODO(), putRequest)
	if err != nil {
		log.Fatalf("failed to put bucket logging %v", err)
	}

	// 列印開啟儲存空間日誌轉存功能的結果
	log.Printf("put bucket logging result:%#v\n", putResult)
}

查看日誌轉存配置

以下代碼用於查看日誌轉存配置。

package main

import (
	"context"
	"flag"
	"log"

	"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss"
	"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss/credentials"
)

// 定義全域變數
var (
	region     string // 儲存地區
	bucketName string // 儲存空間名稱
)

// init函數用於初始化命令列參數
func init() {
	flag.StringVar(&region, "region", "", "The region in which the bucket is located.")
	flag.StringVar(&bucketName, "bucket", "", "The name of the bucket.")
}

func main() {
	// 解析命令列參數
	flag.Parse()

	// 檢查bucket名稱是否為空白
	if len(bucketName) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, bucket name required")
	}

	// 檢查region是否為空白
	if len(region) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, region required")
	}

	// 載入預設配置並設定憑證提供者和地區
	cfg := oss.LoadDefaultConfig().
		WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
		WithRegion(region)

	// 建立OSS用戶端
	client := oss.NewClient(cfg)

	// 建立擷取儲存空間日誌轉存配置的請求
	getRequest := &oss.GetBucketLoggingRequest{
		Bucket: oss.Ptr(bucketName), // 儲存空間名稱
	}

	// 執行擷取儲存空間日誌轉存配置的操作並處理結果
	getResult, err := client.GetBucketLogging(context.TODO(), getRequest)
	if err != nil {
		log.Fatalf("failed to get bucket logging %v", err)
	}

	// 列印擷取儲存空間日誌轉存配置的結果
	log.Printf("get bucket logging result target bucket:%#v\n", getResult.BucketLoggingStatus.LoggingEnabled.TargetBucket)
}

關閉日誌轉存

以下代碼用於關閉日誌轉存功能。

package main

import (
	"context"
	"flag"
	"log"

	"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss"
	"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss/credentials"
)

// 定義全域變數
var (
	region     string // 儲存地區
	bucketName string // 儲存空間名稱
)

// init函數用於初始化命令列參數
func init() {
	flag.StringVar(&region, "region", "", "The region in which the bucket is located.")
	flag.StringVar(&bucketName, "bucket", "", "The name of the bucket.")
}

func main() {
	// 解析命令列參數
	flag.Parse()

	// 檢查bucket名稱是否為空白
	if len(bucketName) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, bucket name required")
	}

	// 檢查region是否為空白
	if len(region) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, region required")
	}

	// 載入預設配置並設定憑證提供者和地區
	cfg := oss.LoadDefaultConfig().
		WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
		WithRegion(region)

	// 建立OSS用戶端
	client := oss.NewClient(cfg)

	// 建立關閉儲存空間日誌轉存功能的請求
	delRequest := &oss.DeleteBucketLoggingRequest{
		Bucket: oss.Ptr(bucketName), // 儲存空間名稱
	}

	// 執行關閉儲存空間日誌轉存功能的操作並處理結果
	delResult, err := client.DeleteBucketLogging(context.TODO(), delRequest)
	if err != nil {
		log.Fatalf("failed to delete bucket logging %v", err)
	}

	// 列印關閉儲存空間日誌轉存功能的結果
	log.Printf("delete bucket logging result:%#v\n", delResult)
}

配置使用者自訂日誌欄位

您可以使用PutUserDefinedLogFieldsConfig介面為儲存空間（Bucket）即時日誌中的user_defined_log_fields欄位進行個人化配置。您可以將OSS請求中使用者關心的要求標頭或查詢參數資訊記錄到該欄位中去以便後續分析請求。

package main

import (
	"context"
	"flag"
	"log"

	"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss"
	"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss/credentials"
)

// 定義命令列參數變數
var (
	region     string // OSS Bucket所在地區（Region）
	bucketName string // 要操作的Bucket名稱
)

// init 函數用於初始化命令列參數解析
func init() {
	flag.StringVar(&region, "region", "", "The region in which the bucket is located.")
	flag.StringVar(&bucketName, "bucket", "", "The name of the bucket.")
}

func main() {
	// 解析命令列參數
	flag.Parse()

	// 檢查是否提供了bucket名稱
	if len(bucketName) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, bucket name required")
	}

	// 檢查是否提供了region參數
	if len(region) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, region required")
	}

	// 載入預設配置，並設定憑證提供者和region
	cfg := oss.LoadDefaultConfig().
		WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
		WithRegion(region)

	// 建立 OSS 用戶端執行個體
	client := oss.NewClient(cfg)

	// 構造 PutUserDefinedLogFieldsConfig 請求
	request := &oss.PutUserDefinedLogFieldsConfigRequest{
		Bucket: oss.Ptr(bucketName), // 設定目標 Bucket 名稱
		UserDefinedLogFieldsConfiguration: &oss.UserDefinedLogFieldsConfiguration{
			HeaderSet: &oss.LoggingHeaderSet{
				Headers: []string{"header1", "header2"}, // 自訂日誌中需要記錄的 HTTP Header 欄位
			},
			ParamSet: &oss.LoggingParamSet{
				Parameters: []string{"param"}, // 自訂日誌中需要記錄的 URL 參數欄位
			},
		},
	}

	// 發起請求並擷取結果
	result, err := client.PutUserDefinedLogFieldsConfig(context.TODO(), request)
	if err != nil {
		log.Fatalf("failed to put user defined log fields config %v", err)
	}

	// 輸出成功響應內容
	log.Printf("put user defined log fields config result:%#v\n", result)
}

查詢使用者自訂日誌欄位

您可以使用GetUserDefinedLogFieldsConfig介面擷取儲存空間（Bucket）即時日誌中user_defined_log_fields欄位的個人化配置。

package main

import (
	"context"
	"flag"
	"log"

	"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss"
	"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss/credentials"
)

// 定義命令列參數變數
var (
	region     string // OSS Bucket 所在地區（Region）
	bucketName string // 要操作的 Bucket 名稱
)

// init 函數用於初始化命令列參數解析
func init() {
	flag.StringVar(&region, "region", "", "The region in which the bucket is located.")
	flag.StringVar(&bucketName, "bucket", "", "The name of the bucket.")
}

func main() {
	// 解析命令列參數
	flag.Parse()

	// 檢查是否提供了 bucket 名稱
	if len(bucketName) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, bucket name required")
	}

	// 檢查是否提供了 region 參數
	if len(region) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, region required")
	}

	// 載入預設配置，並設定憑證提供器和 Region
	cfg := oss.LoadDefaultConfig().
		WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
		WithRegion(region)

	// 建立 OSS 用戶端執行個體
	client := oss.NewClient(cfg)

	// 構造 GetUserDefinedLogFieldsConfig 請求
	getRequest := &oss.GetUserDefinedLogFieldsConfigRequest{
		Bucket: oss.Ptr(bucketName), // 設定目標 Bucket 名稱
	}

	// 發起請求並擷取結果
	getResult, err := client.GetUserDefinedLogFieldsConfig(context.TODO(), getRequest)
	if err != nil {
		// 如果出錯，列印錯誤資訊並退出
		log.Fatalf("failed to get user defined log fields config %v", err)
	}

	// 輸出成功響應內容
	log.Printf("get user defined log fields config result:%#v\n", getResult)
}

刪除使用者自訂日誌欄位

您可以使用DeleteUserDefinedLogFieldsConfig介面刪除儲存空間（Bucket）即時日誌中user_defined_log_fields欄位的個人化配置。

package main

import (
	"context"
	"flag"
	"log"

	"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss"
	"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss/credentials"
)

// 定義命令列參數變數
var (
	region     string // OSS Bucket 所在地區（Region）
	bucketName string // 要操作的 Bucket 名稱
)

// init 函數用於初始化命令列參數解析
func init() {
	flag.StringVar(&region, "region", "", "The region in which the bucket is located.")
	flag.StringVar(&bucketName, "bucket", "", "The name of the bucket.")
}

func main() {
	// 解析命令列參數
	flag.Parse()

	// 檢查是否提供了 bucket 名稱
	if len(bucketName) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, bucket name required")
	}

	// 檢查是否提供了 region 參數
	if len(region) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, region required")
	}

	// 載入預設配置，並設定憑證提供者和 Region
	cfg := oss.LoadDefaultConfig().
		WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
		WithRegion(region)

	// 建立 OSS 用戶端執行個體
	client := oss.NewClient(cfg)

	// 構造 DeleteUserDefinedLogFieldsConfig 請求
	request := &oss.DeleteUserDefinedLogFieldsConfigRequest{
		Bucket: oss.Ptr(bucketName), // 設定目標 Bucket 名稱
	}

	// 發起請求並擷取結果
	result, err := client.DeleteUserDefinedLogFieldsConfig(context.TODO(), request)
	if err != nil {
		log.Fatalf("failed to delete user defined log fields config %v", err)
	}

	// 輸出成功響應內容
	log.Printf("delete user defined log fields config result:%#v\n", result)
}

Object Storage Service：日誌轉存（Go SDK V2）