Skip to content

LogstoreProps

Properties for defining a Logstore.

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

Initializer 

import ros_cdk_sls
ros_cdk_sls.LogstoreProps(
  logstore_name: typing.Union[str, IResolvable],
  project_name: typing.Union[str, IResolvable],
  append_meta: typing.Union[bool, IResolvable] = None,
  auto_split: typing.Union[bool, IResolvable] = None,
  enable_tracking: typing.Union[bool, IResolvable] = None,
  encrypt_conf: typing.Union[IResolvable, EncryptConfProperty] = None,
  max_split_shard: typing.Union[typing.Union[int, float], IResolvable] = None,
  mode: typing.Union[str, IResolvable] = None,
  preserve_storage: typing.Union[bool, IResolvable] = None,
  shard_count: typing.Union[typing.Union[int, float], IResolvable] = None,
  ttl: typing.Union[typing.Union[int, float], IResolvable] = None
)

Properties

Name Type Description
logstore_name typing.Union[str, ros_cdk_core.IResolvable] Property logstoreName: Logstore name: 1.
project_name typing.Union[str, ros_cdk_core.IResolvable] Property projectName: Project name: 1.
append_meta typing.Union[bool, ros_cdk_core.IResolvable] Property appendMeta: Whether to add client external network IP and log arrival time after receiving the log.
auto_split typing.Union[bool, ros_cdk_core.IResolvable] Property autoSplit: Whether to automatically split the shard.
enable_tracking typing.Union[bool, ros_cdk_core.IResolvable] Property enableTracking: Whether to enable WebTracking, which supports fast capture of various browsers and iOS\/Android\/APP access information.
encrypt_conf typing.Union[ros_cdk_core.IResolvable, EncryptConfProperty] Property encryptConf: Data encryption config.
max_split_shard typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property maxSplitShard: The maximum number of shards when splitting automatically.
mode typing.Union[str, ros_cdk_core.IResolvable] Property mode: The type of the Logstore.
preserve_storage typing.Union[bool, ros_cdk_core.IResolvable] Property preserveStorage: Whether to keep the log permanently.
shard_count typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property shardCount: The number of Shards.
ttl typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property ttl: The lifecycle of log in the logstore in days.

logstore_nameRequired 

logstore_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

project_nameRequired 

project_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

append_metaOptional 

append_meta: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

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

Default to false.

auto_splitOptional 

auto_split: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property autoSplit: Whether to automatically split the shard.

Default to false.

enable_trackingOptional 

enable_tracking: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, 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.

encrypt_confOptional 

encrypt_conf: typing.Union[IResolvable, EncryptConfProperty]

Property encryptConf: Data encryption config.

max_split_shardOptional 

max_split_shard: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], 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 

mode: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

preserve_storageOptional 

preserve_storage: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property preserveStorage: Whether to keep the log permanently.

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

shard_countOptional 

shard_count: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property shardCount: The number of Shards.

Allowed Values: 1-100, default to 2.

ttlOptional 

ttl: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

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

Allowed Values: 1-3600, default to 30.