文档中心

管理实时日志（Java SDK）

最近更新时间：2024.02.04 18:31:05

首次发布时间：2023.03.15 15:27:55

TOS 支持日志分析功能，支持通过日志服务，检索分析您访问 TOS 过程中产生的访问日志。通过 TOS Java SDK 您可以设置日志分析功能的相关配置。

设置实时日志配置规则

您可以通过 TOS Java SDK 的 putBucketRealTimeLog 接口设置桶的实时日志配置。

注意

使用日志分析功能需要您已开通日志服务功能，并已授权 TOS 访问火山引擎日志服务 TLS。
开启日志分析功能后，日志服务会自动创建日志项目及主题存放 TOS 的相关日志。

示例代码

以下代码展示如何设置桶的实时日志配置规则。

import com.volcengine.tos.TOSV2;
import com.volcengine.tos.TOSV2ClientBuilder;
import com.volcengine.tos.TosClientException;
import com.volcengine.tos.TosServerException;
import com.volcengine.tos.model.bucket.AccessLogConfiguration;
import com.volcengine.tos.model.bucket.PutBucketRealTimeLogInput;
import com.volcengine.tos.model.bucket.PutBucketRealTimeLogOutput;
import com.volcengine.tos.model.bucket.RealTimeLogConfiguration;

public class PutBucketRealTimeLogExample {
    public static void main(String[] args) {
        String endpoint = "your endpoint";
        String region = "your region";
        String accessKey = System.getenv("TOS_ACCESS_KEY");
        String secretKey = System.getenv("TOS_SECRET_KEY"); 

        String bucketName = "bucket-example";

        String realTimeLogRole = "your real time log role";
        String tlsProjectId = "the tls project id";
        String tlsTopicId = "the tls topic id";

        TOSV2 tos = new TOSV2ClientBuilder().build(region, endpoint, accessKey, secretKey);

        try{
            RealTimeLogConfiguration configuration = new RealTimeLogConfiguration().setRole(realTimeLogRole)
                    .setConfiguration(new AccessLogConfiguration()
                            .setUseServiceTopic(true)
                            .setTlsProjectID(tlsProjectId)
                            .setTlsTopicID(tlsTopicId));
            PutBucketRealTimeLogInput input = new PutBucketRealTimeLogInput().setBucket(bucketName)
                    .setConfiguration(configuration);
            PutBucketRealTimeLogOutput output = tos.putBucketRealTimeLog(input);
            System.out.println("putBucketRealTimeLog succeed");
        } catch (TosClientException e) {
            // 操作失败，捕获客户端异常，一般情况是请求参数错误，此时请求并未发送
            System.out.println("putBucketRealTimeLog failed");
            System.out.println("Message: " + e.getMessage());
            if (e.getCause() != null) {
                e.getCause().printStackTrace();
            }
        } catch (TosServerException e) {
            // 操作失败，捕获服务端异常，可以获取到从服务端返回的详细错误信息
            System.out.println("putBucketRealTimeLog failed");
            System.out.println("StatusCode: " + e.getStatusCode());
            System.out.println("Code: " + e.getCode());
            System.out.println("Message: " + e.getMessage());
            System.out.println("RequestID: " + e.getRequestID());
        } catch (Throwable t) {
            // 作为兜底捕获其他异常，一般不会执行到这里
            System.out.println("putBucketRealTimeLog failed");
            System.out.println("unexpected exception, message: " + t.getMessage());
        }
    }
}

获取实时日志配置规则

您可以通过 TOS Java SDK 的 getBucketRealTimeLog 接口获取桶的实时日志配置。

注意

要获取桶的实时日志配置规则，默认您必须为桶所有者。

示例代码

以下代码展示如何获取桶的实时日志配置规则。

import com.volcengine.tos.TOSV2;
import com.volcengine.tos.TOSV2ClientBuilder;
import com.volcengine.tos.TosClientException;
import com.volcengine.tos.TosServerException;
import com.volcengine.tos.model.bucket.GetBucketRealTimeLogInput;
import com.volcengine.tos.model.bucket.GetBucketRealTimeLogOutput;

