volcenginecc.tls.Rule

volcenginecc v0.0.32, Apr 23 26

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

The log service provides log collection tools such as LogCollector and multi-language SDKs, supports various log collection methods, is compatible with open-source protocol frameworks like Kafka and OpenTelemetry, and supports log data collection from host applications, K8s clusters, mobile clients, Volcano Engine cloud products, and other cloud vendors.

Example Usage

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

resources:
  tLSRuleDemo:
    type: volcenginecc:tls:Rule
    name: TLSRuleDemo
    properties:
      containerRule:
        container_name_regex: ccapi-test
        env_tag:
          - key: k1
            val: v1
        exclude_container_env_regex:
          - key: k2
            val: v2
        exclude_container_label_regex:
          - key: k2
            val: v2
        include_container_env_regex:
          - key: k1
            val: v1
        include_container_label_regex:
          - key: k1
            val: v1
        kubernetes_rule:
          annotationTag:
            - key: k1
              val: v1
          enableAllLabelTag: true
          excludePodAnnotationRegex:
            - key: k2
              val: v2
          excludePodLabelRegex:
            - key: k2
              val: v2
          includePodAnnotationRegex:
            - key: k1
              val: v1
          includePodLabelRegex:
            - key: k1
              val: v1
          labelTag:
            - key: k1
              val: v1
          namespaceNameRegex: ccapi
          podNameRegex: ccapi
          workloadNameRegex: ccapi
          workloadType: Deployment
        stream: ""
      excludePaths:
        - type: Path
          value: /test
      extractRule:
        begin_regex: ""
        delimiter: ' '
        enable_nanosecond: true
        filter_key_regex:
          - key: k1
            regex: v1
        keys:
          - k1
        log_regex: ""
        log_template:
          format: ""
          type: ""
        quote: ""
        time_extract_regex: dsfasdf
        time_format: '%Y-%m-%d %H:%M:%S.%f'
        time_key: time_key
        time_sample: 2006-01-02T15:04:05Z07:00
        time_zone: Etc/GMT+12
        un_match_log_key: LogParseFailed
        un_match_up_load_switch: true
      hostGroupInfos:
        - host_group_id: 38feb3b9-xxxxx-de52cxxxxx
      inputType: 2
      logSample: asdfasf
      logType: delimiter_log
      paths:
        - /test
      ruleName: dx-rule-1
      topicId: b881e3cd-xxxxx-966f-fe98xxxxxxx
      userDefineRule:
        advanced:
          closeEof: false
          closeInactive: 10
          closeRemoved: false
          closeRenamed: false
          closeTimeout: 0
          noLineTerminatorEofMaxTime: 0
        enable_host_group_label: true
        enable_hostname: true
        enable_raw_log: true
        fields:
          - key: k1
            val: v1
        host_group_label_key: host_group_label
        hostname_key: hostname
        ignore_older: 72
        multi_collects_type: RuleID
        parse_path_rule:
          keys:
            - instance-id
            - pod-name
          pathSample: /var/logs/instanceid_any_podname/test.log
          regex: /var/logs/([a-z]*)_any_([a-z]*)/test.log
        plugin:
          processors: '{}'
        raw_log_key: raw
        shard_hash_key:
          hashKey: '2342134'
        tail_files: true
        tail_size_kb: 10240

Create Rule Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Rule(name: string, args: RuleArgs, opts?: CustomResourceOptions);

@overload
def Rule(resource_name: str,
         args: RuleArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def Rule(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         rule_name: Optional[str] = None,
         topic_id: Optional[str] = None,
         container_rule: Optional[RuleContainerRuleArgs] = None,
         exclude_paths: Optional[Sequence[RuleExcludePathArgs]] = None,
         extract_rule: Optional[RuleExtractRuleArgs] = None,
         host_group_infos: Optional[Sequence[RuleHostGroupInfoArgs]] = None,
         input_type: Optional[int] = None,
         log_sample: Optional[str] = None,
         log_type: Optional[str] = None,
         paths: Optional[Sequence[str]] = None,
         pause: Optional[int] = None,
         user_define_rule: Optional[RuleUserDefineRuleArgs] = None)

func NewRule(ctx *Context, name string, args RuleArgs, opts ...ResourceOption) (*Rule, error)

public Rule(string name, RuleArgs args, CustomResourceOptions? opts = null)

public Rule(String name, RuleArgs args)
public Rule(String name, RuleArgs args, CustomResourceOptions options)

type: volcenginecc:tls:Rule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args RuleArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args RuleArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args RuleArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args RuleArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args RuleArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Rule Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Rule resource accepts the following input properties:

RuleName string: Collection configuration name. Please refer to the resource naming rules. Must be unique within a log topic.
TopicId string: Log topic ID to which the collection configuration belongs.
ContainerRule Volcengine.RuleContainerRule: Container log collection rules.
ExcludePaths List<Volcengine.RuleExcludePath>
ExtractRule Volcengine.RuleExtractRule: Log extraction rules. Note: This parameter is required if LogType is set to any type other than minimalistlog or jsonlog.
HostGroupInfos List<Volcengine.RuleHostGroupInfo>
InputType int: Collection type. 0: (Default) Host log file. 1: K8s container stdout. 2: K8s container internal log file.
LogSample string: Log sample. Maximum length is 3000 characters. Log sample content must match the collection mode. Single-line full-text mode and JSON mode do not require a log sample. Other modes require a log sample, and the content must match the collection mode.
LogType string: Collection mode. minimalistlog: (Default) Single-line full-text mode. jsonlog: JSON mode. delimiterlog: Delimiter mode. multilinelog: Multi-line full-text mode. fullregex_log: Full regex mode.
Paths List<string>: Collection path list. You can create up to 10 collection paths. Collection paths must be specified as absolute paths; relative paths are not supported. When InputType=0 or InputType=2, collection paths support exact match and wildcard mode. Wildcards only support **, *, and ?, but you can configure at most one ** wildcard. When InputType=1, you do not need to configure the collection path list.
Pause int: Collection configuration status. 0: Running. 1: Paused.
UserDefineRule Volcengine.RuleUserDefineRule: User-defined collection rules.

RuleName string: Collection configuration name. Please refer to the resource naming rules. Must be unique within a log topic.
TopicId string: Log topic ID to which the collection configuration belongs.
ContainerRule RuleContainerRuleArgs: Container log collection rules.
ExcludePaths []RuleExcludePathArgs
ExtractRule RuleExtractRuleArgs: Log extraction rules. Note: This parameter is required if LogType is set to any type other than minimalistlog or jsonlog.
HostGroupInfos []RuleHostGroupInfoArgs
InputType int: Collection type. 0: (Default) Host log file. 1: K8s container stdout. 2: K8s container internal log file.
LogSample string: Log sample. Maximum length is 3000 characters. Log sample content must match the collection mode. Single-line full-text mode and JSON mode do not require a log sample. Other modes require a log sample, and the content must match the collection mode.
LogType string: Collection mode. minimalistlog: (Default) Single-line full-text mode. jsonlog: JSON mode. delimiterlog: Delimiter mode. multilinelog: Multi-line full-text mode. fullregex_log: Full regex mode.
Paths []string: Collection path list. You can create up to 10 collection paths. Collection paths must be specified as absolute paths; relative paths are not supported. When InputType=0 or InputType=2, collection paths support exact match and wildcard mode. Wildcards only support **, *, and ?, but you can configure at most one ** wildcard. When InputType=1, you do not need to configure the collection path list.
Pause int: Collection configuration status. 0: Running. 1: Paused.
UserDefineRule RuleUserDefineRuleArgs: User-defined collection rules.

ruleName String: Collection configuration name. Please refer to the resource naming rules. Must be unique within a log topic.
topicId String: Log topic ID to which the collection configuration belongs.
containerRule RuleContainerRule: Container log collection rules.
excludePaths List<RuleExcludePath>
extractRule RuleExtractRule: Log extraction rules. Note: This parameter is required if LogType is set to any type other than minimalistlog or jsonlog.
hostGroupInfos List<RuleHostGroupInfo>
inputType Integer: Collection type. 0: (Default) Host log file. 1: K8s container stdout. 2: K8s container internal log file.
logSample String: Log sample. Maximum length is 3000 characters. Log sample content must match the collection mode. Single-line full-text mode and JSON mode do not require a log sample. Other modes require a log sample, and the content must match the collection mode.
logType String: Collection mode. minimalistlog: (Default) Single-line full-text mode. jsonlog: JSON mode. delimiterlog: Delimiter mode. multilinelog: Multi-line full-text mode. fullregex_log: Full regex mode.
paths List<String>: Collection path list. You can create up to 10 collection paths. Collection paths must be specified as absolute paths; relative paths are not supported. When InputType=0 or InputType=2, collection paths support exact match and wildcard mode. Wildcards only support **, *, and ?, but you can configure at most one ** wildcard. When InputType=1, you do not need to configure the collection path list.
pause Integer: Collection configuration status. 0: Running. 1: Paused.
userDefineRule RuleUserDefineRule: User-defined collection rules.

ruleName string: Collection configuration name. Please refer to the resource naming rules. Must be unique within a log topic.
topicId string: Log topic ID to which the collection configuration belongs.
containerRule RuleContainerRule: Container log collection rules.
excludePaths RuleExcludePath[]
extractRule RuleExtractRule: Log extraction rules. Note: This parameter is required if LogType is set to any type other than minimalistlog or jsonlog.
hostGroupInfos RuleHostGroupInfo[]
inputType number: Collection type. 0: (Default) Host log file. 1: K8s container stdout. 2: K8s container internal log file.
logSample string: Log sample. Maximum length is 3000 characters. Log sample content must match the collection mode. Single-line full-text mode and JSON mode do not require a log sample. Other modes require a log sample, and the content must match the collection mode.
logType string: Collection mode. minimalistlog: (Default) Single-line full-text mode. jsonlog: JSON mode. delimiterlog: Delimiter mode. multilinelog: Multi-line full-text mode. fullregex_log: Full regex mode.
paths string[]: Collection path list. You can create up to 10 collection paths. Collection paths must be specified as absolute paths; relative paths are not supported. When InputType=0 or InputType=2, collection paths support exact match and wildcard mode. Wildcards only support **, *, and ?, but you can configure at most one ** wildcard. When InputType=1, you do not need to configure the collection path list.
pause number: Collection configuration status. 0: Running. 1: Paused.
userDefineRule RuleUserDefineRule: User-defined collection rules.

rule_name str: Collection configuration name. Please refer to the resource naming rules. Must be unique within a log topic.
topic_id str: Log topic ID to which the collection configuration belongs.
container_rule RuleContainerRuleArgs: Container log collection rules.
exclude_paths Sequence[RuleExcludePathArgs]
extract_rule RuleExtractRuleArgs: Log extraction rules. Note: This parameter is required if LogType is set to any type other than minimalistlog or jsonlog.
host_group_infos Sequence[RuleHostGroupInfoArgs]
input_type int: Collection type. 0: (Default) Host log file. 1: K8s container stdout. 2: K8s container internal log file.
log_sample str: Log sample. Maximum length is 3000 characters. Log sample content must match the collection mode. Single-line full-text mode and JSON mode do not require a log sample. Other modes require a log sample, and the content must match the collection mode.
log_type str: Collection mode. minimalistlog: (Default) Single-line full-text mode. jsonlog: JSON mode. delimiterlog: Delimiter mode. multilinelog: Multi-line full-text mode. fullregex_log: Full regex mode.
paths Sequence[str]: Collection path list. You can create up to 10 collection paths. Collection paths must be specified as absolute paths; relative paths are not supported. When InputType=0 or InputType=2, collection paths support exact match and wildcard mode. Wildcards only support **, *, and ?, but you can configure at most one ** wildcard. When InputType=1, you do not need to configure the collection path list.
pause int: Collection configuration status. 0: Running. 1: Paused.
user_define_rule RuleUserDefineRuleArgs: User-defined collection rules.

ruleName String: Collection configuration name. Please refer to the resource naming rules. Must be unique within a log topic.
topicId String: Log topic ID to which the collection configuration belongs.
containerRule Property Map: Container log collection rules.
excludePaths List<Property Map>
extractRule Property Map: Log extraction rules. Note: This parameter is required if LogType is set to any type other than minimalistlog or jsonlog.
hostGroupInfos List<Property Map>
inputType Number: Collection type. 0: (Default) Host log file. 1: K8s container stdout. 2: K8s container internal log file.
logSample String: Log sample. Maximum length is 3000 characters. Log sample content must match the collection mode. Single-line full-text mode and JSON mode do not require a log sample. Other modes require a log sample, and the content must match the collection mode.
logType String: Collection mode. minimalistlog: (Default) Single-line full-text mode. jsonlog: JSON mode. delimiterlog: Delimiter mode. multilinelog: Multi-line full-text mode. fullregex_log: Full regex mode.
paths List<String>: Collection path list. You can create up to 10 collection paths. Collection paths must be specified as absolute paths; relative paths are not supported. When InputType=0 or InputType=2, collection paths support exact match and wildcard mode. Wildcards only support **, *, and ?, but you can configure at most one ** wildcard. When InputType=1, you do not need to configure the collection path list.
pause Number: Collection configuration status. 0: Running. 1: Paused.
userDefineRule Property Map: User-defined collection rules.

Outputs

All input properties are implicitly available as output properties. Additionally, the Rule resource produces the following output properties:

CreateTime string: Time when the collection configuration was created.
Id string: The provider-assigned unique ID for this managed resource.
ModifyTime string: Collection configuration modification time.
ProjectId string: ID of the project to which the collection configuration belongs.
ProjectName string: Name of the project to which the collection configuration belongs
RuleId string: Collection configuration ID.
TopicName string: Name of the log topic to which the collection configuration belongs.

CreateTime string: Time when the collection configuration was created.
Id string: The provider-assigned unique ID for this managed resource.
ModifyTime string: Collection configuration modification time.
ProjectId string: ID of the project to which the collection configuration belongs.
ProjectName string: Name of the project to which the collection configuration belongs
RuleId string: Collection configuration ID.
TopicName string: Name of the log topic to which the collection configuration belongs.

createTime String: Time when the collection configuration was created.
id String: The provider-assigned unique ID for this managed resource.
modifyTime String: Collection configuration modification time.
projectId String: ID of the project to which the collection configuration belongs.
projectName String: Name of the project to which the collection configuration belongs
ruleId String: Collection configuration ID.
topicName String: Name of the log topic to which the collection configuration belongs.

createTime string: Time when the collection configuration was created.
id string: The provider-assigned unique ID for this managed resource.
modifyTime string: Collection configuration modification time.
projectId string: ID of the project to which the collection configuration belongs.
projectName string: Name of the project to which the collection configuration belongs
ruleId string: Collection configuration ID.
topicName string: Name of the log topic to which the collection configuration belongs.

create_time str: Time when the collection configuration was created.
id str: The provider-assigned unique ID for this managed resource.
modify_time str: Collection configuration modification time.
project_id str: ID of the project to which the collection configuration belongs.
project_name str: Name of the project to which the collection configuration belongs
rule_id str: Collection configuration ID.
topic_name str: Name of the log topic to which the collection configuration belongs.

createTime String: Time when the collection configuration was created.
id String: The provider-assigned unique ID for this managed resource.
modifyTime String: Collection configuration modification time.
projectId String: ID of the project to which the collection configuration belongs.
projectName String: Name of the project to which the collection configuration belongs
ruleId String: Collection configuration ID.
topicName String: Name of the log topic to which the collection configuration belongs.

Look up Existing Rule Resource

Get an existing Rule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: RuleState, opts?: CustomResourceOptions): Rule

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        container_rule: Optional[RuleContainerRuleArgs] = None,
        create_time: Optional[str] = None,
        exclude_paths: Optional[Sequence[RuleExcludePathArgs]] = None,
        extract_rule: Optional[RuleExtractRuleArgs] = None,
        host_group_infos: Optional[Sequence[RuleHostGroupInfoArgs]] = None,
        input_type: Optional[int] = None,
        log_sample: Optional[str] = None,
        log_type: Optional[str] = None,
        modify_time: Optional[str] = None,
        paths: Optional[Sequence[str]] = None,
        pause: Optional[int] = None,
        project_id: Optional[str] = None,
        project_name: Optional[str] = None,
        rule_id: Optional[str] = None,
        rule_name: Optional[str] = None,
        topic_id: Optional[str] = None,
        topic_name: Optional[str] = None,
        user_define_rule: Optional[RuleUserDefineRuleArgs] = None) -> Rule

