Skip to content

LogstoreProps

Properties for defining a Logstore.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-sls-logstore

Initializer 

import com.aliyun.ros.cdk.sls.LogstoreProps;
LogstoreProps.builder()
    .logstoreName(java.lang.String)
    .logstoreName(IResolvable)
    .projectName(java.lang.String)
    .projectName(IResolvable)
//  .appendMeta(java.lang.Boolean)
//  .appendMeta(IResolvable)
//  .autoSplit(java.lang.Boolean)
//  .autoSplit(IResolvable)
//  .enableTracking(java.lang.Boolean)
//  .enableTracking(IResolvable)
//  .encryptConf(IResolvable)
//  .encryptConf(EncryptConfProperty)
//  .maxSplitShard(java.lang.Number)
//  .maxSplitShard(IResolvable)
//  .mode(java.lang.String)
//  .mode(IResolvable)
//  .preserveStorage(java.lang.Boolean)
//  .preserveStorage(IResolvable)
//  .shardCount(java.lang.Number)
//  .shardCount(IResolvable)
//  .ttl(java.lang.Number)
//  .ttl(IResolvable)
    .build();

Properties

Name Type Description
logstoreName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property logstoreName: Logstore name: 1.
projectName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property projectName: Project name: 1.
appendMeta java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property appendMeta: Whether to add client external network IP and log arrival time after receiving the log.
autoSplit java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property autoSplit: Whether to automatically split the shard.
enableTracking java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property enableTracking: Whether to enable WebTracking, which supports fast capture of various browsers and iOS\/Android\/APP access information.
encryptConf com.aliyun.ros.cdk.core.IResolvable OR EncryptConfProperty Property encryptConf: Data encryption config.
maxSplitShard java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property maxSplitShard: The maximum number of shards when splitting automatically.
mode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property mode: The type of the Logstore.
preserveStorage java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property preserveStorage: Whether to keep the log permanently.
shardCount java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property shardCount: The number of Shards.
ttl java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property ttl: The lifecycle of log in the logstore in days.

logstoreNameRequired 

public java.lang.Object getLogstoreName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property logstoreName: Logstore name: 1.

Only supports lowercase letters, numbers, hyphens (-) and underscores (_). 2. Must start and end with lowercase letters and numbers. 3. The name length is 3-63 characters.

projectNameRequired 

public java.lang.Object getProjectName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property projectName: Project name: 1.

Only supports lowercase letters, numbers, hyphens (-) and underscores (_). 2. Must start and end with lowercase letters and numbers. 3. The name length is 3-63 characters.

appendMetaOptional 

public java.lang.Object getAppendMeta();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property appendMeta: Whether to add client external network IP and log arrival time after receiving the log.

Default to false.

autoSplitOptional 

public java.lang.Object getAutoSplit();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property autoSplit: Whether to automatically split the shard.

Default to false.

enableTrackingOptional 

public java.lang.Object getEnableTracking();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property enableTracking: Whether to enable WebTracking, which supports fast capture of various browsers and iOS\/Android\/APP access information.

Default to false.

encryptConfOptional 

public java.lang.Object getEncryptConf();

Property encryptConf: Data encryption config.

maxSplitShardOptional 

public java.lang.Object getMaxSplitShard();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property maxSplitShard: The maximum number of shards when splitting automatically.

Must be specified if AutoSplit is set to true. Allowed Values: 1-64.

modeOptional 

public java.lang.Object getMode();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property mode: The type of the Logstore.

Simple Log Service provides two types of Logstores: Standard Logstores and Query Logstores. Valid values: standard: Standard Logstore. This type of Logstore supports the log analysis feature and is suitable for scenarios such as real-time monitoring and interactive analysis. You can also use this type of Logstore to build a comprehensive observability system. query: Query Logstore. This type of Logstore supports high-performance queries. The index traffic fee of a Query Logstore is approximately half that of a Standard Logstore. Query Logstores do not support SQL analysis. Query Logstores are suitable for scenarios in which the amount of data is large, the log retention period is long, or log analysis is not required. If logs are stored for weeks or months, the log retention period is considered long.

preserveStorageOptional 

public java.lang.Object getPreserveStorage();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property preserveStorage: Whether to keep the log permanently.

If set to true, TTL will be ignored. Default to false.

shardCountOptional 

public java.lang.Object getShardCount();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property shardCount: The number of Shards.

Allowed Values: 1-100, default to 2.

ttlOptional 

public java.lang.Object getTtl();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property ttl: The lifecycle of log in the logstore in days.

Allowed Values: 1-3600, default to 30.