Skip to content

LogstoreProps

Properties for defining a Logstore.

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

Initializer 

import { LogstoreProps } from '@alicloud/ros-cdk-sls'
const logstoreProps: LogstoreProps = { ... }

Properties

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

logstoreNameRequired 

public readonly logstoreName: string | IResolvable;
  • Type: string | @alicloud/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 readonly projectName: string | IResolvable;
  • Type: string | @alicloud/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 readonly appendMeta: boolean | IResolvable;
  • Type: boolean | @alicloud/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 readonly autoSplit: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property autoSplit: Whether to automatically split the shard.

Default to false.

enableTrackingOptional 

public readonly enableTracking: boolean | IResolvable;
  • Type: boolean | @alicloud/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 readonly encryptConf: IResolvable | EncryptConfProperty;

Property encryptConf: Data encryption config.

maxSplitShardOptional 

public readonly maxSplitShard: number | IResolvable;
  • Type: number | @alicloud/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 readonly mode: string | IResolvable;
  • Type: string | @alicloud/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 readonly preserveStorage: boolean | IResolvable;
  • Type: boolean | @alicloud/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 readonly shardCount: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property shardCount: The number of Shards.

Allowed Values: 1-100, default to 2.

ttlOptional 

public readonly ttl: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

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

Allowed Values: 1-3600, default to 30.