func GetRule(ctx *Context, name string, id IDInput, state *RuleState, opts ...ResourceOption) (*Rule, error)

public static Rule Get(string name, Input<string> id, RuleState? state, CustomResourceOptions? opts = null)

public static Rule get(String name, Output<String> id, RuleState state, CustomResourceOptions options)

resources:  _:    type: volcenginecc:tls:Rule    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

ContainerRule Volcengine.RuleContainerRule: Container log collection rules.
CreateTime string: Time when the collection configuration was created.
ExcludePaths List<Volcengine.RuleExcludePath>
ExtractRule Volcengine.RuleExtractRule: Log extraction rules. Note: This parameter is required if LogType is set to any type other than minimalistlog or jsonlog.
HostGroupInfos List<Volcengine.RuleHostGroupInfo>
InputType int: Collection type. 0: (Default) Host log file. 1: K8s container stdout. 2: K8s container internal log file.
LogSample string: Log sample. Maximum length is 3000 characters. Log sample content must match the collection mode. Single-line full-text mode and JSON mode do not require a log sample. Other modes require a log sample, and the content must match the collection mode.
LogType string: Collection mode. minimalistlog: (Default) Single-line full-text mode. jsonlog: JSON mode. delimiterlog: Delimiter mode. multilinelog: Multi-line full-text mode. fullregex_log: Full regex mode.
ModifyTime string: Collection configuration modification time.
Paths List<string>: Collection path list. You can create up to 10 collection paths. Collection paths must be specified as absolute paths; relative paths are not supported. When InputType=0 or InputType=2, collection paths support exact match and wildcard mode. Wildcards only support **, *, and ?, but you can configure at most one ** wildcard. When InputType=1, you do not need to configure the collection path list.
Pause int: Collection configuration status. 0: Running. 1: Paused.
ProjectId string: ID of the project to which the collection configuration belongs.
ProjectName string: Name of the project to which the collection configuration belongs
RuleId string: Collection configuration ID.
RuleName string: Collection configuration name. Please refer to the resource naming rules. Must be unique within a log topic.
TopicId string: Log topic ID to which the collection configuration belongs.
TopicName string: Name of the log topic to which the collection configuration belongs.
UserDefineRule Volcengine.RuleUserDefineRule: User-defined collection rules.

ContainerRule RuleContainerRuleArgs: Container log collection rules.
CreateTime string: Time when the collection configuration was created.
ExcludePaths []RuleExcludePathArgs
ExtractRule RuleExtractRuleArgs: Log extraction rules. Note: This parameter is required if LogType is set to any type other than minimalistlog or jsonlog.
HostGroupInfos []RuleHostGroupInfoArgs
InputType int: Collection type. 0: (Default) Host log file. 1: K8s container stdout. 2: K8s container internal log file.
LogSample string: Log sample. Maximum length is 3000 characters. Log sample content must match the collection mode. Single-line full-text mode and JSON mode do not require a log sample. Other modes require a log sample, and the content must match the collection mode.
LogType string: Collection mode. minimalistlog: (Default) Single-line full-text mode. jsonlog: JSON mode. delimiterlog: Delimiter mode. multilinelog: Multi-line full-text mode. fullregex_log: Full regex mode.
ModifyTime string: Collection configuration modification time.
Paths []string: Collection path list. You can create up to 10 collection paths. Collection paths must be specified as absolute paths; relative paths are not supported. When InputType=0 or InputType=2, collection paths support exact match and wildcard mode. Wildcards only support **, *, and ?, but you can configure at most one ** wildcard. When InputType=1, you do not need to configure the collection path list.
Pause int: Collection configuration status. 0: Running. 1: Paused.
ProjectId string: ID of the project to which the collection configuration belongs.
ProjectName string: Name of the project to which the collection configuration belongs
RuleId string: Collection configuration ID.
RuleName string: Collection configuration name. Please refer to the resource naming rules. Must be unique within a log topic.
TopicId string: Log topic ID to which the collection configuration belongs.
TopicName string: Name of the log topic to which the collection configuration belongs.
UserDefineRule RuleUserDefineRuleArgs: User-defined collection rules.

containerRule RuleContainerRule: Container log collection rules.
createTime String: Time when the collection configuration was created.
excludePaths List<RuleExcludePath>
extractRule RuleExtractRule: Log extraction rules. Note: This parameter is required if LogType is set to any type other than minimalistlog or jsonlog.
hostGroupInfos List<RuleHostGroupInfo>
inputType Integer: Collection type. 0: (Default) Host log file. 1: K8s container stdout. 2: K8s container internal log file.
logSample String: Log sample. Maximum length is 3000 characters. Log sample content must match the collection mode. Single-line full-text mode and JSON mode do not require a log sample. Other modes require a log sample, and the content must match the collection mode.
logType String: Collection mode. minimalistlog: (Default) Single-line full-text mode. jsonlog: JSON mode. delimiterlog: Delimiter mode. multilinelog: Multi-line full-text mode. fullregex_log: Full regex mode.
modifyTime String: Collection configuration modification time.
paths List<String>: Collection path list. You can create up to 10 collection paths. Collection paths must be specified as absolute paths; relative paths are not supported. When InputType=0 or InputType=2, collection paths support exact match and wildcard mode. Wildcards only support **, *, and ?, but you can configure at most one ** wildcard. When InputType=1, you do not need to configure the collection path list.
pause Integer: Collection configuration status. 0: Running. 1: Paused.
projectId String: ID of the project to which the collection configuration belongs.
projectName String: Name of the project to which the collection configuration belongs
ruleId String: Collection configuration ID.
ruleName String: Collection configuration name. Please refer to the resource naming rules. Must be unique within a log topic.
topicId String: Log topic ID to which the collection configuration belongs.
topicName String: Name of the log topic to which the collection configuration belongs.
userDefineRule RuleUserDefineRule: User-defined collection rules.

containerRule RuleContainerRule: Container log collection rules.
createTime string: Time when the collection configuration was created.
excludePaths RuleExcludePath[]
extractRule RuleExtractRule: Log extraction rules. Note: This parameter is required if LogType is set to any type other than minimalistlog or jsonlog.
hostGroupInfos RuleHostGroupInfo[]
inputType number: Collection type. 0: (Default) Host log file. 1: K8s container stdout. 2: K8s container internal log file.
logSample string: Log sample. Maximum length is 3000 characters. Log sample content must match the collection mode. Single-line full-text mode and JSON mode do not require a log sample. Other modes require a log sample, and the content must match the collection mode.
logType string: Collection mode. minimalistlog: (Default) Single-line full-text mode. jsonlog: JSON mode. delimiterlog: Delimiter mode. multilinelog: Multi-line full-text mode. fullregex_log: Full regex mode.
modifyTime string: Collection configuration modification time.
paths string[]: Collection path list. You can create up to 10 collection paths. Collection paths must be specified as absolute paths; relative paths are not supported. When InputType=0 or InputType=2, collection paths support exact match and wildcard mode. Wildcards only support **, *, and ?, but you can configure at most one ** wildcard. When InputType=1, you do not need to configure the collection path list.
pause number: Collection configuration status. 0: Running. 1: Paused.
projectId string: ID of the project to which the collection configuration belongs.
projectName string: Name of the project to which the collection configuration belongs
ruleId string: Collection configuration ID.
ruleName string: Collection configuration name. Please refer to the resource naming rules. Must be unique within a log topic.
topicId string: Log topic ID to which the collection configuration belongs.
topicName string: Name of the log topic to which the collection configuration belongs.
userDefineRule RuleUserDefineRule: User-defined collection rules.