public class GetBucketRealTimeLogExample {
    public static void main(String[] args) {
        String endpoint = "your endpoint";
        String region = "your region";
        String accessKey = System.getenv("TOS_ACCESS_KEY");
        String secretKey = System.getenv("TOS_SECRET_KEY"); 

        String bucketName = "bucket-example";

        TOSV2 tos = new TOSV2ClientBuilder().build(region, endpoint, accessKey, secretKey);

        try{
            GetBucketRealTimeLogInput input = new GetBucketRealTimeLogInput().setBucket(bucketName);
            GetBucketRealTimeLogOutput output = tos.getBucketRealTimeLog(input);
            System.out.println("getBucketRealTimeLog succeed, the config is " + output.getConfiguration());
        } catch (TosClientException e) {
            // 操作失败，捕获客户端异常，一般情况是请求参数错误，此时请求并未发送
            System.out.println("getBucketRealTimeLog failed");
            System.out.println("Message: " + e.getMessage());
            if (e.getCause() != null) {
                e.getCause().printStackTrace();
            }
        } catch (TosServerException e) {
            // 操作失败，捕获服务端异常，可以获取到从服务端返回的详细错误信息
            System.out.println("getBucketRealTimeLog failed");
            System.out.println("StatusCode: " + e.getStatusCode());
            System.out.println("Code: " + e.getCode());
            System.out.println("Message: " + e.getMessage());
            System.out.println("RequestID: " + e.getRequestID());
        } catch (Throwable t) {
            // 作为兜底捕获其他异常，一般不会执行到这里
            System.out.println("getBucketRealTimeLog failed");
            System.out.println("unexpected exception, message: " + t.getMessage());
        }
    }
}

删除实时日志配置规则

您可以通过 TOS Java SDK 的 deleteBucketRealTimeLog 接口删除桶的实时日志配置。

注意

要删除桶的实时日志配置规则，默认您必须为桶所有者。

示例代码

以下代码展示如何删除桶的实时日志配置规则。

import com.volcengine.tos.TOSV2;
import com.volcengine.tos.TOSV2ClientBuilder;
import com.volcengine.tos.TosClientException;
import com.volcengine.tos.TosServerException;
import com.volcengine.tos.model.bucket.DeleteBucketRealTimeLogInput;
import com.volcengine.tos.model.bucket.DeleteBucketRealTimeLogOutput;

public class DeleteBucketRealTimeLogExample {
    public static void main(String[] args) {
        String endpoint = "your endpoint";
        String region = "your region";
        String accessKey = System.getenv("TOS_ACCESS_KEY");
        String secretKey = System.getenv("TOS_SECRET_KEY"); 
        String bucketName = "bucket-example";

        TOSV2 tos = new TOSV2ClientBuilder().build(region, endpoint, accessKey, secretKey);

        try{
            DeleteBucketRealTimeLogInput input = new DeleteBucketRealTimeLogInput().setBucket(bucketName);
            DeleteBucketRealTimeLogOutput output = tos.deleteBucketRealTimeLog(input);
            System.out.println("deleteBucketRealTimeLog succeed, " + output);
        } catch (TosClientException e) {
            // 操作失败，捕获客户端异常，一般情况是请求参数错误，此时请求并未发送
            System.out.println("deleteBucketRealTimeLog failed");
            System.out.println("Message: " + e.getMessage());
            if (e.getCause() != null) {
                e.getCause().printStackTrace();
            }
        } catch (TosServerException e) {
            // 操作失败，捕获服务端异常，可以获取到从服务端返回的详细错误信息
            System.out.println("deleteBucketRealTimeLog failed");
            System.out.println("StatusCode: " + e.getStatusCode());
            System.out.println("Code: " + e.getCode());
            System.out.println("Message: " + e.getMessage());
            System.out.println("RequestID: " + e.getRequestID());
        } catch (Throwable t) {
            // 作为兜底捕获其他异常，一般不会执行到这里
            System.out.println("deleteBucketRealTimeLog failed");
            System.out.println("unexpected exception, message: " + t.getMessage());
        }
    }
}

对象存储

管理实时日志（Java SDK）

设置实时日志配置规则

示例代码

获取实时日志配置规则

示例代码

删除实时日志配置规则

示例代码

相关文档