1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. tls
  6. getRule
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.tls.getRule

volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    Data Source schema for Volcengine::TLS::Rule

    Using getRule

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRule(args: GetRuleArgs, opts?: InvokeOptions): Promise<GetRuleResult>
function getRuleOutput(args: GetRuleOutputArgs, opts?: InvokeOptions): Output<GetRuleResult>
    def get_rule(id: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetRuleResult
def get_rule_output(id: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetRuleResult]
    func LookupRule(ctx *Context, args *LookupRuleArgs, opts ...InvokeOption) (*LookupRuleResult, error)
func LookupRuleOutput(ctx *Context, args *LookupRuleOutputArgs, opts ...InvokeOption) LookupRuleResultOutput

    > Note: This function is named LookupRule in the Go SDK.

    public static class GetRule 
{
    public static Task<GetRuleResult> InvokeAsync(GetRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetRuleResult> Invoke(GetRuleInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRuleResult> getRule(GetRuleArgs args, InvokeOptions options)
public static Output<GetRuleResult> getRule(GetRuleArgs args, InvokeOptions options)

    fn::invoke:
  function: volcenginecc:tls/getRule:getRule
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    Uniquely identifies the resource.
    Id string
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getRule Result

    The following output properties are available:

    ContainerRule Volcengine.GetRuleContainerRule
    Container log collection rules.
    CreateTime string
    Time when the collection configuration was created.
    ExcludePaths List<Volcengine.GetRuleExcludePath>
    Denylist entries for collection. You can create up to 10 denylist entries. When InputType=0 or InputType=2: If Type is Path, Value represents a directory. Supports exact match and wildcard pattern matching. Wildcards supported: *, ?. The ** wildcard is not supported. If Type is File, Value represents a file name. Supports exact match and wildcard pattern matching. Wildcards supported: **, *, ?. Only one ** wildcard can be configured at most. When InputType=1: Configuring a denylist is not allowed.
    ExtractRule Volcengine.GetRuleExtractRule
    Log extraction rules. Note: This parameter is required if LogType is set to any type other than minimalistlog or jsonlog.
    HostGroupInfos List<Volcengine.GetRuleHostGroupInfo>
    Machine group information list.
    Id string
    Uniquely identifies the resource.
    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.GetRuleUserDefineRule
    User-defined collection rules.
    ContainerRule GetRuleContainerRule
    Container log collection rules.
    CreateTime string
    Time when the collection configuration was created.
    ExcludePaths []GetRuleExcludePath
    Denylist entries for collection. You can create up to 10 denylist entries. When InputType=0 or InputType=2: If Type is Path, Value represents a directory. Supports exact match and wildcard pattern matching. Wildcards supported: *, ?. The ** wildcard is not supported. If Type is File, Value represents a file name. Supports exact match and wildcard pattern matching. Wildcards supported: **, *, ?. Only one ** wildcard can be configured at most. When InputType=1: Configuring a denylist is not allowed.
    ExtractRule GetRuleExtractRule
    Log extraction rules. Note: This parameter is required if LogType is set to any type other than minimalistlog or jsonlog.
    HostGroupInfos []GetRuleHostGroupInfo
    Machine group information list.
    Id string
    Uniquely identifies the resource.
    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 GetRuleUserDefineRule
    User-defined collection rules.
    containerRule GetRuleContainerRule
    Container log collection rules.
    createTime String
    Time when the collection configuration was created.
    excludePaths List<GetRuleExcludePath>
    Denylist entries for collection. You can create up to 10 denylist entries. When InputType=0 or InputType=2: If Type is Path, Value represents a directory. Supports exact match and wildcard pattern matching. Wildcards supported: *, ?. The ** wildcard is not supported. If Type is File, Value represents a file name. Supports exact match and wildcard pattern matching. Wildcards supported: **, *, ?. Only one ** wildcard can be configured at most. When InputType=1: Configuring a denylist is not allowed.
    extractRule GetRuleExtractRule
    Log extraction rules. Note: This parameter is required if LogType is set to any type other than minimalistlog or jsonlog.
    hostGroupInfos List<GetRuleHostGroupInfo>
    Machine group information list.
    id String
    Uniquely identifies the resource.
    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 GetRuleUserDefineRule
    User-defined collection rules.
    containerRule GetRuleContainerRule
    Container log collection rules.
    createTime string
    Time when the collection configuration was created.
    excludePaths GetRuleExcludePath[]
    Denylist entries for collection. You can create up to 10 denylist entries. When InputType=0 or InputType=2: If Type is Path, Value represents a directory. Supports exact match and wildcard pattern matching. Wildcards supported: *, ?. The ** wildcard is not supported. If Type is File, Value represents a file name. Supports exact match and wildcard pattern matching. Wildcards supported: **, *, ?. Only one ** wildcard can be configured at most. When InputType=1: Configuring a denylist is not allowed.
    extractRule GetRuleExtractRule
    Log extraction rules. Note: This parameter is required if LogType is set to any type other than minimalistlog or jsonlog.
    hostGroupInfos GetRuleHostGroupInfo[]
    Machine group information list.
    id string
    Uniquely identifies the resource.
    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 GetRuleUserDefineRule
    User-defined collection rules.
    container_rule GetRuleContainerRule
    Container log collection rules.
    create_time str
    Time when the collection configuration was created.
    exclude_paths Sequence[GetRuleExcludePath]
    Denylist entries for collection. You can create up to 10 denylist entries. When InputType=0 or InputType=2: If Type is Path, Value represents a directory. Supports exact match and wildcard pattern matching. Wildcards supported: *, ?. The ** wildcard is not supported. If Type is File, Value represents a file name. Supports exact match and wildcard pattern matching. Wildcards supported: **, *, ?. Only one ** wildcard can be configured at most. When InputType=1: Configuring a denylist is not allowed.
    extract_rule GetRuleExtractRule
    Log extraction rules. Note: This parameter is required if LogType is set to any type other than minimalistlog or jsonlog.
    host_group_infos Sequence[GetRuleHostGroupInfo]
    Machine group information list.
    id str
    Uniquely identifies the resource.
    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 GetRuleUserDefineRule
    User-defined collection rules.
    containerRule Property Map
    Container log collection rules.
    createTime String
    Time when the collection configuration was created.
    excludePaths List<Property Map>
    Denylist entries for collection. You can create up to 10 denylist entries. When InputType=0 or InputType=2: If Type is Path, Value represents a directory. Supports exact match and wildcard pattern matching. Wildcards supported: *, ?. The ** wildcard is not supported. If Type is File, Value represents a file name. Supports exact match and wildcard pattern matching. Wildcards supported: **, *, ?. Only one ** wildcard can be configured at most. When InputType=1: Configuring a denylist is not allowed.
    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>
    Machine group information list.
    id String
    Uniquely identifies the resource.
    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

    GetRuleContainerRule

    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.GetRuleContainerRuleEnvTag>
    Whether to add environment variables as log tags to the raw log data. When enabled, the log service adds container environment variable fields to the logs. Setting multiple key-value pairs adds multiple fields. For example, set Key to source and Value to data_source. If the container has the environment variable source=DC, the log will include the field tagdata_source_*: DC
    ExcludeContainerEnvRegexes List<Volcengine.GetRuleContainerRuleExcludeContainerEnvRegex>
    The container environment variable denylist specifies which containers are excluded from collection. If the denylist is not enabled, all containers are collected. When the container environment variable denylist is enabled, Key is required and Value is optional. If Value is empty, all containers whose environment variables contain the Key are excluded from collection. If Value is not empty, only containers with a matching key-value pair are excluded, meaning only containers whose environment variables contain the Key and whose value matches the Value are excluded. Value supports regular expressions. For example, if Key is set to module and Value is set to ^(tcp|udp)$, containers with environment variables module:tcp or module:udp are excluded from collection. Multiple key-value pairs are evaluated with a logical OR, so any container environment variable matching any key-value pair will be excluded from collection. When the container environment variable denylist is enabled, Keys must be unique.
    ExcludeContainerLabelRegexes List<Volcengine.GetRuleContainerRuleExcludeContainerLabelRegex>
    Container label denylist specifies containers to exclude from collection. If the denylist is not enabled, all containers will be collected. If the container label denylist is enabled, Key is required and Value is optional. If Value is empty, all containers with the Key in their label will be excluded. If Value is not empty, only containers matching the key-value pair will be excluded—that is, containers with the Key in their label and a Value matching the specified pattern. Value supports regex matching; for example, set Key to app and Value to ^(test1|test2)$ to exclude containers with labels app:test1 and app:test2. Multiple key-value pairs use logical OR; any container label matching any pair will be excluded from collection. When the container label denylist is enabled, Keys must not be duplicated.
    IncludeContainerEnvRegexes List<Volcengine.GetRuleContainerRuleIncludeContainerEnvRegex>
    The container environment variable allowlist specifies which containers to collect using container environment variables. If the allowlist is not enabled, all containers are collected. When the container environment variable allowlist is enabled, you must enter key-value pairs. Key is required; Value is optional. If Value is empty, all containers containing the Key in their environment variables are collected. If Value is not empty, only containers with the Key in their environment variables and a Value matching the specified value are collected. Value supports regular expression matching. For example, if Key is set to module and Value is set to ^(tcp|udp)$, only containers with module:tcp or module:udp in their environment variables are collected. The logical relationship between multiple key-value pairs is OR, meaning any container environment variable matching any key-value pair will be included in the collection scope. When the container environment variable allowlist is enabled, Keys must not be duplicated.
    IncludeContainerLabelRegexes List<Volcengine.GetRuleContainerRuleIncludeContainerLabelRegex>
    The container label allowlist specifies which containers to collect based on container labels. If the allowlist is not enabled, all containers are collected. When the container label allowlist is enabled, you must specify key-value pairs. Key is required and Value is optional. If Value is empty, all containers whose labels contain the Key are collected. If Value is not empty, only containers whose labels contain the Key and whose value matches the Value are collected. Value supports regular expressions. For example, if Key is set to app and Value is set to ^(test1|test2)$, only containers with labels app:test1 or app:test2 are collected. Multiple key-value pairs are evaluated with a logical OR, so any container label matching any key-value pair will be included in the collection scope. When the container label allowlist is enabled, Keys must be unique.
    KubernetesRule Volcengine.GetRuleContainerRuleKubernetesRule
    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 []GetRuleContainerRuleEnvTag
    Whether to add environment variables as log tags to the raw log data. When enabled, the log service adds container environment variable fields to the logs. Setting multiple key-value pairs adds multiple fields. For example, set Key to source and Value to data_source. If the container has the environment variable source=DC, the log will include the field tagdata_source_*: DC
    ExcludeContainerEnvRegexes []GetRuleContainerRuleExcludeContainerEnvRegex
    The container environment variable denylist specifies which containers are excluded from collection. If the denylist is not enabled, all containers are collected. When the container environment variable denylist is enabled, Key is required and Value is optional. If Value is empty, all containers whose environment variables contain the Key are excluded from collection. If Value is not empty, only containers with a matching key-value pair are excluded, meaning only containers whose environment variables contain the Key and whose value matches the Value are excluded. Value supports regular expressions. For example, if Key is set to module and Value is set to ^(tcp|udp)$, containers with environment variables module:tcp or module:udp are excluded from collection. Multiple key-value pairs are evaluated with a logical OR, so any container environment variable matching any key-value pair will be excluded from collection. When the container environment variable denylist is enabled, Keys must be unique.
    ExcludeContainerLabelRegexes []GetRuleContainerRuleExcludeContainerLabelRegex
    Container label denylist specifies containers to exclude from collection. If the denylist is not enabled, all containers will be collected. If the container label denylist is enabled, Key is required and Value is optional. If Value is empty, all containers with the Key in their label will be excluded. If Value is not empty, only containers matching the key-value pair will be excluded—that is, containers with the Key in their label and a Value matching the specified pattern. Value supports regex matching; for example, set Key to app and Value to ^(test1|test2)$ to exclude containers with labels app:test1 and app:test2. Multiple key-value pairs use logical OR; any container label matching any pair will be excluded from collection. When the container label denylist is enabled, Keys must not be duplicated.
    IncludeContainerEnvRegexes []GetRuleContainerRuleIncludeContainerEnvRegex
    The container environment variable allowlist specifies which containers to collect using container environment variables. If the allowlist is not enabled, all containers are collected. When the container environment variable allowlist is enabled, you must enter key-value pairs. Key is required; Value is optional. If Value is empty, all containers containing the Key in their environment variables are collected. If Value is not empty, only containers with the Key in their environment variables and a Value matching the specified value are collected. Value supports regular expression matching. For example, if Key is set to module and Value is set to ^(tcp|udp)$, only containers with module:tcp or module:udp in their environment variables are collected. The logical relationship between multiple key-value pairs is OR, meaning any container environment variable matching any key-value pair will be included in the collection scope. When the container environment variable allowlist is enabled, Keys must not be duplicated.
    IncludeContainerLabelRegexes []GetRuleContainerRuleIncludeContainerLabelRegex
    The container label allowlist specifies which containers to collect based on container labels. If the allowlist is not enabled, all containers are collected. When the container label allowlist is enabled, you must specify key-value pairs. Key is required and Value is optional. If Value is empty, all containers whose labels contain the Key are collected. If Value is not empty, only containers whose labels contain the Key and whose value matches the Value are collected. Value supports regular expressions. For example, if Key is set to app and Value is set to ^(test1|test2)$, only containers with labels app:test1 or app:test2 are collected. Multiple key-value pairs are evaluated with a logical OR, so any container label matching any key-value pair will be included in the collection scope. When the container label allowlist is enabled, Keys must be unique.
    KubernetesRule GetRuleContainerRuleKubernetesRule
    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<GetRuleContainerRuleEnvTag>
    Whether to add environment variables as log tags to the raw log data. When enabled, the log service adds container environment variable fields to the logs. Setting multiple key-value pairs adds multiple fields. For example, set Key to source and Value to data_source. If the container has the environment variable source=DC, the log will include the field tagdata_source_*: DC
    excludeContainerEnvRegexes List<GetRuleContainerRuleExcludeContainerEnvRegex>
    The container environment variable denylist specifies which containers are excluded from collection. If the denylist is not enabled, all containers are collected. When the container environment variable denylist is enabled, Key is required and Value is optional. If Value is empty, all containers whose environment variables contain the Key are excluded from collection. If Value is not empty, only containers with a matching key-value pair are excluded, meaning only containers whose environment variables contain the Key and whose value matches the Value are excluded. Value supports regular expressions. For example, if Key is set to module and Value is set to ^(tcp|udp)$, containers with environment variables module:tcp or module:udp are excluded from collection. Multiple key-value pairs are evaluated with a logical OR, so any container environment variable matching any key-value pair will be excluded from collection. When the container environment variable denylist is enabled, Keys must be unique.
    excludeContainerLabelRegexes List<GetRuleContainerRuleExcludeContainerLabelRegex>
    Container label denylist specifies containers to exclude from collection. If the denylist is not enabled, all containers will be collected. If the container label denylist is enabled, Key is required and Value is optional. If Value is empty, all containers with the Key in their label will be excluded. If Value is not empty, only containers matching the key-value pair will be excluded—that is, containers with the Key in their label and a Value matching the specified pattern. Value supports regex matching; for example, set Key to app and Value to ^(test1|test2)$ to exclude containers with labels app:test1 and app:test2. Multiple key-value pairs use logical OR; any container label matching any pair will be excluded from collection. When the container label denylist is enabled, Keys must not be duplicated.
    includeContainerEnvRegexes List<GetRuleContainerRuleIncludeContainerEnvRegex>
    The container environment variable allowlist specifies which containers to collect using container environment variables. If the allowlist is not enabled, all containers are collected. When the container environment variable allowlist is enabled, you must enter key-value pairs. Key is required; Value is optional. If Value is empty, all containers containing the Key in their environment variables are collected. If Value is not empty, only containers with the Key in their environment variables and a Value matching the specified value are collected. Value supports regular expression matching. For example, if Key is set to module and Value is set to ^(tcp|udp)$, only containers with module:tcp or module:udp in their environment variables are collected. The logical relationship between multiple key-value pairs is OR, meaning any container environment variable matching any key-value pair will be included in the collection scope. When the container environment variable allowlist is enabled, Keys must not be duplicated.
    includeContainerLabelRegexes List<GetRuleContainerRuleIncludeContainerLabelRegex>
    The container label allowlist specifies which containers to collect based on container labels. If the allowlist is not enabled, all containers are collected. When the container label allowlist is enabled, you must specify key-value pairs. Key is required and Value is optional. If Value is empty, all containers whose labels contain the Key are collected. If Value is not empty, only containers whose labels contain the Key and whose value matches the Value are collected. Value supports regular expressions. For example, if Key is set to app and Value is set to ^(test1|test2)$, only containers with labels app:test1 or app:test2 are collected. Multiple key-value pairs are evaluated with a logical OR, so any container label matching any key-value pair will be included in the collection scope. When the container label allowlist is enabled, Keys must be unique.
    kubernetesRule GetRuleContainerRuleKubernetesRule
    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 GetRuleContainerRuleEnvTag[]
    Whether to add environment variables as log tags to the raw log data. When enabled, the log service adds container environment variable fields to the logs. Setting multiple key-value pairs adds multiple fields. For example, set Key to source and Value to data_source. If the container has the environment variable source=DC, the log will include the field tagdata_source_*: DC
    excludeContainerEnvRegexes GetRuleContainerRuleExcludeContainerEnvRegex[]
    The container environment variable denylist specifies which containers are excluded from collection. If the denylist is not enabled, all containers are collected. When the container environment variable denylist is enabled, Key is required and Value is optional. If Value is empty, all containers whose environment variables contain the Key are excluded from collection. If Value is not empty, only containers with a matching key-value pair are excluded, meaning only containers whose environment variables contain the Key and whose value matches the Value are excluded. Value supports regular expressions. For example, if Key is set to module and Value is set to ^(tcp|udp)$, containers with environment variables module:tcp or module:udp are excluded from collection. Multiple key-value pairs are evaluated with a logical OR, so any container environment variable matching any key-value pair will be excluded from collection. When the container environment variable denylist is enabled, Keys must be unique.
    excludeContainerLabelRegexes GetRuleContainerRuleExcludeContainerLabelRegex[]
    Container label denylist specifies containers to exclude from collection. If the denylist is not enabled, all containers will be collected. If the container label denylist is enabled, Key is required and Value is optional. If Value is empty, all containers with the Key in their label will be excluded. If Value is not empty, only containers matching the key-value pair will be excluded—that is, containers with the Key in their label and a Value matching the specified pattern. Value supports regex matching; for example, set Key to app and Value to ^(test1|test2)$ to exclude containers with labels app:test1 and app:test2. Multiple key-value pairs use logical OR; any container label matching any pair will be excluded from collection. When the container label denylist is enabled, Keys must not be duplicated.
    includeContainerEnvRegexes GetRuleContainerRuleIncludeContainerEnvRegex[]
    The container environment variable allowlist specifies which containers to collect using container environment variables. If the allowlist is not enabled, all containers are collected. When the container environment variable allowlist is enabled, you must enter key-value pairs. Key is required; Value is optional. If Value is empty, all containers containing the Key in their environment variables are collected. If Value is not empty, only containers with the Key in their environment variables and a Value matching the specified value are collected. Value supports regular expression matching. For example, if Key is set to module and Value is set to ^(tcp|udp)$, only containers with module:tcp or module:udp in their environment variables are collected. The logical relationship between multiple key-value pairs is OR, meaning any container environment variable matching any key-value pair will be included in the collection scope. When the container environment variable allowlist is enabled, Keys must not be duplicated.
    includeContainerLabelRegexes GetRuleContainerRuleIncludeContainerLabelRegex[]
    The container label allowlist specifies which containers to collect based on container labels. If the allowlist is not enabled, all containers are collected. When the container label allowlist is enabled, you must specify key-value pairs. Key is required and Value is optional. If Value is empty, all containers whose labels contain the Key are collected. If Value is not empty, only containers whose labels contain the Key and whose value matches the Value are collected. Value supports regular expressions. For example, if Key is set to app and Value is set to ^(test1|test2)$, only containers with labels app:test1 or app:test2 are collected. Multiple key-value pairs are evaluated with a logical OR, so any container label matching any key-value pair will be included in the collection scope. When the container label allowlist is enabled, Keys must be unique.
    kubernetesRule GetRuleContainerRuleKubernetesRule
    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[GetRuleContainerRuleEnvTag]
    Whether to add environment variables as log tags to the raw log data. When enabled, the log service adds container environment variable fields to the logs. Setting multiple key-value pairs adds multiple fields. For example, set Key to source and Value to data_source. If the container has the environment variable source=DC, the log will include the field tagdata_source_*: DC
    exclude_container_env_regexes Sequence[GetRuleContainerRuleExcludeContainerEnvRegex]
    The container environment variable denylist specifies which containers are excluded from collection. If the denylist is not enabled, all containers are collected. When the container environment variable denylist is enabled, Key is required and Value is optional. If Value is empty, all containers whose environment variables contain the Key are excluded from collection. If Value is not empty, only containers with a matching key-value pair are excluded, meaning only containers whose environment variables contain the Key and whose value matches the Value are excluded. Value supports regular expressions. For example, if Key is set to module and Value is set to ^(tcp|udp)$, containers with environment variables module:tcp or module:udp are excluded from collection. Multiple key-value pairs are evaluated with a logical OR, so any container environment variable matching any key-value pair will be excluded from collection. When the container environment variable denylist is enabled, Keys must be unique.
    exclude_container_label_regexes Sequence[GetRuleContainerRuleExcludeContainerLabelRegex]
    Container label denylist specifies containers to exclude from collection. If the denylist is not enabled, all containers will be collected. If the container label denylist is enabled, Key is required and Value is optional. If Value is empty, all containers with the Key in their label will be excluded. If Value is not empty, only containers matching the key-value pair will be excluded—that is, containers with the Key in their label and a Value matching the specified pattern. Value supports regex matching; for example, set Key to app and Value to ^(test1|test2)$ to exclude containers with labels app:test1 and app:test2. Multiple key-value pairs use logical OR; any container label matching any pair will be excluded from collection. When the container label denylist is enabled, Keys must not be duplicated.
    include_container_env_regexes Sequence[GetRuleContainerRuleIncludeContainerEnvRegex]
    The container environment variable allowlist specifies which containers to collect using container environment variables. If the allowlist is not enabled, all containers are collected. When the container environment variable allowlist is enabled, you must enter key-value pairs. Key is required; Value is optional. If Value is empty, all containers containing the Key in their environment variables are collected. If Value is not empty, only containers with the Key in their environment variables and a Value matching the specified value are collected. Value supports regular expression matching. For example, if Key is set to module and Value is set to ^(tcp|udp)$, only containers with module:tcp or module:udp in their environment variables are collected. The logical relationship between multiple key-value pairs is OR, meaning any container environment variable matching any key-value pair will be included in the collection scope. When the container environment variable allowlist is enabled, Keys must not be duplicated.
    include_container_label_regexes Sequence[GetRuleContainerRuleIncludeContainerLabelRegex]
    The container label allowlist specifies which containers to collect based on container labels. If the allowlist is not enabled, all containers are collected. When the container label allowlist is enabled, you must specify key-value pairs. Key is required and Value is optional. If Value is empty, all containers whose labels contain the Key are collected. If Value is not empty, only containers whose labels contain the Key and whose value matches the Value are collected. Value supports regular expressions. For example, if Key is set to app and Value is set to ^(test1|test2)$, only containers with labels app:test1 or app:test2 are collected. Multiple key-value pairs are evaluated with a logical OR, so any container label matching any key-value pair will be included in the collection scope. When the container label allowlist is enabled, Keys must be unique.
    kubernetes_rule GetRuleContainerRuleKubernetesRule
    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>
    Whether to add environment variables as log tags to the raw log data. When enabled, the log service adds container environment variable fields to the logs. Setting multiple key-value pairs adds multiple fields. For example, set Key to source and Value to data_source. If the container has the environment variable source=DC, the log will include the field tagdata_source_*: DC
    excludeContainerEnvRegexes List<Property Map>
    The container environment variable denylist specifies which containers are excluded from collection. If the denylist is not enabled, all containers are collected. When the container environment variable denylist is enabled, Key is required and Value is optional. If Value is empty, all containers whose environment variables contain the Key are excluded from collection. If Value is not empty, only containers with a matching key-value pair are excluded, meaning only containers whose environment variables contain the Key and whose value matches the Value are excluded. Value supports regular expressions. For example, if Key is set to module and Value is set to ^(tcp|udp)$, containers with environment variables module:tcp or module:udp are excluded from collection. Multiple key-value pairs are evaluated with a logical OR, so any container environment variable matching any key-value pair will be excluded from collection. When the container environment variable denylist is enabled, Keys must be unique.
    excludeContainerLabelRegexes List<Property Map>
    Container label denylist specifies containers to exclude from collection. If the denylist is not enabled, all containers will be collected. If the container label denylist is enabled, Key is required and Value is optional. If Value is empty, all containers with the Key in their label will be excluded. If Value is not empty, only containers matching the key-value pair will be excluded—that is, containers with the Key in their label and a Value matching the specified pattern. Value supports regex matching; for example, set Key to app and Value to ^(test1|test2)$ to exclude containers with labels app:test1 and app:test2. Multiple key-value pairs use logical OR; any container label matching any pair will be excluded from collection. When the container label denylist is enabled, Keys must not be duplicated.
    includeContainerEnvRegexes List<Property Map>
    The container environment variable allowlist specifies which containers to collect using container environment variables. If the allowlist is not enabled, all containers are collected. When the container environment variable allowlist is enabled, you must enter key-value pairs. Key is required; Value is optional. If Value is empty, all containers containing the Key in their environment variables are collected. If Value is not empty, only containers with the Key in their environment variables and a Value matching the specified value are collected. Value supports regular expression matching. For example, if Key is set to module and Value is set to ^(tcp|udp)$, only containers with module:tcp or module:udp in their environment variables are collected. The logical relationship between multiple key-value pairs is OR, meaning any container environment variable matching any key-value pair will be included in the collection scope. When the container environment variable allowlist is enabled, Keys must not be duplicated.
    includeContainerLabelRegexes List<Property Map>
    The container label allowlist specifies which containers to collect based on container labels. If the allowlist is not enabled, all containers are collected. When the container label allowlist is enabled, you must specify key-value pairs. Key is required and Value is optional. If Value is empty, all containers whose labels contain the Key are collected. If Value is not empty, only containers whose labels contain the Key and whose value matches the Value are collected. Value supports regular expressions. For example, if Key is set to app and Value is set to ^(test1|test2)$, only containers with labels app:test1 or app:test2 are collected. Multiple key-value pairs are evaluated with a logical OR, so any container label matching any key-value pair will be included in the collection scope. When the container label allowlist is enabled, Keys must be unique.
    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).

    GetRuleContainerRuleEnvTag

    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.

    GetRuleContainerRuleExcludeContainerEnvRegex

    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.

    GetRuleContainerRuleExcludeContainerLabelRegex

    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.

    GetRuleContainerRuleIncludeContainerEnvRegex

    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.

    GetRuleContainerRuleIncludeContainerLabelRegex

    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.

    GetRuleContainerRuleKubernetesRule

    AnnotationTags List<Volcengine.GetRuleContainerRuleKubernetesRuleAnnotationTag>
    Whether to add Kubernetes Annotations as log tags to the original log data. When enabled, the log service will add fields related to Kubernetes Pod Annotations to the logs. Setting multiple key-value pairs means adding multiple fields. For example, if you set Key to sink and Value to data_sink, and the Pod contains the annotation sink=ck, a new field tagdata_sink_*: ck will be added to the log.
    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.GetRuleContainerRuleKubernetesRuleExcludePodAnnotationRegex>
    Pod Annotation Denylist is used to specify containers that are not collected. If you need to set a Pod Annotation Denylist, Key is required and Value is optional. If Value is empty, all containers under Pods whose Pod Annotation contains the specified Key are excluded. If Value is not empty, only containers under Pods whose Pod Annotation contains the Key and whose value matches the specified Value are excluded. By default, Value uses string matching, meaning it only matches when Value and the Pod Annotation value are exactly the same. If the value starts with ^ and ends with $, it is treated as a regular expression. For example, if Key is set to app and Value is set to ^(test1|test2)$, it matches containers under Pods with Pod Annotation app:test1 or app:test2. Note: The logical relationship between multiple Key-Value pairs is OR, meaning a Pod Annotation that matches any pair will be excluded from the collection scope. When enabling the Pod Annotation Denylist, Keys must not be duplicated. For regex fuzzy matching, you must add .. For example, ^(http.)$ matches strings starting with http
    ExcludePodLabelRegexes List<Volcengine.GetRuleContainerRuleKubernetesRuleExcludePodLabelRegex>
    Specify containers to exclude from collection using the Pod Label denylist. If not enabled, all containers are collected. To set a Pod Label denylist, Key is required and Value is optional. If Value is empty, all containers with the specified Key in their Pod Label are excluded from collection. If Value is not empty, only containers with the specified Key and a Value matching the Value in their Pod Label are excluded. Value supports regular expressions. For example, set Key to module and Value to ^(tcp|udp)$ to exclude containers with module:tcp or module:udp in their Pod Label. Note: The logical relationship between multiple Key-Value pairs is OR. Any Pod Label matching any Key-Value pair will be excluded from collection. When enabling the Pod Label denylist, Keys must not be duplicated. For fuzzy regular expression matching, you must add .. For example, ^(http.)$ matches any string starting with http
    IncludePodAnnotationRegexes List<Volcengine.GetRuleContainerRuleKubernetesRuleIncludePodAnnotationRegex>
    Pod Annotation Allowlist is used to specify containers to be collected. If you need to set a Pod Annotation Allowlist, Key is required and Value is optional. If Value is empty, all containers under Pods that contain the Key in Pod Annotation will match. If Value is not empty, only containers under Pods that contain the Key and whose value matches Value in Pod Annotation will match. Value defaults to string matching, meaning only when Value and the Pod Annotation value are exactly the same will they match. If the value starts with ^ and ends with $, it is a regex match. For example, set Key to app and Value to ^(test1|test2)$ to match containers under Pods with Pod Annotation app:test1 or app:test2. Note: The logical relationship between multiple Key-Value pairs is OR, meaning as long as Pod Annotation matches any pair, it will be included in the collection scope. When enabling Pod Annotation Allowlist, Keys must not be duplicated. For regex fuzzy matching, you must add .. For example, ^(http.)$ matches strings starting with http.
    IncludePodLabelRegexes List<Volcengine.GetRuleContainerRuleKubernetesRuleIncludePodLabelRegex>
    Pod Label Allowlist is used to specify which containers to collect. If Pod Label Allowlist is not enabled, all containers will be collected. If you need to set a Pod Label Allowlist, Key is required: if Value is empty, all containers with the Key in their Pod Label will be collected. If Value is not empty, only containers with the Key in their Pod Label and a Value matching the specified pattern will be collected; regular expression matching is supported. For example, if you set Key to module and Value to ^(tcp|udp)$, only containers with module:tcp or module:udp in their Pod Label will be collected. Note: The logical relationship between multiple key-value pairs is OR, meaning any Pod Label matching any key-value pair will be included in the collection scope. When enabling Pod Label Allowlist, Keys cannot be duplicated. For fuzzy regular expression matching, you must add ., for example, ^(http.)$ matches strings starting with http.
    LabelTags List<Volcengine.GetRuleContainerRuleKubernetesRuleLabelTag>
    Whether to add Kubernetes labels as log tags to the raw log data. When enabled, the log service adds Kubernetes Pod label fields to the logs. Setting multiple key-value pairs adds multiple fields. For example, if you set Key to source and Value to data_source, and the Pod contains the label source=DC, the log will include the field tagdata_source_*: DC.
    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 []GetRuleContainerRuleKubernetesRuleAnnotationTag
    Whether to add Kubernetes Annotations as log tags to the original log data. When enabled, the log service will add fields related to Kubernetes Pod Annotations to the logs. Setting multiple key-value pairs means adding multiple fields. For example, if you set Key to sink and Value to data_sink, and the Pod contains the annotation sink=ck, a new field tagdata_sink_*: ck will be added to the log.
    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 []GetRuleContainerRuleKubernetesRuleExcludePodAnnotationRegex
    Pod Annotation Denylist is used to specify containers that are not collected. If you need to set a Pod Annotation Denylist, Key is required and Value is optional. If Value is empty, all containers under Pods whose Pod Annotation contains the specified Key are excluded. If Value is not empty, only containers under Pods whose Pod Annotation contains the Key and whose value matches the specified Value are excluded. By default, Value uses string matching, meaning it only matches when Value and the Pod Annotation value are exactly the same. If the value starts with ^ and ends with $, it is treated as a regular expression. For example, if Key is set to app and Value is set to ^(test1|test2)$, it matches containers under Pods with Pod Annotation app:test1 or app:test2. Note: The logical relationship between multiple Key-Value pairs is OR, meaning a Pod Annotation that matches any pair will be excluded from the collection scope. When enabling the Pod Annotation Denylist, Keys must not be duplicated. For regex fuzzy matching, you must add .. For example, ^(http.)$ matches strings starting with http
    ExcludePodLabelRegexes []GetRuleContainerRuleKubernetesRuleExcludePodLabelRegex
    Specify containers to exclude from collection using the Pod Label denylist. If not enabled, all containers are collected. To set a Pod Label denylist, Key is required and Value is optional. If Value is empty, all containers with the specified Key in their Pod Label are excluded from collection. If Value is not empty, only containers with the specified Key and a Value matching the Value in their Pod Label are excluded. Value supports regular expressions. For example, set Key to module and Value to ^(tcp|udp)$ to exclude containers with module:tcp or module:udp in their Pod Label. Note: The logical relationship between multiple Key-Value pairs is OR. Any Pod Label matching any Key-Value pair will be excluded from collection. When enabling the Pod Label denylist, Keys must not be duplicated. For fuzzy regular expression matching, you must add .. For example, ^(http.)$ matches any string starting with http
    IncludePodAnnotationRegexes []GetRuleContainerRuleKubernetesRuleIncludePodAnnotationRegex
    Pod Annotation Allowlist is used to specify containers to be collected. If you need to set a Pod Annotation Allowlist, Key is required and Value is optional. If Value is empty, all containers under Pods that contain the Key in Pod Annotation will match. If Value is not empty, only containers under Pods that contain the Key and whose value matches Value in Pod Annotation will match. Value defaults to string matching, meaning only when Value and the Pod Annotation value are exactly the same will they match. If the value starts with ^ and ends with $, it is a regex match. For example, set Key to app and Value to ^(test1|test2)$ to match containers under Pods with Pod Annotation app:test1 or app:test2. Note: The logical relationship between multiple Key-Value pairs is OR, meaning as long as Pod Annotation matches any pair, it will be included in the collection scope. When enabling Pod Annotation Allowlist, Keys must not be duplicated. For regex fuzzy matching, you must add .. For example, ^(http.)$ matches strings starting with http.
    IncludePodLabelRegexes []GetRuleContainerRuleKubernetesRuleIncludePodLabelRegex
    Pod Label Allowlist is used to specify which containers to collect. If Pod Label Allowlist is not enabled, all containers will be collected. If you need to set a Pod Label Allowlist, Key is required: if Value is empty, all containers with the Key in their Pod Label will be collected. If Value is not empty, only containers with the Key in their Pod Label and a Value matching the specified pattern will be collected; regular expression matching is supported. For example, if you set Key to module and Value to ^(tcp|udp)$, only containers with module:tcp or module:udp in their Pod Label will be collected. Note: The logical relationship between multiple key-value pairs is OR, meaning any Pod Label matching any key-value pair will be included in the collection scope. When enabling Pod Label Allowlist, Keys cannot be duplicated. For fuzzy regular expression matching, you must add ., for example, ^(http.)$ matches strings starting with http.
    LabelTags []GetRuleContainerRuleKubernetesRuleLabelTag
    Whether to add Kubernetes labels as log tags to the raw log data. When enabled, the log service adds Kubernetes Pod label fields to the logs. Setting multiple key-value pairs adds multiple fields. For example, if you set Key to source and Value to data_source, and the Pod contains the label source=DC, the log will include the field tagdata_source_*: DC.
    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<GetRuleContainerRuleKubernetesRuleAnnotationTag>
    Whether to add Kubernetes Annotations as log tags to the original log data. When enabled, the log service will add fields related to Kubernetes Pod Annotations to the logs. Setting multiple key-value pairs means adding multiple fields. For example, if you set Key to sink and Value to data_sink, and the Pod contains the annotation sink=ck, a new field tagdata_sink_*: ck will be added to the log.
    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<GetRuleContainerRuleKubernetesRuleExcludePodAnnotationRegex>
    Pod Annotation Denylist is used to specify containers that are not collected. If you need to set a Pod Annotation Denylist, Key is required and Value is optional. If Value is empty, all containers under Pods whose Pod Annotation contains the specified Key are excluded. If Value is not empty, only containers under Pods whose Pod Annotation contains the Key and whose value matches the specified Value are excluded. By default, Value uses string matching, meaning it only matches when Value and the Pod Annotation value are exactly the same. If the value starts with ^ and ends with $, it is treated as a regular expression. For example, if Key is set to app and Value is set to ^(test1|test2)$, it matches containers under Pods with Pod Annotation app:test1 or app:test2. Note: The logical relationship between multiple Key-Value pairs is OR, meaning a Pod Annotation that matches any pair will be excluded from the collection scope. When enabling the Pod Annotation Denylist, Keys must not be duplicated. For regex fuzzy matching, you must add .. For example, ^(http.)$ matches strings starting with http
    excludePodLabelRegexes List<GetRuleContainerRuleKubernetesRuleExcludePodLabelRegex>
    Specify containers to exclude from collection using the Pod Label denylist. If not enabled, all containers are collected. To set a Pod Label denylist, Key is required and Value is optional. If Value is empty, all containers with the specified Key in their Pod Label are excluded from collection. If Value is not empty, only containers with the specified Key and a Value matching the Value in their Pod Label are excluded. Value supports regular expressions. For example, set Key to module and Value to ^(tcp|udp)$ to exclude containers with module:tcp or module:udp in their Pod Label. Note: The logical relationship between multiple Key-Value pairs is OR. Any Pod Label matching any Key-Value pair will be excluded from collection. When enabling the Pod Label denylist, Keys must not be duplicated. For fuzzy regular expression matching, you must add .. For example, ^(http.)$ matches any string starting with http
    includePodAnnotationRegexes List<GetRuleContainerRuleKubernetesRuleIncludePodAnnotationRegex>
    Pod Annotation Allowlist is used to specify containers to be collected. If you need to set a Pod Annotation Allowlist, Key is required and Value is optional. If Value is empty, all containers under Pods that contain the Key in Pod Annotation will match. If Value is not empty, only containers under Pods that contain the Key and whose value matches Value in Pod Annotation will match. Value defaults to string matching, meaning only when Value and the Pod Annotation value are exactly the same will they match. If the value starts with ^ and ends with $, it is a regex match. For example, set Key to app and Value to ^(test1|test2)$ to match containers under Pods with Pod Annotation app:test1 or app:test2. Note: The logical relationship between multiple Key-Value pairs is OR, meaning as long as Pod Annotation matches any pair, it will be included in the collection scope. When enabling Pod Annotation Allowlist, Keys must not be duplicated. For regex fuzzy matching, you must add .. For example, ^(http.)$ matches strings starting with http.
    includePodLabelRegexes List<GetRuleContainerRuleKubernetesRuleIncludePodLabelRegex>
    Pod Label Allowlist is used to specify which containers to collect. If Pod Label Allowlist is not enabled, all containers will be collected. If you need to set a Pod Label Allowlist, Key is required: if Value is empty, all containers with the Key in their Pod Label will be collected. If Value is not empty, only containers with the Key in their Pod Label and a Value matching the specified pattern will be collected; regular expression matching is supported. For example, if you set Key to module and Value to ^(tcp|udp)$, only containers with module:tcp or module:udp in their Pod Label will be collected. Note: The logical relationship between multiple key-value pairs is OR, meaning any Pod Label matching any key-value pair will be included in the collection scope. When enabling Pod Label Allowlist, Keys cannot be duplicated. For fuzzy regular expression matching, you must add ., for example, ^(http.)$ matches strings starting with http.
    labelTags List<GetRuleContainerRuleKubernetesRuleLabelTag>
    Whether to add Kubernetes labels as log tags to the raw log data. When enabled, the log service adds Kubernetes Pod label fields to the logs. Setting multiple key-value pairs adds multiple fields. For example, if you set Key to source and Value to data_source, and the Pod contains the label source=DC, the log will include the field tagdata_source_*: DC.
    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 GetRuleContainerRuleKubernetesRuleAnnotationTag[]
    Whether to add Kubernetes Annotations as log tags to the original log data. When enabled, the log service will add fields related to Kubernetes Pod Annotations to the logs. Setting multiple key-value pairs means adding multiple fields. For example, if you set Key to sink and Value to data_sink, and the Pod contains the annotation sink=ck, a new field tagdata_sink_*: ck will be added to the log.
    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 GetRuleContainerRuleKubernetesRuleExcludePodAnnotationRegex[]
    Pod Annotation Denylist is used to specify containers that are not collected. If you need to set a Pod Annotation Denylist, Key is required and Value is optional. If Value is empty, all containers under Pods whose Pod Annotation contains the specified Key are excluded. If Value is not empty, only containers under Pods whose Pod Annotation contains the Key and whose value matches the specified Value are excluded. By default, Value uses string matching, meaning it only matches when Value and the Pod Annotation value are exactly the same. If the value starts with ^ and ends with $, it is treated as a regular expression. For example, if Key is set to app and Value is set to ^(test1|test2)$, it matches containers under Pods with Pod Annotation app:test1 or app:test2. Note: The logical relationship between multiple Key-Value pairs is OR, meaning a Pod Annotation that matches any pair will be excluded from the collection scope. When enabling the Pod Annotation Denylist, Keys must not be duplicated. For regex fuzzy matching, you must add .. For example, ^(http.)$ matches strings starting with http
    excludePodLabelRegexes GetRuleContainerRuleKubernetesRuleExcludePodLabelRegex[]
    Specify containers to exclude from collection using the Pod Label denylist. If not enabled, all containers are collected. To set a Pod Label denylist, Key is required and Value is optional. If Value is empty, all containers with the specified Key in their Pod Label are excluded from collection. If Value is not empty, only containers with the specified Key and a Value matching the Value in their Pod Label are excluded. Value supports regular expressions. For example, set Key to module and Value to ^(tcp|udp)$ to exclude containers with module:tcp or module:udp in their Pod Label. Note: The logical relationship between multiple Key-Value pairs is OR. Any Pod Label matching any Key-Value pair will be excluded from collection. When enabling the Pod Label denylist, Keys must not be duplicated. For fuzzy regular expression matching, you must add .. For example, ^(http.)$ matches any string starting with http
    includePodAnnotationRegexes GetRuleContainerRuleKubernetesRuleIncludePodAnnotationRegex[]
    Pod Annotation Allowlist is used to specify containers to be collected. If you need to set a Pod Annotation Allowlist, Key is required and Value is optional. If Value is empty, all containers under Pods that contain the Key in Pod Annotation will match. If Value is not empty, only containers under Pods that contain the Key and whose value matches Value in Pod Annotation will match. Value defaults to string matching, meaning only when Value and the Pod Annotation value are exactly the same will they match. If the value starts with ^ and ends with $, it is a regex match. For example, set Key to app and Value to ^(test1|test2)$ to match containers under Pods with Pod Annotation app:test1 or app:test2. Note: The logical relationship between multiple Key-Value pairs is OR, meaning as long as Pod Annotation matches any pair, it will be included in the collection scope. When enabling Pod Annotation Allowlist, Keys must not be duplicated. For regex fuzzy matching, you must add .. For example, ^(http.)$ matches strings starting with http.
    includePodLabelRegexes GetRuleContainerRuleKubernetesRuleIncludePodLabelRegex[]
    Pod Label Allowlist is used to specify which containers to collect. If Pod Label Allowlist is not enabled, all containers will be collected. If you need to set a Pod Label Allowlist, Key is required: if Value is empty, all containers with the Key in their Pod Label will be collected. If Value is not empty, only containers with the Key in their Pod Label and a Value matching the specified pattern will be collected; regular expression matching is supported. For example, if you set Key to module and Value to ^(tcp|udp)$, only containers with module:tcp or module:udp in their Pod Label will be collected. Note: The logical relationship between multiple key-value pairs is OR, meaning any Pod Label matching any key-value pair will be included in the collection scope. When enabling Pod Label Allowlist, Keys cannot be duplicated. For fuzzy regular expression matching, you must add ., for example, ^(http.)$ matches strings starting with http.
    labelTags GetRuleContainerRuleKubernetesRuleLabelTag[]
    Whether to add Kubernetes labels as log tags to the raw log data. When enabled, the log service adds Kubernetes Pod label fields to the logs. Setting multiple key-value pairs adds multiple fields. For example, if you set Key to source and Value to data_source, and the Pod contains the label source=DC, the log will include the field tagdata_source_*: DC.
    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[GetRuleContainerRuleKubernetesRuleAnnotationTag]
    Whether to add Kubernetes Annotations as log tags to the original log data. When enabled, the log service will add fields related to Kubernetes Pod Annotations to the logs. Setting multiple key-value pairs means adding multiple fields. For example, if you set Key to sink and Value to data_sink, and the Pod contains the annotation sink=ck, a new field tagdata_sink_*: ck will be added to the log.
    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[GetRuleContainerRuleKubernetesRuleExcludePodAnnotationRegex]
    Pod Annotation Denylist is used to specify containers that are not collected. If you need to set a Pod Annotation Denylist, Key is required and Value is optional. If Value is empty, all containers under Pods whose Pod Annotation contains the specified Key are excluded. If Value is not empty, only containers under Pods whose Pod Annotation contains the Key and whose value matches the specified Value are excluded. By default, Value uses string matching, meaning it only matches when Value and the Pod Annotation value are exactly the same. If the value starts with ^ and ends with $, it is treated as a regular expression. For example, if Key is set to app and Value is set to ^(test1|test2)$, it matches containers under Pods with Pod Annotation app:test1 or app:test2. Note: The logical relationship between multiple Key-Value pairs is OR, meaning a Pod Annotation that matches any pair will be excluded from the collection scope. When enabling the Pod Annotation Denylist, Keys must not be duplicated. For regex fuzzy matching, you must add .. For example, ^(http.)$ matches strings starting with http
    exclude_pod_label_regexes Sequence[GetRuleContainerRuleKubernetesRuleExcludePodLabelRegex]
    Specify containers to exclude from collection using the Pod Label denylist. If not enabled, all containers are collected. To set a Pod Label denylist, Key is required and Value is optional. If Value is empty, all containers with the specified Key in their Pod Label are excluded from collection. If Value is not empty, only containers with the specified Key and a Value matching the Value in their Pod Label are excluded. Value supports regular expressions. For example, set Key to module and Value to ^(tcp|udp)$ to exclude containers with module:tcp or module:udp in their Pod Label. Note: The logical relationship between multiple Key-Value pairs is OR. Any Pod Label matching any Key-Value pair will be excluded from collection. When enabling the Pod Label denylist, Keys must not be duplicated. For fuzzy regular expression matching, you must add .. For example, ^(http.)$ matches any string starting with http
    include_pod_annotation_regexes Sequence[GetRuleContainerRuleKubernetesRuleIncludePodAnnotationRegex]
    Pod Annotation Allowlist is used to specify containers to be collected. If you need to set a Pod Annotation Allowlist, Key is required and Value is optional. If Value is empty, all containers under Pods that contain the Key in Pod Annotation will match. If Value is not empty, only containers under Pods that contain the Key and whose value matches Value in Pod Annotation will match. Value defaults to string matching, meaning only when Value and the Pod Annotation value are exactly the same will they match. If the value starts with ^ and ends with $, it is a regex match. For example, set Key to app and Value to ^(test1|test2)$ to match containers under Pods with Pod Annotation app:test1 or app:test2. Note: The logical relationship between multiple Key-Value pairs is OR, meaning as long as Pod Annotation matches any pair, it will be included in the collection scope. When enabling Pod Annotation Allowlist, Keys must not be duplicated. For regex fuzzy matching, you must add .. For example, ^(http.)$ matches strings starting with http.
    include_pod_label_regexes Sequence[GetRuleContainerRuleKubernetesRuleIncludePodLabelRegex]
    Pod Label Allowlist is used to specify which containers to collect. If Pod Label Allowlist is not enabled, all containers will be collected. If you need to set a Pod Label Allowlist, Key is required: if Value is empty, all containers with the Key in their Pod Label will be collected. If Value is not empty, only containers with the Key in their Pod Label and a Value matching the specified pattern will be collected; regular expression matching is supported. For example, if you set Key to module and Value to ^(tcp|udp)$, only containers with module:tcp or module:udp in their Pod Label will be collected. Note: The logical relationship between multiple key-value pairs is OR, meaning any Pod Label matching any key-value pair will be included in the collection scope. When enabling Pod Label Allowlist, Keys cannot be duplicated. For fuzzy regular expression matching, you must add ., for example, ^(http.)$ matches strings starting with http.
    label_tags Sequence[GetRuleContainerRuleKubernetesRuleLabelTag]
    Whether to add Kubernetes labels as log tags to the raw log data. When enabled, the log service adds Kubernetes Pod label fields to the logs. Setting multiple key-value pairs adds multiple fields. For example, if you set Key to source and Value to data_source, and the Pod contains the label source=DC, the log will include the field tagdata_source_*: DC.
    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>
    Whether to add Kubernetes Annotations as log tags to the original log data. When enabled, the log service will add fields related to Kubernetes Pod Annotations to the logs. Setting multiple key-value pairs means adding multiple fields. For example, if you set Key to sink and Value to data_sink, and the Pod contains the annotation sink=ck, a new field tagdata_sink_*: ck will be added to the log.
    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>
    Pod Annotation Denylist is used to specify containers that are not collected. If you need to set a Pod Annotation Denylist, Key is required and Value is optional. If Value is empty, all containers under Pods whose Pod Annotation contains the specified Key are excluded. If Value is not empty, only containers under Pods whose Pod Annotation contains the Key and whose value matches the specified Value are excluded. By default, Value uses string matching, meaning it only matches when Value and the Pod Annotation value are exactly the same. If the value starts with ^ and ends with $, it is treated as a regular expression. For example, if Key is set to app and Value is set to ^(test1|test2)$, it matches containers under Pods with Pod Annotation app:test1 or app:test2. Note: The logical relationship between multiple Key-Value pairs is OR, meaning a Pod Annotation that matches any pair will be excluded from the collection scope. When enabling the Pod Annotation Denylist, Keys must not be duplicated. For regex fuzzy matching, you must add .. For example, ^(http.)$ matches strings starting with http
    excludePodLabelRegexes List<Property Map>
    Specify containers to exclude from collection using the Pod Label denylist. If not enabled, all containers are collected. To set a Pod Label denylist, Key is required and Value is optional. If Value is empty, all containers with the specified Key in their Pod Label are excluded from collection. If Value is not empty, only containers with the specified Key and a Value matching the Value in their Pod Label are excluded. Value supports regular expressions. For example, set Key to module and Value to ^(tcp|udp)$ to exclude containers with module:tcp or module:udp in their Pod Label. Note: The logical relationship between multiple Key-Value pairs is OR. Any Pod Label matching any Key-Value pair will be excluded from collection. When enabling the Pod Label denylist, Keys must not be duplicated. For fuzzy regular expression matching, you must add .. For example, ^(http.)$ matches any string starting with http
    includePodAnnotationRegexes List<Property Map>
    Pod Annotation Allowlist is used to specify containers to be collected. If you need to set a Pod Annotation Allowlist, Key is required and Value is optional. If Value is empty, all containers under Pods that contain the Key in Pod Annotation will match. If Value is not empty, only containers under Pods that contain the Key and whose value matches Value in Pod Annotation will match. Value defaults to string matching, meaning only when Value and the Pod Annotation value are exactly the same will they match. If the value starts with ^ and ends with $, it is a regex match. For example, set Key to app and Value to ^(test1|test2)$ to match containers under Pods with Pod Annotation app:test1 or app:test2. Note: The logical relationship between multiple Key-Value pairs is OR, meaning as long as Pod Annotation matches any pair, it will be included in the collection scope. When enabling Pod Annotation Allowlist, Keys must not be duplicated. For regex fuzzy matching, you must add .. For example, ^(http.)$ matches strings starting with http.
    includePodLabelRegexes List<Property Map>
    Pod Label Allowlist is used to specify which containers to collect. If Pod Label Allowlist is not enabled, all containers will be collected. If you need to set a Pod Label Allowlist, Key is required: if Value is empty, all containers with the Key in their Pod Label will be collected. If Value is not empty, only containers with the Key in their Pod Label and a Value matching the specified pattern will be collected; regular expression matching is supported. For example, if you set Key to module and Value to ^(tcp|udp)$, only containers with module:tcp or module:udp in their Pod Label will be collected. Note: The logical relationship between multiple key-value pairs is OR, meaning any Pod Label matching any key-value pair will be included in the collection scope. When enabling Pod Label Allowlist, Keys cannot be duplicated. For fuzzy regular expression matching, you must add ., for example, ^(http.)$ matches strings starting with http.
    labelTags List<Property Map>
    Whether to add Kubernetes labels as log tags to the raw log data. When enabled, the log service adds Kubernetes Pod label fields to the logs. Setting multiple key-value pairs adds multiple fields. For example, if you set Key to source and Value to data_source, and the Pod contains the label source=DC, the log will include the field tagdata_source_*: DC.
    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

    GetRuleContainerRuleKubernetesRuleAnnotationTag

    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.

    GetRuleContainerRuleKubernetesRuleExcludePodAnnotationRegex

    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.

    GetRuleContainerRuleKubernetesRuleExcludePodLabelRegex

    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.

    GetRuleContainerRuleKubernetesRuleIncludePodAnnotationRegex

    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.

    GetRuleContainerRuleKubernetesRuleIncludePodLabelRegex

    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.

    GetRuleContainerRuleKubernetesRuleLabelTag

    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.

    GetRuleExcludePath

    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.

    GetRuleExtractRule

    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.GetRuleExtractRuleFilterKeyRegex>
    Filter rule list. When LogType is minimalistlog or multilinelog, you can configure up to 1 filter rule, and the filter field name key must be content. When LogType is delimiterlog, jsonlog, or fullregex*log, you can configure up to 5 filter rules, and the filter field name key cannot be duplicated or empty. The regular expression for the filter field's log content must be a valid regular expression and is limited to 256 characters.
    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.GetRuleExtractRuleLogTemplate
    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 []GetRuleExtractRuleFilterKeyRegex
    Filter rule list. When LogType is minimalistlog or multilinelog, you can configure up to 1 filter rule, and the filter field name key must be content. When LogType is delimiterlog, jsonlog, or fullregex*log, you can configure up to 5 filter rules, and the filter field name key cannot be duplicated or empty. The regular expression for the filter field's log content must be a valid regular expression and is limited to 256 characters.
    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 GetRuleExtractRuleLogTemplate
    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<GetRuleExtractRuleFilterKeyRegex>
    Filter rule list. When LogType is minimalistlog or multilinelog, you can configure up to 1 filter rule, and the filter field name key must be content. When LogType is delimiterlog, jsonlog, or fullregex*log, you can configure up to 5 filter rules, and the filter field name key cannot be duplicated or empty. The regular expression for the filter field's log content must be a valid regular expression and is limited to 256 characters.
    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 GetRuleExtractRuleLogTemplate
    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 GetRuleExtractRuleFilterKeyRegex[]
    Filter rule list. When LogType is minimalistlog or multilinelog, you can configure up to 1 filter rule, and the filter field name key must be content. When LogType is delimiterlog, jsonlog, or fullregex*log, you can configure up to 5 filter rules, and the filter field name key cannot be duplicated or empty. The regular expression for the filter field's log content must be a valid regular expression and is limited to 256 characters.
    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 GetRuleExtractRuleLogTemplate
    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[GetRuleExtractRuleFilterKeyRegex]
    Filter rule list. When LogType is minimalistlog or multilinelog, you can configure up to 1 filter rule, and the filter field name key must be content. When LogType is delimiterlog, jsonlog, or fullregex*log, you can configure up to 5 filter rules, and the filter field name key cannot be duplicated or empty. The regular expression for the filter field's log content must be a valid regular expression and is limited to 256 characters.
    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 GetRuleExtractRuleLogTemplate
    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>
    Filter rule list. When LogType is minimalistlog or multilinelog, you can configure up to 1 filter rule, and the filter field name key must be content. When LogType is delimiterlog, jsonlog, or fullregex*log, you can configure up to 5 filter rules, and the filter field name key cannot be duplicated or empty. The regular expression for the filter field's log content must be a valid regular expression and is limited to 256 characters.
    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.

    GetRuleExtractRuleFilterKeyRegex

    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.

    GetRuleExtractRuleLogTemplate

    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.

    GetRuleHostGroupInfo

    AbnormalHeartbeatStatusCount int
    Number of hosts with heartbeat exceptions.
    AgentLatestVersion string
    Latest agent version.
    AutoUpdate bool
    Whether LogCollector installed on the machine group server has automatic upgrade enabled. true: The log service will check for upgrades during a specified time period each day. If upgrade conditions are met, LogCollector will be upgraded automatically without manual intervention. false (default): LogCollector does not upgrade automatically. To use a newer version of LogCollector, refer to the LogCollector upgrade procedure.
    CreateTime string
    Machine group creation time.
    HostCount int
    Number of hosts.
    HostGroupId string
    Machine group ID
    HostGroupName string
    Name of the machine group.
    HostGroupType string
    Machine group type. IP: Machine IP. Label: Machine label.
    HostIdentifier string
    Machine identifier.
    IamProjectName string
    The IAM project to which the host group belongs.
    ModifyTime string
    Time when the machine group was modified.
    NormalHeartbeatStatusCount int
    Number of hosts with normal heartbeat.
    RuleCount int
    The number of bound collection configurations.
    ServiceLogging bool
    Whether to enable the Logcollector service log feature. true: enabled. false (default): disabled.
    UpdateEndTime string
    End time for LogCollector automatic upgrade.
    UpdateStartTime string
    LogCollector auto-update start time. Note: Only required when AutoUpdate is set to true. It is recommended to schedule auto-updates during off-peak hours. LogCollector may restart during the update process, but logs will not be lost.
    AbnormalHeartbeatStatusCount int
    Number of hosts with heartbeat exceptions.
    AgentLatestVersion string
    Latest agent version.
    AutoUpdate bool
    Whether LogCollector installed on the machine group server has automatic upgrade enabled. true: The log service will check for upgrades during a specified time period each day. If upgrade conditions are met, LogCollector will be upgraded automatically without manual intervention. false (default): LogCollector does not upgrade automatically. To use a newer version of LogCollector, refer to the LogCollector upgrade procedure.
    CreateTime string
    Machine group creation time.
    HostCount int
    Number of hosts.
    HostGroupId string
    Machine group ID
    HostGroupName string
    Name of the machine group.
    HostGroupType string
    Machine group type. IP: Machine IP. Label: Machine label.
    HostIdentifier string
    Machine identifier.
    IamProjectName string
    The IAM project to which the host group belongs.
    ModifyTime string
    Time when the machine group was modified.
    NormalHeartbeatStatusCount int
    Number of hosts with normal heartbeat.
    RuleCount int
    The number of bound collection configurations.
    ServiceLogging bool
    Whether to enable the Logcollector service log feature. true: enabled. false (default): disabled.
    UpdateEndTime string
    End time for LogCollector automatic upgrade.
    UpdateStartTime string
    LogCollector auto-update start time. Note: Only required when AutoUpdate is set to true. It is recommended to schedule auto-updates during off-peak hours. LogCollector may restart during the update process, but logs will not be lost.
    abnormalHeartbeatStatusCount Integer
    Number of hosts with heartbeat exceptions.
    agentLatestVersion String
    Latest agent version.
    autoUpdate Boolean
    Whether LogCollector installed on the machine group server has automatic upgrade enabled. true: The log service will check for upgrades during a specified time period each day. If upgrade conditions are met, LogCollector will be upgraded automatically without manual intervention. false (default): LogCollector does not upgrade automatically. To use a newer version of LogCollector, refer to the LogCollector upgrade procedure.
    createTime String
    Machine group creation time.
    hostCount Integer
    Number of hosts.
    hostGroupId String
    Machine group ID
    hostGroupName String
    Name of the machine group.
    hostGroupType String
    Machine group type. IP: Machine IP. Label: Machine label.
    hostIdentifier String
    Machine identifier.
    iamProjectName String
    The IAM project to which the host group belongs.
    modifyTime String
    Time when the machine group was modified.
    normalHeartbeatStatusCount Integer
    Number of hosts with normal heartbeat.
    ruleCount Integer
    The number of bound collection configurations.
    serviceLogging Boolean
    Whether to enable the Logcollector service log feature. true: enabled. false (default): disabled.
    updateEndTime String
    End time for LogCollector automatic upgrade.
    updateStartTime String
    LogCollector auto-update start time. Note: Only required when AutoUpdate is set to true. It is recommended to schedule auto-updates during off-peak hours. LogCollector may restart during the update process, but logs will not be lost.
    abnormalHeartbeatStatusCount number
    Number of hosts with heartbeat exceptions.
    agentLatestVersion string
    Latest agent version.
    autoUpdate boolean
    Whether LogCollector installed on the machine group server has automatic upgrade enabled. true: The log service will check for upgrades during a specified time period each day. If upgrade conditions are met, LogCollector will be upgraded automatically without manual intervention. false (default): LogCollector does not upgrade automatically. To use a newer version of LogCollector, refer to the LogCollector upgrade procedure.
    createTime string
    Machine group creation time.
    hostCount number
    Number of hosts.
    hostGroupId string
    Machine group ID
    hostGroupName string
    Name of the machine group.
    hostGroupType string
    Machine group type. IP: Machine IP. Label: Machine label.
    hostIdentifier string
    Machine identifier.
    iamProjectName string
    The IAM project to which the host group belongs.
    modifyTime string
    Time when the machine group was modified.
    normalHeartbeatStatusCount number
    Number of hosts with normal heartbeat.
    ruleCount number
    The number of bound collection configurations.
    serviceLogging boolean
    Whether to enable the Logcollector service log feature. true: enabled. false (default): disabled.
    updateEndTime string
    End time for LogCollector automatic upgrade.
    updateStartTime string
    LogCollector auto-update start time. Note: Only required when AutoUpdate is set to true. It is recommended to schedule auto-updates during off-peak hours. LogCollector may restart during the update process, but logs will not be lost.
    abnormal_heartbeat_status_count int
    Number of hosts with heartbeat exceptions.
    agent_latest_version str
    Latest agent version.
    auto_update bool
    Whether LogCollector installed on the machine group server has automatic upgrade enabled. true: The log service will check for upgrades during a specified time period each day. If upgrade conditions are met, LogCollector will be upgraded automatically without manual intervention. false (default): LogCollector does not upgrade automatically. To use a newer version of LogCollector, refer to the LogCollector upgrade procedure.
    create_time str
    Machine group creation time.
    host_count int
    Number of hosts.
    host_group_id str
    Machine group ID
    host_group_name str
    Name of the machine group.
    host_group_type str
    Machine group type. IP: Machine IP. Label: Machine label.
    host_identifier str
    Machine identifier.
    iam_project_name str
    The IAM project to which the host group belongs.
    modify_time str
    Time when the machine group was modified.
    normal_heartbeat_status_count int
    Number of hosts with normal heartbeat.
    rule_count int
    The number of bound collection configurations.
    service_logging bool
    Whether to enable the Logcollector service log feature. true: enabled. false (default): disabled.
    update_end_time str
    End time for LogCollector automatic upgrade.
    update_start_time str
    LogCollector auto-update start time. Note: Only required when AutoUpdate is set to true. It is recommended to schedule auto-updates during off-peak hours. LogCollector may restart during the update process, but logs will not be lost.
    abnormalHeartbeatStatusCount Number
    Number of hosts with heartbeat exceptions.
    agentLatestVersion String
    Latest agent version.
    autoUpdate Boolean
    Whether LogCollector installed on the machine group server has automatic upgrade enabled. true: The log service will check for upgrades during a specified time period each day. If upgrade conditions are met, LogCollector will be upgraded automatically without manual intervention. false (default): LogCollector does not upgrade automatically. To use a newer version of LogCollector, refer to the LogCollector upgrade procedure.
    createTime String
    Machine group creation time.
    hostCount Number
    Number of hosts.
    hostGroupId String
    Machine group ID
    hostGroupName String
    Name of the machine group.
    hostGroupType String
    Machine group type. IP: Machine IP. Label: Machine label.
    hostIdentifier String
    Machine identifier.
    iamProjectName String
    The IAM project to which the host group belongs.
    modifyTime String
    Time when the machine group was modified.
    normalHeartbeatStatusCount Number
    Number of hosts with normal heartbeat.
    ruleCount Number
    The number of bound collection configurations.
    serviceLogging Boolean
    Whether to enable the Logcollector service log feature. true: enabled. false (default): disabled.
    updateEndTime String
    End time for LogCollector automatic upgrade.
    updateStartTime String
    LogCollector auto-update start time. Note: Only required when AutoUpdate is set to true. It is recommended to schedule auto-updates during off-peak hours. LogCollector may restart during the update process, but logs will not be lost.

    GetRuleUserDefineRule

    Advanced Volcengine.GetRuleUserDefineRuleAdvanced
    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.GetRuleUserDefineRuleField>
    Add constant fields to logs. Constant fields must follow these restrictions: You can upload up to 5 constant fields. Field names (Key) must be unique and not empty. Length limit: 1–128 characters, including letters, numbers, and special characters (-*./), and cannot start with an underscore. Field values (Value) must not be empty, with a maximum length of 512 KiB.
    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.GetRuleUserDefineRuleParsePathRule
    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.GetRuleUserDefineRulePlugin
    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.GetRuleUserDefineRuleShardHashKey
    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 GetRuleUserDefineRuleAdvanced
    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 []GetRuleUserDefineRuleField
    Add constant fields to logs. Constant fields must follow these restrictions: You can upload up to 5 constant fields. Field names (Key) must be unique and not empty. Length limit: 1–128 characters, including letters, numbers, and special characters (-*./), and cannot start with an underscore. Field values (Value) must not be empty, with a maximum length of 512 KiB.
    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 GetRuleUserDefineRuleParsePathRule
    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 GetRuleUserDefineRulePlugin
    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 GetRuleUserDefineRuleShardHashKey
    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 GetRuleUserDefineRuleAdvanced
    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<GetRuleUserDefineRuleField>
    Add constant fields to logs. Constant fields must follow these restrictions: You can upload up to 5 constant fields. Field names (Key) must be unique and not empty. Length limit: 1–128 characters, including letters, numbers, and special characters (-*./), and cannot start with an underscore. Field values (Value) must not be empty, with a maximum length of 512 KiB.
    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 GetRuleUserDefineRuleParsePathRule
    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 GetRuleUserDefineRulePlugin
    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 GetRuleUserDefineRuleShardHashKey
    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 GetRuleUserDefineRuleAdvanced
    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 GetRuleUserDefineRuleField[]
    Add constant fields to logs. Constant fields must follow these restrictions: You can upload up to 5 constant fields. Field names (Key) must be unique and not empty. Length limit: 1–128 characters, including letters, numbers, and special characters (-*./), and cannot start with an underscore. Field values (Value) must not be empty, with a maximum length of 512 KiB.
    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 GetRuleUserDefineRuleParsePathRule
    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 GetRuleUserDefineRulePlugin
    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 GetRuleUserDefineRuleShardHashKey
    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 GetRuleUserDefineRuleAdvanced
    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[GetRuleUserDefineRuleField]
    Add constant fields to logs. Constant fields must follow these restrictions: You can upload up to 5 constant fields. Field names (Key) must be unique and not empty. Length limit: 1–128 characters, including letters, numbers, and special characters (-*./), and cannot start with an underscore. Field values (Value) must not be empty, with a maximum length of 512 KiB.
    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 GetRuleUserDefineRuleParsePathRule
    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 GetRuleUserDefineRulePlugin
    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 GetRuleUserDefineRuleShardHashKey
    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>
    Add constant fields to logs. Constant fields must follow these restrictions: You can upload up to 5 constant fields. Field names (Key) must be unique and not empty. Length limit: 1–128 characters, including letters, numbers, and special characters (-*./), and cannot start with an underscore. Field values (Value) must not be empty, with a maximum length of 512 KiB.
    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.

    GetRuleUserDefineRuleAdvanced

    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.

    GetRuleUserDefineRuleField

    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.

    GetRuleUserDefineRuleParsePathRule

    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

    GetRuleUserDefineRulePlugin

    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.

    GetRuleUserDefineRuleShardHashKey

    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).

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.32
    published on Thursday, Apr 23, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc
      Try Pulumi Cloud free. Your team will thank you.