container_rule RuleContainerRuleArgs: Container log collection rules.
create_time str: Time when the collection configuration was created.
exclude_paths Sequence[RuleExcludePathArgs]
extract_rule RuleExtractRuleArgs: Log extraction rules. Note: This parameter is required if LogType is set to any type other than minimalistlog or jsonlog.
host_group_infos Sequence[RuleHostGroupInfoArgs]
input_type int: Collection type. 0: (Default) Host log file. 1: K8s container stdout. 2: K8s container internal log file.
log_sample str: Log sample. Maximum length is 3000 characters. Log sample content must match the collection mode. Single-line full-text mode and JSON mode do not require a log sample. Other modes require a log sample, and the content must match the collection mode.
log_type str: Collection mode. minimalistlog: (Default) Single-line full-text mode. jsonlog: JSON mode. delimiterlog: Delimiter mode. multilinelog: Multi-line full-text mode. fullregex_log: Full regex mode.
modify_time str: Collection configuration modification time.
paths Sequence[str]: Collection path list. You can create up to 10 collection paths. Collection paths must be specified as absolute paths; relative paths are not supported. When InputType=0 or InputType=2, collection paths support exact match and wildcard mode. Wildcards only support **, *, and ?, but you can configure at most one ** wildcard. When InputType=1, you do not need to configure the collection path list.
pause int: Collection configuration status. 0: Running. 1: Paused.
project_id str: ID of the project to which the collection configuration belongs.
project_name str: Name of the project to which the collection configuration belongs
rule_id str: Collection configuration ID.
rule_name str: Collection configuration name. Please refer to the resource naming rules. Must be unique within a log topic.
topic_id str: Log topic ID to which the collection configuration belongs.
topic_name str: Name of the log topic to which the collection configuration belongs.
user_define_rule RuleUserDefineRuleArgs: User-defined collection rules.

containerRule Property Map: Container log collection rules.
createTime String: Time when the collection configuration was created.
excludePaths List<Property Map>
extractRule Property Map: Log extraction rules. Note: This parameter is required if LogType is set to any type other than minimalistlog or jsonlog.
hostGroupInfos List<Property Map>
inputType Number: Collection type. 0: (Default) Host log file. 1: K8s container stdout. 2: K8s container internal log file.
logSample String: Log sample. Maximum length is 3000 characters. Log sample content must match the collection mode. Single-line full-text mode and JSON mode do not require a log sample. Other modes require a log sample, and the content must match the collection mode.
logType String: Collection mode. minimalistlog: (Default) Single-line full-text mode. jsonlog: JSON mode. delimiterlog: Delimiter mode. multilinelog: Multi-line full-text mode. fullregex_log: Full regex mode.
modifyTime String: Collection configuration modification time.
paths List<String>: Collection path list. You can create up to 10 collection paths. Collection paths must be specified as absolute paths; relative paths are not supported. When InputType=0 or InputType=2, collection paths support exact match and wildcard mode. Wildcards only support **, *, and ?, but you can configure at most one ** wildcard. When InputType=1, you do not need to configure the collection path list.
pause Number: Collection configuration status. 0: Running. 1: Paused.
projectId String: ID of the project to which the collection configuration belongs.
projectName String: Name of the project to which the collection configuration belongs
ruleId String: Collection configuration ID.
ruleName String: Collection configuration name. Please refer to the resource naming rules. Must be unique within a log topic.
topicId String: Log topic ID to which the collection configuration belongs.
topicName String: Name of the log topic to which the collection configuration belongs.
userDefineRule Property Map: User-defined collection rules.

Supporting Types

RuleContainerRule, RuleContainerRuleArgs

ContainerNameRegex string: Container name to collect. If no container name is specified, all containers in the machine group will be collected. Supports regex matching; for example, setting the container name to ^(container-test)$ will collect all containers named container-test.
EnvTags List<Volcengine.RuleContainerRuleEnvTag>
ExcludeContainerEnvRegexes List<Volcengine.RuleContainerRuleExcludeContainerEnvRegex>
ExcludeContainerLabelRegexes List<Volcengine.RuleContainerRuleExcludeContainerLabelRegex>
IncludeContainerEnvRegexes List<Volcengine.RuleContainerRuleIncludeContainerEnvRegex>
IncludeContainerLabelRegexes List<Volcengine.RuleContainerRuleIncludeContainerLabelRegex>
KubernetesRule Volcengine.RuleContainerRuleKubernetesRule: Kubernetes container collection rules.
Stream string: Collection information. stdout: Collects container standard output (stdout). stderr: Collects container standard error (stderr). all: Collects both container standard output (stdout) and standard error (stderr).

ContainerNameRegex string: Container name to collect. If no container name is specified, all containers in the machine group will be collected. Supports regex matching; for example, setting the container name to ^(container-test)$ will collect all containers named container-test.
EnvTags []RuleContainerRuleEnvTag
ExcludeContainerEnvRegexes []RuleContainerRuleExcludeContainerEnvRegex
ExcludeContainerLabelRegexes []RuleContainerRuleExcludeContainerLabelRegex
IncludeContainerEnvRegexes []RuleContainerRuleIncludeContainerEnvRegex
IncludeContainerLabelRegexes []RuleContainerRuleIncludeContainerLabelRegex
KubernetesRule RuleContainerRuleKubernetesRule: Kubernetes container collection rules.
Stream string: Collection information. stdout: Collects container standard output (stdout). stderr: Collects container standard error (stderr). all: Collects both container standard output (stdout) and standard error (stderr).

containerNameRegex String: Container name to collect. If no container name is specified, all containers in the machine group will be collected. Supports regex matching; for example, setting the container name to ^(container-test)$ will collect all containers named container-test.
envTags List<RuleContainerRuleEnvTag>
excludeContainerEnvRegexes List<RuleContainerRuleExcludeContainerEnvRegex>
excludeContainerLabelRegexes List<RuleContainerRuleExcludeContainerLabelRegex>
includeContainerEnvRegexes List<RuleContainerRuleIncludeContainerEnvRegex>
includeContainerLabelRegexes List<RuleContainerRuleIncludeContainerLabelRegex>
kubernetesRule RuleContainerRuleKubernetesRule: Kubernetes container collection rules.
stream String: Collection information. stdout: Collects container standard output (stdout). stderr: Collects container standard error (stderr). all: Collects both container standard output (stdout) and standard error (stderr).

containerNameRegex string: Container name to collect. If no container name is specified, all containers in the machine group will be collected. Supports regex matching; for example, setting the container name to ^(container-test)$ will collect all containers named container-test.
envTags RuleContainerRuleEnvTag[]
excludeContainerEnvRegexes RuleContainerRuleExcludeContainerEnvRegex[]
excludeContainerLabelRegexes RuleContainerRuleExcludeContainerLabelRegex[]
includeContainerEnvRegexes RuleContainerRuleIncludeContainerEnvRegex[]
includeContainerLabelRegexes RuleContainerRuleIncludeContainerLabelRegex[]
kubernetesRule RuleContainerRuleKubernetesRule: Kubernetes container collection rules.
stream string: Collection information. stdout: Collects container standard output (stdout). stderr: Collects container standard error (stderr). all: Collects both container standard output (stdout) and standard error (stderr).

container_name_regex str: Container name to collect. If no container name is specified, all containers in the machine group will be collected. Supports regex matching; for example, setting the container name to ^(container-test)$ will collect all containers named container-test.
env_tags Sequence[RuleContainerRuleEnvTag]
exclude_container_env_regexes Sequence[RuleContainerRuleExcludeContainerEnvRegex]
exclude_container_label_regexes Sequence[RuleContainerRuleExcludeContainerLabelRegex]
include_container_env_regexes Sequence[RuleContainerRuleIncludeContainerEnvRegex]
include_container_label_regexes Sequence[RuleContainerRuleIncludeContainerLabelRegex]
kubernetes_rule RuleContainerRuleKubernetesRule: Kubernetes container collection rules.
stream str: Collection information. stdout: Collects container standard output (stdout). stderr: Collects container standard error (stderr). all: Collects both container standard output (stdout) and standard error (stderr).

containerNameRegex String: Container name to collect. If no container name is specified, all containers in the machine group will be collected. Supports regex matching; for example, setting the container name to ^(container-test)$ will collect all containers named container-test.
envTags List<Property Map>
excludeContainerEnvRegexes List<Property Map>
excludeContainerLabelRegexes List<Property Map>
includeContainerEnvRegexes List<Property Map>
includeContainerLabelRegexes List<Property Map>
kubernetesRule Property Map: Kubernetes container collection rules.
stream String: Collection information. stdout: Collects container standard output (stdout). stderr: Collects container standard error (stderr). all: Collects both container standard output (stdout) and standard error (stderr).

RuleContainerRuleEnvTag, RuleContainerRuleEnvTagArgs

Key string: Key.
Val string: Value.

Key string: Key.
Val string: Value.

key String: Key.
val String: Value.

key string: Key.
val string: Value.

key str: Key.
val str: Value.

key String: Key.
val String: Value.

RuleContainerRuleExcludeContainerEnvRegex, RuleContainerRuleExcludeContainerEnvRegexArgs

Key string: Key.
Val string: Value.

Key string: Key.
Val string: Value.

key String: Key.
val String: Value.

key string: Key.
val string: Value.

key str: Key.
val str: Value.

key String: Key.
val String: Value.

RuleContainerRuleExcludeContainerLabelRegex, RuleContainerRuleExcludeContainerLabelRegexArgs

Key string: Key.
Val string: Value.

Key string: Key.
Val string: Value.

key String: Key.
val String: Value.

key string: Key.
val string: Value.

key str: Key.
val str: Value.

key String: Key.
val String: Value.

RuleContainerRuleIncludeContainerEnvRegex, RuleContainerRuleIncludeContainerEnvRegexArgs

Key string: Key.
Val string: Value.

Key string: Key.
Val string: Value.

key String: Key.
val String: Value.

key string: Key.
val string: Value.

key str: Key.
val str: Value.

key String: Key.
val String: Value.

RuleContainerRuleIncludeContainerLabelRegex, RuleContainerRuleIncludeContainerLabelRegexArgs

Key string: Key.
Val string: Value.

Key string: Key.
Val string: Value.

key String: Key.
val String: Value.

key string: Key.
val string: Value.

key str: Key.
val str: Value.

key String: Key.
val String: Value.

RuleContainerRuleKubernetesRule, RuleContainerRuleKubernetesRuleArgs

AnnotationTags List<Volcengine.RuleContainerRuleKubernetesRuleAnnotationTag>
EnableAllLabelTag bool: Whether to add all Kubernetes Labels as log tags to the original log data. When enabled, the log service adds fields for all Labels in the Kubernetes Pod to the logs. For example, if the Pod contains Label source=DC and destination=CS, the logs will include fields tagsource__: DC and **tag**destination__: CS.
ExcludePodAnnotationRegexes List<Volcengine.RuleContainerRuleKubernetesRuleExcludePodAnnotationRegex>
ExcludePodLabelRegexes List<Volcengine.RuleContainerRuleKubernetesRuleExcludePodLabelRegex>
IncludePodAnnotationRegexes List<Volcengine.RuleContainerRuleKubernetesRuleIncludePodAnnotationRegex>
IncludePodLabelRegexes List<Volcengine.RuleContainerRuleKubernetesRuleIncludePodLabelRegex>
LabelTags List<Volcengine.RuleContainerRuleKubernetesRuleLabelTag>
NamespaceNameRegex string: Name of the Kubernetes Namespace to collect. If no Namespace name is specified, all containers will be collected. Namespace names support regular expression matching. For example, if you set the Namespace name to ^(tcp|udp)$, it will collect all containers under the tcp and udp namespaces.
PodNameRegex string: Pod name is used to specify the Pod whose containers will be collected. If no Pod name is specified, all containers will be collected. Pod name supports regular expression matching. For example, setting the Pod name to ^(http.*)$ collects all containers under Pods whose names start with http.
WorkloadNameRegex string: Specify the container to collect by workload name. If no workload name is specified, all containers are collected. Workload names support regular expressions. For example, setting the workload name to ^(http.*)$ collects all containers under workloads starting with http.
WorkloadType string: Specify the container to collect by workload type. Only one type can be selected. If no type is specified, containers of all types will be collected. Supported workload types: Deployment: stateless workload StatefulSet: stateful workload DaemonSet: daemon process Job: task CronJob: scheduled task

AnnotationTags []RuleContainerRuleKubernetesRuleAnnotationTag
EnableAllLabelTag bool: Whether to add all Kubernetes Labels as log tags to the original log data. When enabled, the log service adds fields for all Labels in the Kubernetes Pod to the logs. For example, if the Pod contains Label source=DC and destination=CS, the logs will include fields tagsource__: DC and **tag**destination__: CS.
ExcludePodAnnotationRegexes []RuleContainerRuleKubernetesRuleExcludePodAnnotationRegex
ExcludePodLabelRegexes []RuleContainerRuleKubernetesRuleExcludePodLabelRegex
IncludePodAnnotationRegexes []RuleContainerRuleKubernetesRuleIncludePodAnnotationRegex
IncludePodLabelRegexes []RuleContainerRuleKubernetesRuleIncludePodLabelRegex
LabelTags []RuleContainerRuleKubernetesRuleLabelTag
NamespaceNameRegex string: Name of the Kubernetes Namespace to collect. If no Namespace name is specified, all containers will be collected. Namespace names support regular expression matching. For example, if you set the Namespace name to ^(tcp|udp)$, it will collect all containers under the tcp and udp namespaces.
PodNameRegex string: Pod name is used to specify the Pod whose containers will be collected. If no Pod name is specified, all containers will be collected. Pod name supports regular expression matching. For example, setting the Pod name to ^(http.*)$ collects all containers under Pods whose names start with http.
WorkloadNameRegex string: Specify the container to collect by workload name. If no workload name is specified, all containers are collected. Workload names support regular expressions. For example, setting the workload name to ^(http.*)$ collects all containers under workloads starting with http.
WorkloadType string: Specify the container to collect by workload type. Only one type can be selected. If no type is specified, containers of all types will be collected. Supported workload types: Deployment: stateless workload StatefulSet: stateful workload DaemonSet: daemon process Job: task CronJob: scheduled task

annotationTags List<RuleContainerRuleKubernetesRuleAnnotationTag>
enableAllLabelTag Boolean: Whether to add all Kubernetes Labels as log tags to the original log data. When enabled, the log service adds fields for all Labels in the Kubernetes Pod to the logs. For example, if the Pod contains Label source=DC and destination=CS, the logs will include fields tagsource__: DC and **tag**destination__: CS.
excludePodAnnotationRegexes List<RuleContainerRuleKubernetesRuleExcludePodAnnotationRegex>
excludePodLabelRegexes List<RuleContainerRuleKubernetesRuleExcludePodLabelRegex>
includePodAnnotationRegexes List<RuleContainerRuleKubernetesRuleIncludePodAnnotationRegex>
includePodLabelRegexes List<RuleContainerRuleKubernetesRuleIncludePodLabelRegex>
labelTags List<RuleContainerRuleKubernetesRuleLabelTag>
namespaceNameRegex String: Name of the Kubernetes Namespace to collect. If no Namespace name is specified, all containers will be collected. Namespace names support regular expression matching. For example, if you set the Namespace name to ^(tcp|udp)$, it will collect all containers under the tcp and udp namespaces.
podNameRegex String: Pod name is used to specify the Pod whose containers will be collected. If no Pod name is specified, all containers will be collected. Pod name supports regular expression matching. For example, setting the Pod name to ^(http.*)$ collects all containers under Pods whose names start with http.
workloadNameRegex String: Specify the container to collect by workload name. If no workload name is specified, all containers are collected. Workload names support regular expressions. For example, setting the workload name to ^(http.*)$ collects all containers under workloads starting with http.
workloadType String: Specify the container to collect by workload type. Only one type can be selected. If no type is specified, containers of all types will be collected. Supported workload types: Deployment: stateless workload StatefulSet: stateful workload DaemonSet: daemon process Job: task CronJob: scheduled task

annotationTags RuleContainerRuleKubernetesRuleAnnotationTag[]
enableAllLabelTag boolean: Whether to add all Kubernetes Labels as log tags to the original log data. When enabled, the log service adds fields for all Labels in the Kubernetes Pod to the logs. For example, if the Pod contains Label source=DC and destination=CS, the logs will include fields tagsource__: DC and **tag**destination__: CS.
excludePodAnnotationRegexes RuleContainerRuleKubernetesRuleExcludePodAnnotationRegex[]
excludePodLabelRegexes RuleContainerRuleKubernetesRuleExcludePodLabelRegex[]
includePodAnnotationRegexes RuleContainerRuleKubernetesRuleIncludePodAnnotationRegex[]
includePodLabelRegexes RuleContainerRuleKubernetesRuleIncludePodLabelRegex[]
labelTags RuleContainerRuleKubernetesRuleLabelTag[]
namespaceNameRegex string: Name of the Kubernetes Namespace to collect. If no Namespace name is specified, all containers will be collected. Namespace names support regular expression matching. For example, if you set the Namespace name to ^(tcp|udp)$, it will collect all containers under the tcp and udp namespaces.
podNameRegex string: Pod name is used to specify the Pod whose containers will be collected. If no Pod name is specified, all containers will be collected. Pod name supports regular expression matching. For example, setting the Pod name to ^(http.*)$ collects all containers under Pods whose names start with http.
workloadNameRegex string: Specify the container to collect by workload name. If no workload name is specified, all containers are collected. Workload names support regular expressions. For example, setting the workload name to ^(http.*)$ collects all containers under workloads starting with http.
workloadType string: Specify the container to collect by workload type. Only one type can be selected. If no type is specified, containers of all types will be collected. Supported workload types: Deployment: stateless workload StatefulSet: stateful workload DaemonSet: daemon process Job: task CronJob: scheduled task

annotation_tags Sequence[RuleContainerRuleKubernetesRuleAnnotationTag]
enable_all_label_tag bool: Whether to add all Kubernetes Labels as log tags to the original log data. When enabled, the log service adds fields for all Labels in the Kubernetes Pod to the logs. For example, if the Pod contains Label source=DC and destination=CS, the logs will include fields tagsource__: DC and **tag**destination__: CS.
exclude_pod_annotation_regexes Sequence[RuleContainerRuleKubernetesRuleExcludePodAnnotationRegex]
exclude_pod_label_regexes Sequence[RuleContainerRuleKubernetesRuleExcludePodLabelRegex]
include_pod_annotation_regexes Sequence[RuleContainerRuleKubernetesRuleIncludePodAnnotationRegex]
include_pod_label_regexes Sequence[RuleContainerRuleKubernetesRuleIncludePodLabelRegex]
label_tags Sequence[RuleContainerRuleKubernetesRuleLabelTag]
namespace_name_regex str: Name of the Kubernetes Namespace to collect. If no Namespace name is specified, all containers will be collected. Namespace names support regular expression matching. For example, if you set the Namespace name to ^(tcp|udp)$, it will collect all containers under the tcp and udp namespaces.
pod_name_regex str: Pod name is used to specify the Pod whose containers will be collected. If no Pod name is specified, all containers will be collected. Pod name supports regular expression matching. For example, setting the Pod name to ^(http.*)$ collects all containers under Pods whose names start with http.
workload_name_regex str: Specify the container to collect by workload name. If no workload name is specified, all containers are collected. Workload names support regular expressions. For example, setting the workload name to ^(http.*)$ collects all containers under workloads starting with http.
workload_type str: Specify the container to collect by workload type. Only one type can be selected. If no type is specified, containers of all types will be collected. Supported workload types: Deployment: stateless workload StatefulSet: stateful workload DaemonSet: daemon process Job: task CronJob: scheduled task

annotationTags List<Property Map>
enableAllLabelTag Boolean: Whether to add all Kubernetes Labels as log tags to the original log data. When enabled, the log service adds fields for all Labels in the Kubernetes Pod to the logs. For example, if the Pod contains Label source=DC and destination=CS, the logs will include fields tagsource__: DC and **tag**destination__: CS.
excludePodAnnotationRegexes List<Property Map>
excludePodLabelRegexes List<Property Map>
includePodAnnotationRegexes List<Property Map>
includePodLabelRegexes List<Property Map>
labelTags List<Property Map>
namespaceNameRegex String: Name of the Kubernetes Namespace to collect. If no Namespace name is specified, all containers will be collected. Namespace names support regular expression matching. For example, if you set the Namespace name to ^(tcp|udp)$, it will collect all containers under the tcp and udp namespaces.
podNameRegex String: Pod name is used to specify the Pod whose containers will be collected. If no Pod name is specified, all containers will be collected. Pod name supports regular expression matching. For example, setting the Pod name to ^(http.*)$ collects all containers under Pods whose names start with http.
workloadNameRegex String: Specify the container to collect by workload name. If no workload name is specified, all containers are collected. Workload names support regular expressions. For example, setting the workload name to ^(http.*)$ collects all containers under workloads starting with http.
workloadType String: Specify the container to collect by workload type. Only one type can be selected. If no type is specified, containers of all types will be collected. Supported workload types: Deployment: stateless workload StatefulSet: stateful workload DaemonSet: daemon process Job: task CronJob: scheduled task

RuleContainerRuleKubernetesRuleAnnotationTag, RuleContainerRuleKubernetesRuleAnnotationTagArgs

Key string: Key.
Val string: Value.

Key string: Key.
Val string: Value.

key String: Key.
val String: Value.

key string: Key.
val string: Value.

key str: Key.
val str: Value.

key String: Key.
val String: Value.

RuleContainerRuleKubernetesRuleExcludePodAnnotationRegex, RuleContainerRuleKubernetesRuleExcludePodAnnotationRegexArgs

Key string: Key.
Val string: Value.

Key string: Key.
Val string: Value.

key String: Key.
val String: Value.

key string: Key.
val string: Value.

key str: Key.
val str: Value.

key String: Key.
val String: Value.

RuleContainerRuleKubernetesRuleExcludePodLabelRegex, RuleContainerRuleKubernetesRuleExcludePodLabelRegexArgs

Key string: Key.
Val string: Value.

Key string: Key.
Val string: Value.

key String: Key.
val String: Value.

key string: Key.
val string: Value.

key str: Key.
val str: Value.

key String: Key.
val String: Value.

RuleContainerRuleKubernetesRuleIncludePodAnnotationRegex, RuleContainerRuleKubernetesRuleIncludePodAnnotationRegexArgs

Key string: Key.
Val string: Value.

Key string: Key.
Val string: Value.

key String: Key.
val String: Value.

key string: Key.
val string: Value.

key str: Key.
val str: Value.

key String: Key.
val String: Value.

RuleContainerRuleKubernetesRuleIncludePodLabelRegex, RuleContainerRuleKubernetesRuleIncludePodLabelRegexArgs

Key string: Key.
Val string: Value.

Key string: Key.
Val string: Value.

key String: Key.
val String: Value.

key string: Key.
val string: Value.

key str: Key.
val str: Value.

key String: Key.
val String: Value.

RuleContainerRuleKubernetesRuleLabelTag, RuleContainerRuleKubernetesRuleLabelTagArgs

Key string: Key.
Val string: Value.

Key string: Key.
Val string: Value.

key String: Key.
val String: Value.

key string: Key.
val string: Value.

key str: Key.
val str: Value.

key String: Key.
val String: Value.

RuleExcludePath, RuleExcludePathArgs

Type string: Collection path type. File: File name. Path: Directory.
Value string: Collection path. Must be specified as an absolute path. When Type is Path, Value indicates a directory. When Type is File, Value indicates a file name.

Type string: Collection path type. File: File name. Path: Directory.
Value string: Collection path. Must be specified as an absolute path. When Type is Path, Value indicates a directory. When Type is File, Value indicates a file name.

type String: Collection path type. File: File name. Path: Directory.
value String: Collection path. Must be specified as an absolute path. When Type is Path, Value indicates a directory. When Type is File, Value indicates a file name.

type string: Collection path type. File: File name. Path: Directory.
value string: Collection path. Must be specified as an absolute path. When Type is Path, Value indicates a directory. When Type is File, Value indicates a file name.

type str: Collection path type. File: File name. Path: Directory.
value str: Collection path. Must be specified as an absolute path. When Type is Path, Value indicates a directory. When Type is File, Value indicates a file name.

type String: Collection path type. File: File name. Path: Directory.
value String: Collection path. Must be specified as an absolute path. When Type is Path, Value indicates a directory. When Type is File, Value indicates a file name.

RuleExtractRule, RuleExtractRuleArgs

BeginRegex string: Regular expression that the first line of the log must match. Valid only when LogType is multilinelog or fullregexlog. Must be a valid regular expression.
Delimiter string: Log delimiter. Valid only when LogType is delimiter_log.
EnableNanosecond bool: Enable nanosecond precision time. When enabled, log time parsing will include and report nanosecond precision. true: Enable nanosecond precision time. false: Disable nanosecond precision time.
FilterKeyRegexes List<Volcengine.RuleExtractRuleFilterKeyRegex>
Keys List<string>: List of log field names (Key). This is only valid when LogType is delimiterlog or fullregexlog. You can configure up to 100 field names. When LogType is delimiterlog, field names must be unique and cannot all be empty. When LogType is fullregexlog, field names must be unique and cannot be empty.
LogRegex string: The entire log must match the specified regular expression. This is only valid when the collected log type is fullregex_log. Must be a valid regular expression.
LogTemplate Volcengine.RuleExtractRuleLogTemplate: Automatically extract log fields based on the specified log template
Quote string: Quoting character. Content wrapped by a quoting character will not be split but parsed as a complete field. Only valid when LogType is delimiter_log.
TimeExtractRegex string: Regular expression for extracting time, used to extract the time value from the TimeKey field and parse it as the collection time
TimeFormat string: Parsing format for the time field. If you use a specific time field in the log as the log timestamp, you must provide both TimeKey and TimeFormat. TimeKey and TimeFormat must be used together.
TimeKey string: Name of the log time field. If you want to use a specific time field in the log as the log timestamp, you need to specify both TimeKey and TimeFormat. TimeKey and TimeFormat must be provided together.
TimeSample string: Time sample. Used to check whether the entered time parsing format is correct.
TimeZone string: Time zone. Supports machine time zone (default) and custom time zone. Custom time zone supports GMT and UTC. GMT format: GMT+08:00. UTC format: Asia/Shanghai.
UnMatchLogKey string: Key name for unmatched logs.
UnMatchUpLoadSwitch bool: Switch for uploading unmatched logs.

BeginRegex string: Regular expression that the first line of the log must match. Valid only when LogType is multilinelog or fullregexlog. Must be a valid regular expression.
Delimiter string: Log delimiter. Valid only when LogType is delimiter_log.
EnableNanosecond bool: Enable nanosecond precision time. When enabled, log time parsing will include and report nanosecond precision. true: Enable nanosecond precision time. false: Disable nanosecond precision time.
FilterKeyRegexes []RuleExtractRuleFilterKeyRegex
Keys []string: List of log field names (Key). This is only valid when LogType is delimiterlog or fullregexlog. You can configure up to 100 field names. When LogType is delimiterlog, field names must be unique and cannot all be empty. When LogType is fullregexlog, field names must be unique and cannot be empty.
LogRegex string: The entire log must match the specified regular expression. This is only valid when the collected log type is fullregex_log. Must be a valid regular expression.
LogTemplate RuleExtractRuleLogTemplate: Automatically extract log fields based on the specified log template
Quote string: Quoting character. Content wrapped by a quoting character will not be split but parsed as a complete field. Only valid when LogType is delimiter_log.
TimeExtractRegex string: Regular expression for extracting time, used to extract the time value from the TimeKey field and parse it as the collection time
TimeFormat string: Parsing format for the time field. If you use a specific time field in the log as the log timestamp, you must provide both TimeKey and TimeFormat. TimeKey and TimeFormat must be used together.
TimeKey string: Name of the log time field. If you want to use a specific time field in the log as the log timestamp, you need to specify both TimeKey and TimeFormat. TimeKey and TimeFormat must be provided together.
TimeSample string: Time sample. Used to check whether the entered time parsing format is correct.
TimeZone string: Time zone. Supports machine time zone (default) and custom time zone. Custom time zone supports GMT and UTC. GMT format: GMT+08:00. UTC format: Asia/Shanghai.
UnMatchLogKey string: Key name for unmatched logs.
UnMatchUpLoadSwitch bool: Switch for uploading unmatched logs.

beginRegex String: Regular expression that the first line of the log must match. Valid only when LogType is multilinelog or fullregexlog. Must be a valid regular expression.
delimiter String: Log delimiter. Valid only when LogType is delimiter_log.
enableNanosecond Boolean: Enable nanosecond precision time. When enabled, log time parsing will include and report nanosecond precision. true: Enable nanosecond precision time. false: Disable nanosecond precision time.
filterKeyRegexes List<RuleExtractRuleFilterKeyRegex>
keys List<String>: List of log field names (Key). This is only valid when LogType is delimiterlog or fullregexlog. You can configure up to 100 field names. When LogType is delimiterlog, field names must be unique and cannot all be empty. When LogType is fullregexlog, field names must be unique and cannot be empty.
logRegex String: The entire log must match the specified regular expression. This is only valid when the collected log type is fullregex_log. Must be a valid regular expression.
logTemplate RuleExtractRuleLogTemplate: Automatically extract log fields based on the specified log template
quote String: Quoting character. Content wrapped by a quoting character will not be split but parsed as a complete field. Only valid when LogType is delimiter_log.
timeExtractRegex String: Regular expression for extracting time, used to extract the time value from the TimeKey field and parse it as the collection time
timeFormat String: Parsing format for the time field. If you use a specific time field in the log as the log timestamp, you must provide both TimeKey and TimeFormat. TimeKey and TimeFormat must be used together.
timeKey String: Name of the log time field. If you want to use a specific time field in the log as the log timestamp, you need to specify both TimeKey and TimeFormat. TimeKey and TimeFormat must be provided together.
timeSample String: Time sample. Used to check whether the entered time parsing format is correct.
timeZone String: Time zone. Supports machine time zone (default) and custom time zone. Custom time zone supports GMT and UTC. GMT format: GMT+08:00. UTC format: Asia/Shanghai.
unMatchLogKey String: Key name for unmatched logs.
unMatchUpLoadSwitch Boolean: Switch for uploading unmatched logs.

beginRegex string: Regular expression that the first line of the log must match. Valid only when LogType is multilinelog or fullregexlog. Must be a valid regular expression.
delimiter string: Log delimiter. Valid only when LogType is delimiter_log.
enableNanosecond boolean: Enable nanosecond precision time. When enabled, log time parsing will include and report nanosecond precision. true: Enable nanosecond precision time. false: Disable nanosecond precision time.
filterKeyRegexes RuleExtractRuleFilterKeyRegex[]
keys string[]: List of log field names (Key). This is only valid when LogType is delimiterlog or fullregexlog. You can configure up to 100 field names. When LogType is delimiterlog, field names must be unique and cannot all be empty. When LogType is fullregexlog, field names must be unique and cannot be empty.
logRegex string: The entire log must match the specified regular expression. This is only valid when the collected log type is fullregex_log. Must be a valid regular expression.
logTemplate RuleExtractRuleLogTemplate: Automatically extract log fields based on the specified log template
quote string: Quoting character. Content wrapped by a quoting character will not be split but parsed as a complete field. Only valid when LogType is delimiter_log.
timeExtractRegex string: Regular expression for extracting time, used to extract the time value from the TimeKey field and parse it as the collection time
timeFormat string: Parsing format for the time field. If you use a specific time field in the log as the log timestamp, you must provide both TimeKey and TimeFormat. TimeKey and TimeFormat must be used together.
timeKey string: Name of the log time field. If you want to use a specific time field in the log as the log timestamp, you need to specify both TimeKey and TimeFormat. TimeKey and TimeFormat must be provided together.
timeSample string: Time sample. Used to check whether the entered time parsing format is correct.
timeZone string: Time zone. Supports machine time zone (default) and custom time zone. Custom time zone supports GMT and UTC. GMT format: GMT+08:00. UTC format: Asia/Shanghai.
unMatchLogKey string: Key name for unmatched logs.
unMatchUpLoadSwitch boolean: Switch for uploading unmatched logs.

begin_regex str: Regular expression that the first line of the log must match. Valid only when LogType is multilinelog or fullregexlog. Must be a valid regular expression.
delimiter str: Log delimiter. Valid only when LogType is delimiter_log.
enable_nanosecond bool: Enable nanosecond precision time. When enabled, log time parsing will include and report nanosecond precision. true: Enable nanosecond precision time. false: Disable nanosecond precision time.
filter_key_regexes Sequence[RuleExtractRuleFilterKeyRegex]
keys Sequence[str]: List of log field names (Key). This is only valid when LogType is delimiterlog or fullregexlog. You can configure up to 100 field names. When LogType is delimiterlog, field names must be unique and cannot all be empty. When LogType is fullregexlog, field names must be unique and cannot be empty.
log_regex str: The entire log must match the specified regular expression. This is only valid when the collected log type is fullregex_log. Must be a valid regular expression.
log_template RuleExtractRuleLogTemplate: Automatically extract log fields based on the specified log template
quote str: Quoting character. Content wrapped by a quoting character will not be split but parsed as a complete field. Only valid when LogType is delimiter_log.
time_extract_regex str: Regular expression for extracting time, used to extract the time value from the TimeKey field and parse it as the collection time
time_format str: Parsing format for the time field. If you use a specific time field in the log as the log timestamp, you must provide both TimeKey and TimeFormat. TimeKey and TimeFormat must be used together.
time_key str: Name of the log time field. If you want to use a specific time field in the log as the log timestamp, you need to specify both TimeKey and TimeFormat. TimeKey and TimeFormat must be provided together.
time_sample str: Time sample. Used to check whether the entered time parsing format is correct.
time_zone str: Time zone. Supports machine time zone (default) and custom time zone. Custom time zone supports GMT and UTC. GMT format: GMT+08:00. UTC format: Asia/Shanghai.
un_match_log_key str: Key name for unmatched logs.
un_match_up_load_switch bool: Switch for uploading unmatched logs.

beginRegex String: Regular expression that the first line of the log must match. Valid only when LogType is multilinelog or fullregexlog. Must be a valid regular expression.
delimiter String: Log delimiter. Valid only when LogType is delimiter_log.
enableNanosecond Boolean: Enable nanosecond precision time. When enabled, log time parsing will include and report nanosecond precision. true: Enable nanosecond precision time. false: Disable nanosecond precision time.
filterKeyRegexes List<Property Map>
keys List<String>: List of log field names (Key). This is only valid when LogType is delimiterlog or fullregexlog. You can configure up to 100 field names. When LogType is delimiterlog, field names must be unique and cannot all be empty. When LogType is fullregexlog, field names must be unique and cannot be empty.
logRegex String: The entire log must match the specified regular expression. This is only valid when the collected log type is fullregex_log. Must be a valid regular expression.
logTemplate Property Map: Automatically extract log fields based on the specified log template
quote String: Quoting character. Content wrapped by a quoting character will not be split but parsed as a complete field. Only valid when LogType is delimiter_log.
timeExtractRegex String: Regular expression for extracting time, used to extract the time value from the TimeKey field and parse it as the collection time
timeFormat String: Parsing format for the time field. If you use a specific time field in the log as the log timestamp, you must provide both TimeKey and TimeFormat. TimeKey and TimeFormat must be used together.
timeKey String: Name of the log time field. If you want to use a specific time field in the log as the log timestamp, you need to specify both TimeKey and TimeFormat. TimeKey and TimeFormat must be provided together.
timeSample String: Time sample. Used to check whether the entered time parsing format is correct.
timeZone String: Time zone. Supports machine time zone (default) and custom time zone. Custom time zone supports GMT and UTC. GMT format: GMT+08:00. UTC format: Asia/Shanghai.
unMatchLogKey String: Key name for unmatched logs.
unMatchUpLoadSwitch Boolean: Switch for uploading unmatched logs.

RuleExtractRuleFilterKeyRegex, RuleExtractRuleFilterKeyRegexArgs

Key string: Name of the filter field.
Regex string: The log content of the filter field must match the specified regular expression.

Key string: Name of the filter field.
Regex string: The log content of the filter field must match the specified regular expression.

key String: Name of the filter field.
regex String: The log content of the filter field must match the specified regular expression.

key string: Name of the filter field.
regex string: The log content of the filter field must match the specified regular expression.

key str: Name of the filter field.
regex str: The log content of the filter field must match the specified regular expression.

key String: Name of the filter field.
regex String: The log content of the filter field must match the specified regular expression.

RuleExtractRuleLogTemplate, RuleExtractRuleLogTemplateArgs

Format string: Log template format.
Type string: Log template types. Supported types: Nginx: Nginx log template.

Format string: Log template format.
Type string: Log template types. Supported types: Nginx: Nginx log template.

format String: Log template format.
type String: Log template types. Supported types: Nginx: Nginx log template.

format string: Log template format.
type string: Log template types. Supported types: Nginx: Nginx log template.

format str: Log template format.
type str: Log template types. Supported types: Nginx: Nginx log template.

format String: Log template format.
type String: Log template types. Supported types: Nginx: Nginx log template.

RuleHostGroupInfo, RuleHostGroupInfoArgs

HostGroupId string: Machine group ID

HostGroupId string: Machine group ID

hostGroupId String: Machine group ID

hostGroupId string: Machine group ID

host_group_id str: Machine group ID

hostGroupId String: Machine group ID

RuleUserDefineRule, RuleUserDefineRuleArgs

Advanced Volcengine.RuleUserDefineRuleAdvanced: The Advanced parameter is used for extended configuration. After enabling extended configuration, you can customize advanced behaviors of LogCollector, such as when to release file handles. Note: If multiple release conditions are specified, the handle is released and log file monitoring ends as soon as any condition is met.
EnableHostGroupLabel bool: Whether to upload the label information of the host group to the log service. The default is off. true: LogCollector uploads the label information of the host group to the specified field. You can specify the field name in the HostGroupLabelKey parameter. false (default): Host group label information is not uploaded.
EnableHostname bool: Upload the hostname field. Default is disabled. true: Add a field to the original log to record the source hostname. Specify the hostname field name using HostnameKey. false: (default) Do not add the hostname field.
EnableRawLog bool: Upload raw logs. true: Upload raw logs. false (default): Do not upload raw logs.
Fields List<Volcengine.RuleUserDefineRuleField>
HostGroupLabelKey string: Field name used to store machine group label information
HostnameKey string: Hostname field name. Required only when EnableHostname is true.
IgnoreOlder int: Ignore log files that have not been updated for a specified period (in hours).
MultiCollectsType string: Allow multiple log file collections. Empty: Use log file ID (including file inode, device, and checksum of the first N bytes) to uniquely identify the log file. RuleID: Use collection rule ID and log file ID to uniquely identify the log file. TopicIDRuleName: Use log topic ID, collection rule name, and log file ID to uniquely identify the log file.
ParsePathRule Volcengine.RuleUserDefineRuleParsePathRule: Rule for parsing the collection path. After setting the rule, fields in the collection path are extracted using the specified regular expression and added as metadata to the log data. Note: This parameter is not supported when collecting container standard output.
Plugin Volcengine.RuleUserDefineRulePlugin: LogCollector plugin configuration. After enabling plugin configuration, you can add one or more LogCollector processor plugins to parse logs with complex or variable structures.
RawLogKey string: Name of the raw log field. Only effective when EnableRawLog is set to true. RawLogKey defaults to raw, meaning the original log data will be encapsulated in the raw field and uploaded to the log service along with the parsed log data.
ShardHashKey Volcengine.RuleUserDefineRuleShardHashKey: Rules for routing log partitions. If this parameter is not set, logs are written using the default load balancing mode, and packets are written to any available Shard. If this parameter is set, logs are collected using the HashKey routing Shard mode, and the log service writes data to the Shard containing the specified Key value
TailFiles bool: LogCollector collection policy, which specifies whether LogCollector collects incremental logs or full logs. Default is false, meaning full log collection. true: incremental collection. LogCollector only collects newly added content in the file. When new logs are written to monitored log files, LogCollector triggers log collection. For first-time collection, LogCollector automatically determines the collection position based on the incremental threshold TailSizeKb you specify. If the new file size does not exceed the incremental threshold, collection starts from the beginning of the file. If the new file size exceeds the incremental threshold, collection starts from the position at the end of the file minus the incremental threshold, collecting only incremental logs. For subsequent collections, LogCollector determines the collection position based on Checkpoint and continues collecting. false: (default) full collection. LogCollector collects logs from the beginning of each file, including historical log data.
TailSizeKb int: Backtracking threshold for incremental collection, in KiB. When LogCollector uses incremental collection, for the first collection of a log file: If the new log file size does not exceed the TailSizeKb value, collection starts from the beginning of the file. If the new log file size exceeds the TailSizeKb value, collection starts from the position that is TailSizeKb from the end of the file.

Advanced RuleUserDefineRuleAdvanced: The Advanced parameter is used for extended configuration. After enabling extended configuration, you can customize advanced behaviors of LogCollector, such as when to release file handles. Note: If multiple release conditions are specified, the handle is released and log file monitoring ends as soon as any condition is met.
EnableHostGroupLabel bool: Whether to upload the label information of the host group to the log service. The default is off. true: LogCollector uploads the label information of the host group to the specified field. You can specify the field name in the HostGroupLabelKey parameter. false (default): Host group label information is not uploaded.
EnableHostname bool: Upload the hostname field. Default is disabled. true: Add a field to the original log to record the source hostname. Specify the hostname field name using HostnameKey. false: (default) Do not add the hostname field.
EnableRawLog bool: Upload raw logs. true: Upload raw logs. false (default): Do not upload raw logs.
Fields []RuleUserDefineRuleField
HostGroupLabelKey string: Field name used to store machine group label information
HostnameKey string: Hostname field name. Required only when EnableHostname is true.
IgnoreOlder int: Ignore log files that have not been updated for a specified period (in hours).
MultiCollectsType string: Allow multiple log file collections. Empty: Use log file ID (including file inode, device, and checksum of the first N bytes) to uniquely identify the log file. RuleID: Use collection rule ID and log file ID to uniquely identify the log file. TopicIDRuleName: Use log topic ID, collection rule name, and log file ID to uniquely identify the log file.
ParsePathRule RuleUserDefineRuleParsePathRule: Rule for parsing the collection path. After setting the rule, fields in the collection path are extracted using the specified regular expression and added as metadata to the log data. Note: This parameter is not supported when collecting container standard output.
Plugin RuleUserDefineRulePlugin: LogCollector plugin configuration. After enabling plugin configuration, you can add one or more LogCollector processor plugins to parse logs with complex or variable structures.
RawLogKey string: Name of the raw log field. Only effective when EnableRawLog is set to true. RawLogKey defaults to raw, meaning the original log data will be encapsulated in the raw field and uploaded to the log service along with the parsed log data.
ShardHashKey RuleUserDefineRuleShardHashKey: Rules for routing log partitions. If this parameter is not set, logs are written using the default load balancing mode, and packets are written to any available Shard. If this parameter is set, logs are collected using the HashKey routing Shard mode, and the log service writes data to the Shard containing the specified Key value
TailFiles bool: LogCollector collection policy, which specifies whether LogCollector collects incremental logs or full logs. Default is false, meaning full log collection. true: incremental collection. LogCollector only collects newly added content in the file. When new logs are written to monitored log files, LogCollector triggers log collection. For first-time collection, LogCollector automatically determines the collection position based on the incremental threshold TailSizeKb you specify. If the new file size does not exceed the incremental threshold, collection starts from the beginning of the file. If the new file size exceeds the incremental threshold, collection starts from the position at the end of the file minus the incremental threshold, collecting only incremental logs. For subsequent collections, LogCollector determines the collection position based on Checkpoint and continues collecting. false: (default) full collection. LogCollector collects logs from the beginning of each file, including historical log data.
TailSizeKb int: Backtracking threshold for incremental collection, in KiB. When LogCollector uses incremental collection, for the first collection of a log file: If the new log file size does not exceed the TailSizeKb value, collection starts from the beginning of the file. If the new log file size exceeds the TailSizeKb value, collection starts from the position that is TailSizeKb from the end of the file.

advanced RuleUserDefineRuleAdvanced: The Advanced parameter is used for extended configuration. After enabling extended configuration, you can customize advanced behaviors of LogCollector, such as when to release file handles. Note: If multiple release conditions are specified, the handle is released and log file monitoring ends as soon as any condition is met.
enableHostGroupLabel Boolean: Whether to upload the label information of the host group to the log service. The default is off. true: LogCollector uploads the label information of the host group to the specified field. You can specify the field name in the HostGroupLabelKey parameter. false (default): Host group label information is not uploaded.
enableHostname Boolean: Upload the hostname field. Default is disabled. true: Add a field to the original log to record the source hostname. Specify the hostname field name using HostnameKey. false: (default) Do not add the hostname field.
enableRawLog Boolean: Upload raw logs. true: Upload raw logs. false (default): Do not upload raw logs.
fields List<RuleUserDefineRuleField>
hostGroupLabelKey String: Field name used to store machine group label information
hostnameKey String: Hostname field name. Required only when EnableHostname is true.
ignoreOlder Integer: Ignore log files that have not been updated for a specified period (in hours).
multiCollectsType String: Allow multiple log file collections. Empty: Use log file ID (including file inode, device, and checksum of the first N bytes) to uniquely identify the log file. RuleID: Use collection rule ID and log file ID to uniquely identify the log file. TopicIDRuleName: Use log topic ID, collection rule name, and log file ID to uniquely identify the log file.
parsePathRule RuleUserDefineRuleParsePathRule: Rule for parsing the collection path. After setting the rule, fields in the collection path are extracted using the specified regular expression and added as metadata to the log data. Note: This parameter is not supported when collecting container standard output.
plugin RuleUserDefineRulePlugin: LogCollector plugin configuration. After enabling plugin configuration, you can add one or more LogCollector processor plugins to parse logs with complex or variable structures.
rawLogKey String: Name of the raw log field. Only effective when EnableRawLog is set to true. RawLogKey defaults to raw, meaning the original log data will be encapsulated in the raw field and uploaded to the log service along with the parsed log data.
shardHashKey RuleUserDefineRuleShardHashKey: Rules for routing log partitions. If this parameter is not set, logs are written using the default load balancing mode, and packets are written to any available Shard. If this parameter is set, logs are collected using the HashKey routing Shard mode, and the log service writes data to the Shard containing the specified Key value
tailFiles Boolean: LogCollector collection policy, which specifies whether LogCollector collects incremental logs or full logs. Default is false, meaning full log collection. true: incremental collection. LogCollector only collects newly added content in the file. When new logs are written to monitored log files, LogCollector triggers log collection. For first-time collection, LogCollector automatically determines the collection position based on the incremental threshold TailSizeKb you specify. If the new file size does not exceed the incremental threshold, collection starts from the beginning of the file. If the new file size exceeds the incremental threshold, collection starts from the position at the end of the file minus the incremental threshold, collecting only incremental logs. For subsequent collections, LogCollector determines the collection position based on Checkpoint and continues collecting. false: (default) full collection. LogCollector collects logs from the beginning of each file, including historical log data.
tailSizeKb Integer: Backtracking threshold for incremental collection, in KiB. When LogCollector uses incremental collection, for the first collection of a log file: If the new log file size does not exceed the TailSizeKb value, collection starts from the beginning of the file. If the new log file size exceeds the TailSizeKb value, collection starts from the position that is TailSizeKb from the end of the file.

advanced RuleUserDefineRuleAdvanced: The Advanced parameter is used for extended configuration. After enabling extended configuration, you can customize advanced behaviors of LogCollector, such as when to release file handles. Note: If multiple release conditions are specified, the handle is released and log file monitoring ends as soon as any condition is met.
enableHostGroupLabel boolean: Whether to upload the label information of the host group to the log service. The default is off. true: LogCollector uploads the label information of the host group to the specified field. You can specify the field name in the HostGroupLabelKey parameter. false (default): Host group label information is not uploaded.
enableHostname boolean: Upload the hostname field. Default is disabled. true: Add a field to the original log to record the source hostname. Specify the hostname field name using HostnameKey. false: (default) Do not add the hostname field.
enableRawLog boolean: Upload raw logs. true: Upload raw logs. false (default): Do not upload raw logs.
fields RuleUserDefineRuleField[]
hostGroupLabelKey string: Field name used to store machine group label information
hostnameKey string: Hostname field name. Required only when EnableHostname is true.
ignoreOlder number: Ignore log files that have not been updated for a specified period (in hours).
multiCollectsType string: Allow multiple log file collections. Empty: Use log file ID (including file inode, device, and checksum of the first N bytes) to uniquely identify the log file. RuleID: Use collection rule ID and log file ID to uniquely identify the log file. TopicIDRuleName: Use log topic ID, collection rule name, and log file ID to uniquely identify the log file.
parsePathRule RuleUserDefineRuleParsePathRule: Rule for parsing the collection path. After setting the rule, fields in the collection path are extracted using the specified regular expression and added as metadata to the log data. Note: This parameter is not supported when collecting container standard output.
plugin RuleUserDefineRulePlugin: LogCollector plugin configuration. After enabling plugin configuration, you can add one or more LogCollector processor plugins to parse logs with complex or variable structures.
rawLogKey string: Name of the raw log field. Only effective when EnableRawLog is set to true. RawLogKey defaults to raw, meaning the original log data will be encapsulated in the raw field and uploaded to the log service along with the parsed log data.
shardHashKey RuleUserDefineRuleShardHashKey: Rules for routing log partitions. If this parameter is not set, logs are written using the default load balancing mode, and packets are written to any available Shard. If this parameter is set, logs are collected using the HashKey routing Shard mode, and the log service writes data to the Shard containing the specified Key value
tailFiles boolean: LogCollector collection policy, which specifies whether LogCollector collects incremental logs or full logs. Default is false, meaning full log collection. true: incremental collection. LogCollector only collects newly added content in the file. When new logs are written to monitored log files, LogCollector triggers log collection. For first-time collection, LogCollector automatically determines the collection position based on the incremental threshold TailSizeKb you specify. If the new file size does not exceed the incremental threshold, collection starts from the beginning of the file. If the new file size exceeds the incremental threshold, collection starts from the position at the end of the file minus the incremental threshold, collecting only incremental logs. For subsequent collections, LogCollector determines the collection position based on Checkpoint and continues collecting. false: (default) full collection. LogCollector collects logs from the beginning of each file, including historical log data.
tailSizeKb number: Backtracking threshold for incremental collection, in KiB. When LogCollector uses incremental collection, for the first collection of a log file: If the new log file size does not exceed the TailSizeKb value, collection starts from the beginning of the file. If the new log file size exceeds the TailSizeKb value, collection starts from the position that is TailSizeKb from the end of the file.

advanced RuleUserDefineRuleAdvanced: The Advanced parameter is used for extended configuration. After enabling extended configuration, you can customize advanced behaviors of LogCollector, such as when to release file handles. Note: If multiple release conditions are specified, the handle is released and log file monitoring ends as soon as any condition is met.
enable_host_group_label bool: Whether to upload the label information of the host group to the log service. The default is off. true: LogCollector uploads the label information of the host group to the specified field. You can specify the field name in the HostGroupLabelKey parameter. false (default): Host group label information is not uploaded.
enable_hostname bool: Upload the hostname field. Default is disabled. true: Add a field to the original log to record the source hostname. Specify the hostname field name using HostnameKey. false: (default) Do not add the hostname field.
enable_raw_log bool: Upload raw logs. true: Upload raw logs. false (default): Do not upload raw logs.
fields Sequence[RuleUserDefineRuleField]
host_group_label_key str: Field name used to store machine group label information
hostname_key str: Hostname field name. Required only when EnableHostname is true.
ignore_older int: Ignore log files that have not been updated for a specified period (in hours).
multi_collects_type str: Allow multiple log file collections. Empty: Use log file ID (including file inode, device, and checksum of the first N bytes) to uniquely identify the log file. RuleID: Use collection rule ID and log file ID to uniquely identify the log file. TopicIDRuleName: Use log topic ID, collection rule name, and log file ID to uniquely identify the log file.
parse_path_rule RuleUserDefineRuleParsePathRule: Rule for parsing the collection path. After setting the rule, fields in the collection path are extracted using the specified regular expression and added as metadata to the log data. Note: This parameter is not supported when collecting container standard output.
plugin RuleUserDefineRulePlugin: LogCollector plugin configuration. After enabling plugin configuration, you can add one or more LogCollector processor plugins to parse logs with complex or variable structures.
raw_log_key str: Name of the raw log field. Only effective when EnableRawLog is set to true. RawLogKey defaults to raw, meaning the original log data will be encapsulated in the raw field and uploaded to the log service along with the parsed log data.
shard_hash_key RuleUserDefineRuleShardHashKey: Rules for routing log partitions. If this parameter is not set, logs are written using the default load balancing mode, and packets are written to any available Shard. If this parameter is set, logs are collected using the HashKey routing Shard mode, and the log service writes data to the Shard containing the specified Key value
tail_files bool: LogCollector collection policy, which specifies whether LogCollector collects incremental logs or full logs. Default is false, meaning full log collection. true: incremental collection. LogCollector only collects newly added content in the file. When new logs are written to monitored log files, LogCollector triggers log collection. For first-time collection, LogCollector automatically determines the collection position based on the incremental threshold TailSizeKb you specify. If the new file size does not exceed the incremental threshold, collection starts from the beginning of the file. If the new file size exceeds the incremental threshold, collection starts from the position at the end of the file minus the incremental threshold, collecting only incremental logs. For subsequent collections, LogCollector determines the collection position based on Checkpoint and continues collecting. false: (default) full collection. LogCollector collects logs from the beginning of each file, including historical log data.
tail_size_kb int: Backtracking threshold for incremental collection, in KiB. When LogCollector uses incremental collection, for the first collection of a log file: If the new log file size does not exceed the TailSizeKb value, collection starts from the beginning of the file. If the new log file size exceeds the TailSizeKb value, collection starts from the position that is TailSizeKb from the end of the file.

advanced Property Map: The Advanced parameter is used for extended configuration. After enabling extended configuration, you can customize advanced behaviors of LogCollector, such as when to release file handles. Note: If multiple release conditions are specified, the handle is released and log file monitoring ends as soon as any condition is met.
enableHostGroupLabel Boolean: Whether to upload the label information of the host group to the log service. The default is off. true: LogCollector uploads the label information of the host group to the specified field. You can specify the field name in the HostGroupLabelKey parameter. false (default): Host group label information is not uploaded.
enableHostname Boolean: Upload the hostname field. Default is disabled. true: Add a field to the original log to record the source hostname. Specify the hostname field name using HostnameKey. false: (default) Do not add the hostname field.
enableRawLog Boolean: Upload raw logs. true: Upload raw logs. false (default): Do not upload raw logs.
fields List<Property Map>
hostGroupLabelKey String: Field name used to store machine group label information
hostnameKey String: Hostname field name. Required only when EnableHostname is true.
ignoreOlder Number: Ignore log files that have not been updated for a specified period (in hours).
multiCollectsType String: Allow multiple log file collections. Empty: Use log file ID (including file inode, device, and checksum of the first N bytes) to uniquely identify the log file. RuleID: Use collection rule ID and log file ID to uniquely identify the log file. TopicIDRuleName: Use log topic ID, collection rule name, and log file ID to uniquely identify the log file.
parsePathRule Property Map: Rule for parsing the collection path. After setting the rule, fields in the collection path are extracted using the specified regular expression and added as metadata to the log data. Note: This parameter is not supported when collecting container standard output.
plugin Property Map: LogCollector plugin configuration. After enabling plugin configuration, you can add one or more LogCollector processor plugins to parse logs with complex or variable structures.
rawLogKey String: Name of the raw log field. Only effective when EnableRawLog is set to true. RawLogKey defaults to raw, meaning the original log data will be encapsulated in the raw field and uploaded to the log service along with the parsed log data.
shardHashKey Property Map: Rules for routing log partitions. If this parameter is not set, logs are written using the default load balancing mode, and packets are written to any available Shard. If this parameter is set, logs are collected using the HashKey routing Shard mode, and the log service writes data to the Shard containing the specified Key value
tailFiles Boolean: LogCollector collection policy, which specifies whether LogCollector collects incremental logs or full logs. Default is false, meaning full log collection. true: incremental collection. LogCollector only collects newly added content in the file. When new logs are written to monitored log files, LogCollector triggers log collection. For first-time collection, LogCollector automatically determines the collection position based on the incremental threshold TailSizeKb you specify. If the new file size does not exceed the incremental threshold, collection starts from the beginning of the file. If the new file size exceeds the incremental threshold, collection starts from the position at the end of the file minus the incremental threshold, collecting only incremental logs. For subsequent collections, LogCollector determines the collection position based on Checkpoint and continues collecting. false: (default) full collection. LogCollector collects logs from the beginning of each file, including historical log data.
tailSizeKb Number: Backtracking threshold for incremental collection, in KiB. When LogCollector uses incremental collection, for the first collection of a log file: If the new log file size does not exceed the TailSizeKb value, collection starts from the beginning of the file. If the new log file size exceeds the TailSizeKb value, collection starts from the position that is TailSizeKb from the end of the file.

RuleUserDefineRuleAdvanced, RuleUserDefineRuleAdvancedArgs

CloseEof bool: After reading to the end of the log file, choose whether to release the file handle. Default is false.
CloseInactive int: Wait time to release log file handle. If no new logs are written to the log file within the specified time, the handle for that log file is released. Unit: seconds. Range: 1–300 seconds. Default: 60 seconds.
CloseRemoved bool: Release the file handle after the log file is removed. Default is false.
CloseRenamed bool: Release the file handle after the log file is renamed. Default is false.
CloseTimeout int: Maximum monitoring duration for LogCollector log files, in seconds. The default is 0 seconds, meaning LogCollector does not limit the monitoring duration for log files. Timing starts when LogCollector begins monitoring the log file. Once the specified duration is exceeded, LogCollector immediately releases the file handle and stops monitoring, regardless of whether the log file has been fully read.
NoLineTerminatorEofMaxTime int: Maximum wait time when LogCollector does not detect a line break, in seconds. The default is 5s. Timing starts when LogCollector begins reading the log file. If no line break is detected within the specified time, LogCollector sends the logs in the buffer. If the file write interval is long, a complete log entry may be split into two parts and written separately. Adjust this parameter based on your log write interval.

CloseEof bool: After reading to the end of the log file, choose whether to release the file handle. Default is false.
CloseInactive int: Wait time to release log file handle. If no new logs are written to the log file within the specified time, the handle for that log file is released. Unit: seconds. Range: 1–300 seconds. Default: 60 seconds.
CloseRemoved bool: Release the file handle after the log file is removed. Default is false.
CloseRenamed bool: Release the file handle after the log file is renamed. Default is false.
CloseTimeout int: Maximum monitoring duration for LogCollector log files, in seconds. The default is 0 seconds, meaning LogCollector does not limit the monitoring duration for log files. Timing starts when LogCollector begins monitoring the log file. Once the specified duration is exceeded, LogCollector immediately releases the file handle and stops monitoring, regardless of whether the log file has been fully read.
NoLineTerminatorEofMaxTime int: Maximum wait time when LogCollector does not detect a line break, in seconds. The default is 5s. Timing starts when LogCollector begins reading the log file. If no line break is detected within the specified time, LogCollector sends the logs in the buffer. If the file write interval is long, a complete log entry may be split into two parts and written separately. Adjust this parameter based on your log write interval.

closeEof Boolean: After reading to the end of the log file, choose whether to release the file handle. Default is false.
closeInactive Integer: Wait time to release log file handle. If no new logs are written to the log file within the specified time, the handle for that log file is released. Unit: seconds. Range: 1–300 seconds. Default: 60 seconds.
closeRemoved Boolean: Release the file handle after the log file is removed. Default is false.
closeRenamed Boolean: Release the file handle after the log file is renamed. Default is false.
closeTimeout Integer: Maximum monitoring duration for LogCollector log files, in seconds. The default is 0 seconds, meaning LogCollector does not limit the monitoring duration for log files. Timing starts when LogCollector begins monitoring the log file. Once the specified duration is exceeded, LogCollector immediately releases the file handle and stops monitoring, regardless of whether the log file has been fully read.
noLineTerminatorEofMaxTime Integer: Maximum wait time when LogCollector does not detect a line break, in seconds. The default is 5s. Timing starts when LogCollector begins reading the log file. If no line break is detected within the specified time, LogCollector sends the logs in the buffer. If the file write interval is long, a complete log entry may be split into two parts and written separately. Adjust this parameter based on your log write interval.

closeEof boolean: After reading to the end of the log file, choose whether to release the file handle. Default is false.
closeInactive number: Wait time to release log file handle. If no new logs are written to the log file within the specified time, the handle for that log file is released. Unit: seconds. Range: 1–300 seconds. Default: 60 seconds.
closeRemoved boolean: Release the file handle after the log file is removed. Default is false.
closeRenamed boolean: Release the file handle after the log file is renamed. Default is false.
closeTimeout number: Maximum monitoring duration for LogCollector log files, in seconds. The default is 0 seconds, meaning LogCollector does not limit the monitoring duration for log files. Timing starts when LogCollector begins monitoring the log file. Once the specified duration is exceeded, LogCollector immediately releases the file handle and stops monitoring, regardless of whether the log file has been fully read.
noLineTerminatorEofMaxTime number: Maximum wait time when LogCollector does not detect a line break, in seconds. The default is 5s. Timing starts when LogCollector begins reading the log file. If no line break is detected within the specified time, LogCollector sends the logs in the buffer. If the file write interval is long, a complete log entry may be split into two parts and written separately. Adjust this parameter based on your log write interval.

close_eof bool: After reading to the end of the log file, choose whether to release the file handle. Default is false.
close_inactive int: Wait time to release log file handle. If no new logs are written to the log file within the specified time, the handle for that log file is released. Unit: seconds. Range: 1–300 seconds. Default: 60 seconds.
close_removed bool: Release the file handle after the log file is removed. Default is false.
close_renamed bool: Release the file handle after the log file is renamed. Default is false.
close_timeout int: Maximum monitoring duration for LogCollector log files, in seconds. The default is 0 seconds, meaning LogCollector does not limit the monitoring duration for log files. Timing starts when LogCollector begins monitoring the log file. Once the specified duration is exceeded, LogCollector immediately releases the file handle and stops monitoring, regardless of whether the log file has been fully read.
no_line_terminator_eof_max_time int: Maximum wait time when LogCollector does not detect a line break, in seconds. The default is 5s. Timing starts when LogCollector begins reading the log file. If no line break is detected within the specified time, LogCollector sends the logs in the buffer. If the file write interval is long, a complete log entry may be split into two parts and written separately. Adjust this parameter based on your log write interval.

closeEof Boolean: After reading to the end of the log file, choose whether to release the file handle. Default is false.
closeInactive Number: Wait time to release log file handle. If no new logs are written to the log file within the specified time, the handle for that log file is released. Unit: seconds. Range: 1–300 seconds. Default: 60 seconds.
closeRemoved Boolean: Release the file handle after the log file is removed. Default is false.
closeRenamed Boolean: Release the file handle after the log file is renamed. Default is false.
closeTimeout Number: Maximum monitoring duration for LogCollector log files, in seconds. The default is 0 seconds, meaning LogCollector does not limit the monitoring duration for log files. Timing starts when LogCollector begins monitoring the log file. Once the specified duration is exceeded, LogCollector immediately releases the file handle and stops monitoring, regardless of whether the log file has been fully read.
noLineTerminatorEofMaxTime Number: Maximum wait time when LogCollector does not detect a line break, in seconds. The default is 5s. Timing starts when LogCollector begins reading the log file. If no line break is detected within the specified time, LogCollector sends the logs in the buffer. If the file write interval is long, a complete log entry may be split into two parts and written separately. Adjust this parameter based on your log write interval.

RuleUserDefineRuleField, RuleUserDefineRuleFieldArgs

Key string: Key.
Val string: Value.

Key string: Key.
Val string: Value.

key String: Key.
val String: Value.

key string: Key.
val string: Value.

key str: Key.
val str: Value.

key String: Key.
val String: Value.

RuleUserDefineRuleParsePathRule, RuleUserDefineRuleParsePathRuleArgs

Keys List<string>: Field name list. The log service uses a regular expression (Regex) to parse the path sample (PathSample) into multiple fields. Keys specify the name of each field. You can configure up to 100 field names. Field names cannot be empty or duplicated.
PathSample string: Sample collection path for actual scenarios. The sample collection path must be an absolute path. Wildcards *, ?, ** are not allowed in the path sample.
Regex string: Regular expression used to extract the path field. Must match the sample collection path, otherwise extraction will fail

Keys []string: Field name list. The log service uses a regular expression (Regex) to parse the path sample (PathSample) into multiple fields. Keys specify the name of each field. You can configure up to 100 field names. Field names cannot be empty or duplicated.
PathSample string: Sample collection path for actual scenarios. The sample collection path must be an absolute path. Wildcards *, ?, ** are not allowed in the path sample.
Regex string: Regular expression used to extract the path field. Must match the sample collection path, otherwise extraction will fail

keys List<String>: Field name list. The log service uses a regular expression (Regex) to parse the path sample (PathSample) into multiple fields. Keys specify the name of each field. You can configure up to 100 field names. Field names cannot be empty or duplicated.
pathSample String: Sample collection path for actual scenarios. The sample collection path must be an absolute path. Wildcards *, ?, ** are not allowed in the path sample.
regex String: Regular expression used to extract the path field. Must match the sample collection path, otherwise extraction will fail

keys string[]: Field name list. The log service uses a regular expression (Regex) to parse the path sample (PathSample) into multiple fields. Keys specify the name of each field. You can configure up to 100 field names. Field names cannot be empty or duplicated.
pathSample string: Sample collection path for actual scenarios. The sample collection path must be an absolute path. Wildcards *, ?, ** are not allowed in the path sample.
regex string: Regular expression used to extract the path field. Must match the sample collection path, otherwise extraction will fail

keys Sequence[str]: Field name list. The log service uses a regular expression (Regex) to parse the path sample (PathSample) into multiple fields. Keys specify the name of each field. You can configure up to 100 field names. Field names cannot be empty or duplicated.
path_sample str: Sample collection path for actual scenarios. The sample collection path must be an absolute path. Wildcards *, ?, ** are not allowed in the path sample.
regex str: Regular expression used to extract the path field. Must match the sample collection path, otherwise extraction will fail

keys List<String>: Field name list. The log service uses a regular expression (Regex) to parse the path sample (PathSample) into multiple fields. Keys specify the name of each field. You can configure up to 100 field names. Field names cannot be empty or duplicated.
pathSample String: Sample collection path for actual scenarios. The sample collection path must be an absolute path. Wildcards *, ?, ** are not allowed in the path sample.
regex String: Regular expression used to extract the path field. Must match the sample collection path, otherwise extraction will fail

RuleUserDefineRulePlugin, RuleUserDefineRulePluginArgs

Processors string: LogCollector plugin. For the list of supported plugins and parameter descriptions, see LogCollector plugin overview.

Processors string: LogCollector plugin. For the list of supported plugins and parameter descriptions, see LogCollector plugin overview.

processors String: LogCollector plugin. For the list of supported plugins and parameter descriptions, see LogCollector plugin overview.

processors string: LogCollector plugin. For the list of supported plugins and parameter descriptions, see LogCollector plugin overview.

processors str: LogCollector plugin. For the list of supported plugins and parameter descriptions, see LogCollector plugin overview.

processors String: LogCollector plugin. For the list of supported plugins and parameter descriptions, see LogCollector plugin overview.

RuleUserDefineRuleShardHashKey, RuleUserDefineRuleShardHashKeyArgs

HashKey string: HashKey of the log group, used to specify the shard to which the current log group will be written. The value range for this parameter is [00000000000000000000000000000000-ffffffffffffffffffffffffffffffff).

HashKey string: HashKey of the log group, used to specify the shard to which the current log group will be written. The value range for this parameter is [00000000000000000000000000000000-ffffffffffffffffffffffffffffffff).

hashKey String: HashKey of the log group, used to specify the shard to which the current log group will be written. The value range for this parameter is [00000000000000000000000000000000-ffffffffffffffffffffffffffffffff).

hashKey string: HashKey of the log group, used to specify the shard to which the current log group will be written. The value range for this parameter is [00000000000000000000000000000000-ffffffffffffffffffffffffffffffff).

hash_key str: HashKey of the log group, used to specify the shard to which the current log group will be written. The value range for this parameter is [00000000000000000000000000000000-ffffffffffffffffffffffffffffffff).

hashKey String: HashKey of the log group, used to specify the shard to which the current log group will be written. The value range for this parameter is [00000000000000000000000000000000-ffffffffffffffffffffffffffffffff).

Import

$ pulumi import volcenginecc:tls/rule:Rule example "rule_id"

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: volcenginecc volcengine/pulumi-volcenginecc
License: MPL-2.0
Notes: This Pulumi package is based on the volcenginecc Terraform Provider.

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

On this page

On this page

Example Usage

Create Rule Resource

Constructor syntax

Parameters

Rule Resource Properties

Inputs

Outputs

Look up Existing Rule Resource

Supporting Types

RuleContainerRule, RuleContainerRuleArgs

RuleContainerRuleEnvTag, RuleContainerRuleEnvTagArgs

RuleContainerRuleExcludeContainerEnvRegex, RuleContainerRuleExcludeContainerEnvRegexArgs

RuleContainerRuleExcludeContainerLabelRegex, RuleContainerRuleExcludeContainerLabelRegexArgs

RuleContainerRuleIncludeContainerEnvRegex, RuleContainerRuleIncludeContainerEnvRegexArgs

RuleContainerRuleIncludeContainerLabelRegex, RuleContainerRuleIncludeContainerLabelRegexArgs

RuleContainerRuleKubernetesRule, RuleContainerRuleKubernetesRuleArgs

RuleContainerRuleKubernetesRuleAnnotationTag, RuleContainerRuleKubernetesRuleAnnotationTagArgs

RuleContainerRuleKubernetesRuleExcludePodAnnotationRegex, RuleContainerRuleKubernetesRuleExcludePodAnnotationRegexArgs

RuleContainerRuleKubernetesRuleExcludePodLabelRegex, RuleContainerRuleKubernetesRuleExcludePodLabelRegexArgs

RuleContainerRuleKubernetesRuleIncludePodAnnotationRegex, RuleContainerRuleKubernetesRuleIncludePodAnnotationRegexArgs

RuleContainerRuleKubernetesRuleIncludePodLabelRegex, RuleContainerRuleKubernetesRuleIncludePodLabelRegexArgs

RuleContainerRuleKubernetesRuleLabelTag, RuleContainerRuleKubernetesRuleLabelTagArgs

RuleExcludePath, RuleExcludePathArgs

RuleExtractRule, RuleExtractRuleArgs

RuleExtractRuleFilterKeyRegex, RuleExtractRuleFilterKeyRegexArgs

RuleExtractRuleLogTemplate, RuleExtractRuleLogTemplateArgs

RuleHostGroupInfo, RuleHostGroupInfoArgs

RuleUserDefineRule, RuleUserDefineRuleArgs

RuleUserDefineRuleAdvanced, RuleUserDefineRuleAdvancedArgs

RuleUserDefineRuleField, RuleUserDefineRuleFieldArgs

RuleUserDefineRuleParsePathRule, RuleUserDefineRuleParsePathRuleArgs

RuleUserDefineRulePlugin, RuleUserDefineRulePluginArgs

RuleUserDefineRuleShardHashKey, RuleUserDefineRuleShardHashKeyArgs

Import

Package Details

On this page

On this page