volcenginecc.tls.getHostGroup

volcenginecc v0.0.50, Jul 20 26

Viewing docs for volcenginecc v0.0.50
published on Monday, Jul 20, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.50
published on Monday, Jul 20, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Using getHostGroup

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 getHostGroup(args: GetHostGroupArgs, opts?: InvokeOptions): Promise<GetHostGroupResult>
function getHostGroupOutput(args: GetHostGroupOutputArgs, opts?: InvokeOptions): Output<GetHostGroupResult>

def get_host_group(id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetHostGroupResult
def get_host_group_output(id: pulumi.Input[Optional[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetHostGroupResult]

func LookupHostGroup(ctx *Context, args *LookupHostGroupArgs, opts ...InvokeOption) (*LookupHostGroupResult, error)
func LookupHostGroupOutput(ctx *Context, args *LookupHostGroupOutputArgs, opts ...InvokeOption) LookupHostGroupResultOutput

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

public static class GetHostGroup 
{
    public static Task<GetHostGroupResult> InvokeAsync(GetHostGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetHostGroupResult> Invoke(GetHostGroupInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetHostGroupResult> getHostGroup(GetHostGroupArgs args, InvokeOptions options)
public static Output<GetHostGroupResult> getHostGroup(GetHostGroupArgs args, InvokeOptions options)

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

data "volcenginecc_tls_get_host_group" "name" {
    # arguments
}

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 string: Uniquely identifies the resource.

id str: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

getHostGroup Result

The following output properties are available:

AbnormalHeartbeatStatusNumber int: Number of abnormal machines.
AgentLatestVersion string: Latest agent version.
AutoUpdate bool: Whether LogCollector installed on machine group servers enables automatic upgrade. true: Log Service will check for upgrade conditions during the specified time period each day. If conditions are met, LogCollector upgrades automatically without manual intervention. false: (default) LogCollector does not upgrade automatically. Only LogCollector V1.0.8 and later versions support automatic upgrade.
CreateTime string: Creation time.
DeleteAbnormalHosts bool: Clean all machines with abnormal heartbeat in the machine group with one click. Machines without heartbeat records cannot be deleted currently
HostCount int: Number of machines.
HostGroupId string: Host group ID
HostGroupName string: Host group name
HostGroupType string: Type of machine group. Includes: IP: machine IP. Set the machine IP list using the HostIpList parameter. Label: machine identifier. Set the machine identifier using the HostIdentifier parameter.
HostIdentifier string: Machine identifier. Required when HostGroupType is Label.
HostIpLists List<string>: List of IP addresses for the host group. Required when HostGroupType is IP.
IamProjectName string: IAM project name. If this parameter is not specified, Log Service adds the machine group to the IAM project named default.
Id string: Uniquely identifies the resource.
ModifyTime string: Modification time.
NormalHeartbeatStatusNumber int: Number of healthy machines.
RuleCount int: Number of rules
Rules List<Volcengine.GetHostGroupRule>: Collection configuration information list.
ServiceLogging bool: Enable Logcollector service log feature. true: enabled. false: (default) disabled.
UpdateEndTime string: Auto upgrade end time in HH:MM format. Required only when AutoUpdate is set to true. It is recommended to schedule auto upgrade during off-peak business hours. LogCollector may restart during the auto upgrade, but logs will not be lost.
UpdateStartTime string: Automatic upgrade start time, in HH:MM format. Only required when AutoUpdate is set to true. It is recommended to schedule automatic upgrades during off-peak hours. LogCollector may restart during the upgrade, but logs will not be lost.

AbnormalHeartbeatStatusNumber int: Number of abnormal machines.
AgentLatestVersion string: Latest agent version.
AutoUpdate bool: Whether LogCollector installed on machine group servers enables automatic upgrade. true: Log Service will check for upgrade conditions during the specified time period each day. If conditions are met, LogCollector upgrades automatically without manual intervention. false: (default) LogCollector does not upgrade automatically. Only LogCollector V1.0.8 and later versions support automatic upgrade.
CreateTime string: Creation time.
DeleteAbnormalHosts bool: Clean all machines with abnormal heartbeat in the machine group with one click. Machines without heartbeat records cannot be deleted currently
HostCount int: Number of machines.
HostGroupId string: Host group ID
HostGroupName string: Host group name
HostGroupType string: Type of machine group. Includes: IP: machine IP. Set the machine IP list using the HostIpList parameter. Label: machine identifier. Set the machine identifier using the HostIdentifier parameter.
HostIdentifier string: Machine identifier. Required when HostGroupType is Label.
HostIpLists []string: List of IP addresses for the host group. Required when HostGroupType is IP.
IamProjectName string: IAM project name. If this parameter is not specified, Log Service adds the machine group to the IAM project named default.
Id string: Uniquely identifies the resource.
ModifyTime string: Modification time.
NormalHeartbeatStatusNumber int: Number of healthy machines.
RuleCount int: Number of rules
Rules []GetHostGroupRule: Collection configuration information list.
ServiceLogging bool: Enable Logcollector service log feature. true: enabled. false: (default) disabled.
UpdateEndTime string: Auto upgrade end time in HH:MM format. Required only when AutoUpdate is set to true. It is recommended to schedule auto upgrade during off-peak business hours. LogCollector may restart during the auto upgrade, but logs will not be lost.
UpdateStartTime string: Automatic upgrade start time, in HH:MM format. Only required when AutoUpdate is set to true. It is recommended to schedule automatic upgrades during off-peak hours. LogCollector may restart during the upgrade, but logs will not be lost.

abnormal_heartbeat_status_number number: Number of abnormal machines.
agent_latest_version string: Latest agent version.
auto_update bool: Whether LogCollector installed on machine group servers enables automatic upgrade. true: Log Service will check for upgrade conditions during the specified time period each day. If conditions are met, LogCollector upgrades automatically without manual intervention. false: (default) LogCollector does not upgrade automatically. Only LogCollector V1.0.8 and later versions support automatic upgrade.
create_time string: Creation time.
delete_abnormal_hosts bool: Clean all machines with abnormal heartbeat in the machine group with one click. Machines without heartbeat records cannot be deleted currently
host_count number: Number of machines.
host_group_id string: Host group ID
host_group_name string: Host group name
host_group_type string: Type of machine group. Includes: IP: machine IP. Set the machine IP list using the HostIpList parameter. Label: machine identifier. Set the machine identifier using the HostIdentifier parameter.
host_identifier string: Machine identifier. Required when HostGroupType is Label.
host_ip_lists list(string): List of IP addresses for the host group. Required when HostGroupType is IP.
iam_project_name string: IAM project name. If this parameter is not specified, Log Service adds the machine group to the IAM project named default.
id string: Uniquely identifies the resource.
modify_time string: Modification time.
normal_heartbeat_status_number number: Number of healthy machines.
rule_count number: Number of rules
rules list(object): Collection configuration information list.
service_logging bool: Enable Logcollector service log feature. true: enabled. false: (default) disabled.
update_end_time string: Auto upgrade end time in HH:MM format. Required only when AutoUpdate is set to true. It is recommended to schedule auto upgrade during off-peak business hours. LogCollector may restart during the auto upgrade, but logs will not be lost.
update_start_time string: Automatic upgrade start time, in HH:MM format. Only required when AutoUpdate is set to true. It is recommended to schedule automatic upgrades during off-peak hours. LogCollector may restart during the upgrade, but logs will not be lost.

abnormalHeartbeatStatusNumber Integer: Number of abnormal machines.
agentLatestVersion String: Latest agent version.
autoUpdate Boolean: Whether LogCollector installed on machine group servers enables automatic upgrade. true: Log Service will check for upgrade conditions during the specified time period each day. If conditions are met, LogCollector upgrades automatically without manual intervention. false: (default) LogCollector does not upgrade automatically. Only LogCollector V1.0.8 and later versions support automatic upgrade.
createTime String: Creation time.
deleteAbnormalHosts Boolean: Clean all machines with abnormal heartbeat in the machine group with one click. Machines without heartbeat records cannot be deleted currently
hostCount Integer: Number of machines.
hostGroupId String: Host group ID
hostGroupName String: Host group name
hostGroupType String: Type of machine group. Includes: IP: machine IP. Set the machine IP list using the HostIpList parameter. Label: machine identifier. Set the machine identifier using the HostIdentifier parameter.
hostIdentifier String: Machine identifier. Required when HostGroupType is Label.
hostIpLists List<String>: List of IP addresses for the host group. Required when HostGroupType is IP.
iamProjectName String: IAM project name. If this parameter is not specified, Log Service adds the machine group to the IAM project named default.
id String: Uniquely identifies the resource.
modifyTime String: Modification time.
normalHeartbeatStatusNumber Integer: Number of healthy machines.
ruleCount Integer: Number of rules
rules List<GetHostGroupRule>: Collection configuration information list.
serviceLogging Boolean: Enable Logcollector service log feature. true: enabled. false: (default) disabled.
updateEndTime String: Auto upgrade end time in HH:MM format. Required only when AutoUpdate is set to true. It is recommended to schedule auto upgrade during off-peak business hours. LogCollector may restart during the auto upgrade, but logs will not be lost.
updateStartTime String: Automatic upgrade start time, in HH:MM format. Only required when AutoUpdate is set to true. It is recommended to schedule automatic upgrades during off-peak hours. LogCollector may restart during the upgrade, but logs will not be lost.

abnormalHeartbeatStatusNumber number: Number of abnormal machines.
agentLatestVersion string: Latest agent version.
autoUpdate boolean: Whether LogCollector installed on machine group servers enables automatic upgrade. true: Log Service will check for upgrade conditions during the specified time period each day. If conditions are met, LogCollector upgrades automatically without manual intervention. false: (default) LogCollector does not upgrade automatically. Only LogCollector V1.0.8 and later versions support automatic upgrade.
createTime string: Creation time.
deleteAbnormalHosts boolean: Clean all machines with abnormal heartbeat in the machine group with one click. Machines without heartbeat records cannot be deleted currently
hostCount number: Number of machines.
hostGroupId string: Host group ID
hostGroupName string: Host group name
hostGroupType string: Type of machine group. Includes: IP: machine IP. Set the machine IP list using the HostIpList parameter. Label: machine identifier. Set the machine identifier using the HostIdentifier parameter.
hostIdentifier string: Machine identifier. Required when HostGroupType is Label.
hostIpLists string[]: List of IP addresses for the host group. Required when HostGroupType is IP.
iamProjectName string: IAM project name. If this parameter is not specified, Log Service adds the machine group to the IAM project named default.
id string: Uniquely identifies the resource.
modifyTime string: Modification time.
normalHeartbeatStatusNumber number: Number of healthy machines.
ruleCount number: Number of rules
rules GetHostGroupRule[]: Collection configuration information list.
serviceLogging boolean: Enable Logcollector service log feature. true: enabled. false: (default) disabled.
updateEndTime string: Auto upgrade end time in HH:MM format. Required only when AutoUpdate is set to true. It is recommended to schedule auto upgrade during off-peak business hours. LogCollector may restart during the auto upgrade, but logs will not be lost.
updateStartTime string: Automatic upgrade start time, in HH:MM format. Only required when AutoUpdate is set to true. It is recommended to schedule automatic upgrades during off-peak hours. LogCollector may restart during the upgrade, but logs will not be lost.

abnormal_heartbeat_status_number int: Number of abnormal machines.
agent_latest_version str: Latest agent version.
auto_update bool: Whether LogCollector installed on machine group servers enables automatic upgrade. true: Log Service will check for upgrade conditions during the specified time period each day. If conditions are met, LogCollector upgrades automatically without manual intervention. false: (default) LogCollector does not upgrade automatically. Only LogCollector V1.0.8 and later versions support automatic upgrade.
create_time str: Creation time.
delete_abnormal_hosts bool: Clean all machines with abnormal heartbeat in the machine group with one click. Machines without heartbeat records cannot be deleted currently
host_count int: Number of machines.
host_group_id str: Host group ID
host_group_name str: Host group name
host_group_type str: Type of machine group. Includes: IP: machine IP. Set the machine IP list using the HostIpList parameter. Label: machine identifier. Set the machine identifier using the HostIdentifier parameter.
host_identifier str: Machine identifier. Required when HostGroupType is Label.
host_ip_lists Sequence[str]: List of IP addresses for the host group. Required when HostGroupType is IP.
iam_project_name str: IAM project name. If this parameter is not specified, Log Service adds the machine group to the IAM project named default.
id str: Uniquely identifies the resource.
modify_time str: Modification time.
normal_heartbeat_status_number int: Number of healthy machines.
rule_count int: Number of rules
rules Sequence[GetHostGroupRule]: Collection configuration information list.
service_logging bool: Enable Logcollector service log feature. true: enabled. false: (default) disabled.
update_end_time str: Auto upgrade end time in HH:MM format. Required only when AutoUpdate is set to true. It is recommended to schedule auto upgrade during off-peak business hours. LogCollector may restart during the auto upgrade, but logs will not be lost.
update_start_time str: Automatic upgrade start time, in HH:MM format. Only required when AutoUpdate is set to true. It is recommended to schedule automatic upgrades during off-peak hours. LogCollector may restart during the upgrade, but logs will not be lost.

abnormalHeartbeatStatusNumber Number: Number of abnormal machines.
agentLatestVersion String: Latest agent version.
autoUpdate Boolean: Whether LogCollector installed on machine group servers enables automatic upgrade. true: Log Service will check for upgrade conditions during the specified time period each day. If conditions are met, LogCollector upgrades automatically without manual intervention. false: (default) LogCollector does not upgrade automatically. Only LogCollector V1.0.8 and later versions support automatic upgrade.
createTime String: Creation time.
deleteAbnormalHosts Boolean: Clean all machines with abnormal heartbeat in the machine group with one click. Machines without heartbeat records cannot be deleted currently
hostCount Number: Number of machines.
hostGroupId String: Host group ID
hostGroupName String: Host group name
hostGroupType String: Type of machine group. Includes: IP: machine IP. Set the machine IP list using the HostIpList parameter. Label: machine identifier. Set the machine identifier using the HostIdentifier parameter.
hostIdentifier String: Machine identifier. Required when HostGroupType is Label.
hostIpLists List<String>: List of IP addresses for the host group. Required when HostGroupType is IP.
iamProjectName String: IAM project name. If this parameter is not specified, Log Service adds the machine group to the IAM project named default.
id String: Uniquely identifies the resource.
modifyTime String: Modification time.
normalHeartbeatStatusNumber Number: Number of healthy machines.
ruleCount Number: Number of rules
rules List<Property Map>: Collection configuration information list.
serviceLogging Boolean: Enable Logcollector service log feature. true: enabled. false: (default) disabled.
updateEndTime String: Auto upgrade end time in HH:MM format. Required only when AutoUpdate is set to true. It is recommended to schedule auto upgrade during off-peak business hours. LogCollector may restart during the auto upgrade, but logs will not be lost.
updateStartTime String: Automatic upgrade start time, in HH:MM format. Only required when AutoUpdate is set to true. It is recommended to schedule automatic upgrades during off-peak hours. LogCollector may restart during the upgrade, but logs will not be lost.

Supporting Types

GetHostGroupRule

ContainerRule Volcengine.GetHostGroupRuleContainerRule: Container collection rules
CreateTime string: Time when the collection configuration was created.
ExcludePaths List<Volcengine.GetHostGroupRuleExcludePath>: Extraction rule list.
ExtractRule Volcengine.GetHostGroupRuleExtractRule: Extraction rules
InputType int: Collection type. 0: Host log file. 1: K8s container standard output. 2: Log file inside K8s container.
LogSample string: Log sample.
LogType string: Collection modes. minimalistlog: single-line full mode. jsonlog: JSON mode. delimiterlog: delimiter mode. multilinelog: multi-line full mode. fullregex_log: full regex mode.
ModifyTime string: Time when the collection configuration was modified.
Paths List<string>: Data collection path list
Pause int: Running status of the collection configuration. 0: Running. 1: Paused.
RuleId string: Collection configuration ID.
RuleName string: Name of the collection configuration.
TopicId string: ID of the log topic to which the collection configuration belongs.
TopicName string: Name of the log topic associated with the collection configuration
UserDefineRule Volcengine.GetHostGroupRuleUserDefineRule: User-defined collection rules.

ContainerRule GetHostGroupRuleContainerRule: Container collection rules
CreateTime string: Time when the collection configuration was created.
ExcludePaths []GetHostGroupRuleExcludePath: Extraction rule list.
ExtractRule GetHostGroupRuleExtractRule: Extraction rules
InputType int: Collection type. 0: Host log file. 1: K8s container standard output. 2: Log file inside K8s container.
LogSample string: Log sample.
LogType string: Collection modes. minimalistlog: single-line full mode. jsonlog: JSON mode. delimiterlog: delimiter mode. multilinelog: multi-line full mode. fullregex_log: full regex mode.
ModifyTime string: Time when the collection configuration was modified.
Paths []string: Data collection path list
Pause int: Running status of the collection configuration. 0: Running. 1: Paused.
RuleId string: Collection configuration ID.
RuleName string: Name of the collection configuration.
TopicId string: ID of the log topic to which the collection configuration belongs.
TopicName string: Name of the log topic associated with the collection configuration
UserDefineRule GetHostGroupRuleUserDefineRule: User-defined collection rules.

container_rule object: Container collection rules
create_time string: Time when the collection configuration was created.
exclude_paths list(object): Extraction rule list.
extract_rule object: Extraction rules
input_type number: Collection type. 0: Host log file. 1: K8s container standard output. 2: Log file inside K8s container.
log_sample string: Log sample.
log_type string: Collection modes. minimalistlog: single-line full mode. jsonlog: JSON mode. delimiterlog: delimiter mode. multilinelog: multi-line full mode. fullregex_log: full regex mode.
modify_time string: Time when the collection configuration was modified.
paths list(string): Data collection path list
pause number: Running status of the collection configuration. 0: Running. 1: Paused.
rule_id string: Collection configuration ID.
rule_name string: Name of the collection configuration.
topic_id string: ID of the log topic to which the collection configuration belongs.
topic_name string: Name of the log topic associated with the collection configuration
user_define_rule object: User-defined collection rules.

containerRule GetHostGroupRuleContainerRule: Container collection rules
createTime String: Time when the collection configuration was created.
excludePaths List<GetHostGroupRuleExcludePath>: Extraction rule list.
extractRule GetHostGroupRuleExtractRule: Extraction rules
inputType Integer: Collection type. 0: Host log file. 1: K8s container standard output. 2: Log file inside K8s container.
logSample String: Log sample.
logType String: Collection modes. minimalistlog: single-line full mode. jsonlog: JSON mode. delimiterlog: delimiter mode. multilinelog: multi-line full mode. fullregex_log: full regex mode.
modifyTime String: Time when the collection configuration was modified.
paths List<String>: Data collection path list
pause Integer: Running status of the collection configuration. 0: Running. 1: Paused.
ruleId String: Collection configuration ID.
ruleName String: Name of the collection configuration.
topicId String: ID of the log topic to which the collection configuration belongs.
topicName String: Name of the log topic associated with the collection configuration
userDefineRule GetHostGroupRuleUserDefineRule: User-defined collection rules.

containerRule GetHostGroupRuleContainerRule: Container collection rules
createTime string: Time when the collection configuration was created.
excludePaths GetHostGroupRuleExcludePath[]: Extraction rule list.
extractRule GetHostGroupRuleExtractRule: Extraction rules
inputType number: Collection type. 0: Host log file. 1: K8s container standard output. 2: Log file inside K8s container.
logSample string: Log sample.
logType string: Collection modes. minimalistlog: single-line full mode. jsonlog: JSON mode. delimiterlog: delimiter mode. multilinelog: multi-line full mode. fullregex_log: full regex mode.
modifyTime string: Time when the collection configuration was modified.
paths string[]: Data collection path list
pause number: Running status of the collection configuration. 0: Running. 1: Paused.
ruleId string: Collection configuration ID.
ruleName string: Name of the collection configuration.
topicId string: ID of the log topic to which the collection configuration belongs.
topicName string: Name of the log topic associated with the collection configuration
userDefineRule GetHostGroupRuleUserDefineRule: User-defined collection rules.

container_rule GetHostGroupRuleContainerRule: Container collection rules
create_time str: Time when the collection configuration was created.
exclude_paths Sequence[GetHostGroupRuleExcludePath]: Extraction rule list.
extract_rule GetHostGroupRuleExtractRule: Extraction rules
input_type int: Collection type. 0: Host log file. 1: K8s container standard output. 2: Log file inside K8s container.
log_sample str: Log sample.
log_type str: Collection modes. minimalistlog: single-line full mode. jsonlog: JSON mode. delimiterlog: delimiter mode. multilinelog: multi-line full mode. fullregex_log: full regex mode.
modify_time str: Time when the collection configuration was modified.
paths Sequence[str]: Data collection path list
pause int: Running status of the collection configuration. 0: Running. 1: Paused.
rule_id str: Collection configuration ID.
rule_name str: Name of the collection configuration.
topic_id str: ID of the log topic to which the collection configuration belongs.
topic_name str: Name of the log topic associated with the collection configuration
user_define_rule GetHostGroupRuleUserDefineRule: User-defined collection rules.

containerRule Property Map: Container collection rules
createTime String: Time when the collection configuration was created.
excludePaths List<Property Map>: Extraction rule list.
extractRule Property Map: Extraction rules
inputType Number: Collection type. 0: Host log file. 1: K8s container standard output. 2: Log file inside K8s container.
logSample String: Log sample.
logType String: Collection modes. minimalistlog: single-line full mode. jsonlog: JSON mode. delimiterlog: delimiter mode. multilinelog: multi-line full mode. fullregex_log: full regex mode.
modifyTime String: Time when the collection configuration was modified.
paths List<String>: Data collection path list
pause Number: Running status of the collection configuration. 0: Running. 1: Paused.
ruleId String: Collection configuration ID.
ruleName String: Name of the collection configuration.
topicId String: ID of the log topic to which the collection configuration belongs.
topicName String: Name of the log topic associated with the collection configuration
userDefineRule Property Map: User-defined collection rules.

GetHostGroupRuleContainerRule

ContainerNameRegex string: Container name to collect. If no container name is specified, all containers in the machine group are collected. Supports regular expressions. For example, setting the container name to ^(container-test)$ collects all containers named container-test.
EnvTags List<Volcengine.GetHostGroupRuleContainerRuleEnvTag>: Whether to add environment variables as log tags to the raw log data. When enabled, Log Service adds container environment variable fields to 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, Log Service adds the field tagdata_source_*: DC to the log.
ExcludeContainerEnvRegexes List<Volcengine.GetHostGroupRuleContainerRuleExcludeContainerEnvRegex>: Container environment variable denylist/blocklist specifies containers to exclude from collection. If the denylist/blocklist is not enabled, all containers are collected. If enabled, Key is required and Value is optional. If Value is empty, all containers with the specified Key in their environment variables are excluded. If Value is not empty, only containers matching the key-value pair are excluded—that is, containers with the specified Key and a Value matching the given pattern. Value supports regex matching. For example, set Key to module and Value to ^(tcp|udp)$ to exclude containers with module:tcp or module:udp in their environment variables. Multiple key-value pairs use logical OR: any container matching any pair is excluded from collection. When the denylist/blocklist is enabled, Keys cannot be duplicated.
ExcludeContainerLabelRegexes List<Volcengine.GetHostGroupRuleContainerRuleExcludeContainerLabelRegex>: The container Label denylist specifies which containers to exclude from collection. If not enabled, all containers are collected. If the container Label denylist is enabled, Key is required and Value is optional. If Value is empty, all containers with the specified Key in the container Label are excluded. If Value is not empty, only containers matching the Key-Value pair are excluded, meaning only containers with the specified Key and a Value matching the pattern are excluded. Value supports regex matching. For example, set Key to app and Value to ^(test1|test2)$ to exclude containers with app:test1 or app:test2 in the container Label. The logical relationship between multiple Key-Value pairs is OR, meaning any container Label matching any pair will be excluded from collection. When enabling the container Label denylist, Keys must not be duplicated.
IncludeContainerEnvRegexes List<Volcengine.GetHostGroupRuleContainerRuleIncludeContainerEnvRegex>: The container environment variable allowlist specifies which containers to collect by using environment variables as criteria. 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: collect all containers that contain the Key in their environment variables. If Value is not empty: only collect containers where the Key exists and its value matches Value. Value supports regex matching. For example, set Key to module and Value to ^(tcp|udp)$ to collect only containers with module:tcp or module:udp in their environment variables. Multiple key-value pairs use logical OR; 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.GetHostGroupRuleContainerRuleIncludeContainerLabelRegex>: 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 enter key-value pairs. Key is required; Value is optional. If Value is empty, all containers with the specified Key in their container Label are collected. If Value is not empty, only containers with the specified Key and a Value matching the Value field are collected. Value supports regular expressions. For example, set Key to app and Value to ^(test1|test2)$ to collect only containers with app:test1 or app:test2 in their container Label. The logical relationship between multiple key-value pairs is OR; any container Label matching any key-value pair will be included in the collection scope. When the container Label allowlist is enabled, Keys must not be duplicated.
KubernetesRule Volcengine.GetHostGroupRuleContainerRuleKubernetesRule: Kubernetes container collection rules.
Stream string: Collection information. stdout: Container standard output (stdout). stderr: Container standard error (stderr). all: 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 are collected. Supports regular expressions. For example, setting the container name to ^(container-test)$ collects all containers named container-test.
EnvTags []GetHostGroupRuleContainerRuleEnvTag: Whether to add environment variables as log tags to the raw log data. When enabled, Log Service adds container environment variable fields to 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, Log Service adds the field tagdata_source_*: DC to the log.
ExcludeContainerEnvRegexes []GetHostGroupRuleContainerRuleExcludeContainerEnvRegex: Container environment variable denylist/blocklist specifies containers to exclude from collection. If the denylist/blocklist is not enabled, all containers are collected. If enabled, Key is required and Value is optional. If Value is empty, all containers with the specified Key in their environment variables are excluded. If Value is not empty, only containers matching the key-value pair are excluded—that is, containers with the specified Key and a Value matching the given pattern. Value supports regex matching. For example, set Key to module and Value to ^(tcp|udp)$ to exclude containers with module:tcp or module:udp in their environment variables. Multiple key-value pairs use logical OR: any container matching any pair is excluded from collection. When the denylist/blocklist is enabled, Keys cannot be duplicated.
ExcludeContainerLabelRegexes []GetHostGroupRuleContainerRuleExcludeContainerLabelRegex: The container Label denylist specifies which containers to exclude from collection. If not enabled, all containers are collected. If the container Label denylist is enabled, Key is required and Value is optional. If Value is empty, all containers with the specified Key in the container Label are excluded. If Value is not empty, only containers matching the Key-Value pair are excluded, meaning only containers with the specified Key and a Value matching the pattern are excluded. Value supports regex matching. For example, set Key to app and Value to ^(test1|test2)$ to exclude containers with app:test1 or app:test2 in the container Label. The logical relationship between multiple Key-Value pairs is OR, meaning any container Label matching any pair will be excluded from collection. When enabling the container Label denylist, Keys must not be duplicated.
IncludeContainerEnvRegexes []GetHostGroupRuleContainerRuleIncludeContainerEnvRegex: The container environment variable allowlist specifies which containers to collect by using environment variables as criteria. 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: collect all containers that contain the Key in their environment variables. If Value is not empty: only collect containers where the Key exists and its value matches Value. Value supports regex matching. For example, set Key to module and Value to ^(tcp|udp)$ to collect only containers with module:tcp or module:udp in their environment variables. Multiple key-value pairs use logical OR; 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 []GetHostGroupRuleContainerRuleIncludeContainerLabelRegex: 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 enter key-value pairs. Key is required; Value is optional. If Value is empty, all containers with the specified Key in their container Label are collected. If Value is not empty, only containers with the specified Key and a Value matching the Value field are collected. Value supports regular expressions. For example, set Key to app and Value to ^(test1|test2)$ to collect only containers with app:test1 or app:test2 in their container Label. The logical relationship between multiple key-value pairs is OR; any container Label matching any key-value pair will be included in the collection scope. When the container Label allowlist is enabled, Keys must not be duplicated.
KubernetesRule GetHostGroupRuleContainerRuleKubernetesRule: Kubernetes container collection rules.
Stream string: Collection information. stdout: Container standard output (stdout). stderr: Container standard error (stderr). all: Both container standard output (stdout) and standard error (stderr).

container_name_regex string: Container name to collect. If no container name is specified, all containers in the machine group are collected. Supports regular expressions. For example, setting the container name to ^(container-test)$ collects all containers named container-test.
env_tags list(object): Whether to add environment variables as log tags to the raw log data. When enabled, Log Service adds container environment variable fields to 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, Log Service adds the field tagdata_source_*: DC to the log.
exclude_container_env_regexes list(object): Container environment variable denylist/blocklist specifies containers to exclude from collection. If the denylist/blocklist is not enabled, all containers are collected. If enabled, Key is required and Value is optional. If Value is empty, all containers with the specified Key in their environment variables are excluded. If Value is not empty, only containers matching the key-value pair are excluded—that is, containers with the specified Key and a Value matching the given pattern. Value supports regex matching. For example, set Key to module and Value to ^(tcp|udp)$ to exclude containers with module:tcp or module:udp in their environment variables. Multiple key-value pairs use logical OR: any container matching any pair is excluded from collection. When the denylist/blocklist is enabled, Keys cannot be duplicated.
exclude_container_label_regexes list(object): The container Label denylist specifies which containers to exclude from collection. If not enabled, all containers are collected. If the container Label denylist is enabled, Key is required and Value is optional. If Value is empty, all containers with the specified Key in the container Label are excluded. If Value is not empty, only containers matching the Key-Value pair are excluded, meaning only containers with the specified Key and a Value matching the pattern are excluded. Value supports regex matching. For example, set Key to app and Value to ^(test1|test2)$ to exclude containers with app:test1 or app:test2 in the container Label. The logical relationship between multiple Key-Value pairs is OR, meaning any container Label matching any pair will be excluded from collection. When enabling the container Label denylist, Keys must not be duplicated.
include_container_env_regexes list(object): The container environment variable allowlist specifies which containers to collect by using environment variables as criteria. 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: collect all containers that contain the Key in their environment variables. If Value is not empty: only collect containers where the Key exists and its value matches Value. Value supports regex matching. For example, set Key to module and Value to ^(tcp|udp)$ to collect only containers with module:tcp or module:udp in their environment variables. Multiple key-value pairs use logical OR; 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 list(object): 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 enter key-value pairs. Key is required; Value is optional. If Value is empty, all containers with the specified Key in their container Label are collected. If Value is not empty, only containers with the specified Key and a Value matching the Value field are collected. Value supports regular expressions. For example, set Key to app and Value to ^(test1|test2)$ to collect only containers with app:test1 or app:test2 in their container Label. The logical relationship between multiple key-value pairs is OR; any container Label matching any key-value pair will be included in the collection scope. When the container Label allowlist is enabled, Keys must not be duplicated.
kubernetes_rule object: Kubernetes container collection rules.
stream string: Collection information. stdout: Container standard output (stdout). stderr: Container standard error (stderr). all: 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 are collected. Supports regular expressions. For example, setting the container name to ^(container-test)$ collects all containers named container-test.
envTags List<GetHostGroupRuleContainerRuleEnvTag>: Whether to add environment variables as log tags to the raw log data. When enabled, Log Service adds container environment variable fields to 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, Log Service adds the field tagdata_source_*: DC to the log.
excludeContainerEnvRegexes List<GetHostGroupRuleContainerRuleExcludeContainerEnvRegex>: Container environment variable denylist/blocklist specifies containers to exclude from collection. If the denylist/blocklist is not enabled, all containers are collected. If enabled, Key is required and Value is optional. If Value is empty, all containers with the specified Key in their environment variables are excluded. If Value is not empty, only containers matching the key-value pair are excluded—that is, containers with the specified Key and a Value matching the given pattern. Value supports regex matching. For example, set Key to module and Value to ^(tcp|udp)$ to exclude containers with module:tcp or module:udp in their environment variables. Multiple key-value pairs use logical OR: any container matching any pair is excluded from collection. When the denylist/blocklist is enabled, Keys cannot be duplicated.
excludeContainerLabelRegexes List<GetHostGroupRuleContainerRuleExcludeContainerLabelRegex>: The container Label denylist specifies which containers to exclude from collection. If not enabled, all containers are collected. If the container Label denylist is enabled, Key is required and Value is optional. If Value is empty, all containers with the specified Key in the container Label are excluded. If Value is not empty, only containers matching the Key-Value pair are excluded, meaning only containers with the specified Key and a Value matching the pattern are excluded. Value supports regex matching. For example, set Key to app and Value to ^(test1|test2)$ to exclude containers with app:test1 or app:test2 in the container Label. The logical relationship between multiple Key-Value pairs is OR, meaning any container Label matching any pair will be excluded from collection. When enabling the container Label denylist, Keys must not be duplicated.
includeContainerEnvRegexes List<GetHostGroupRuleContainerRuleIncludeContainerEnvRegex>: The container environment variable allowlist specifies which containers to collect by using environment variables as criteria. 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: collect all containers that contain the Key in their environment variables. If Value is not empty: only collect containers where the Key exists and its value matches Value. Value supports regex matching. For example, set Key to module and Value to ^(tcp|udp)$ to collect only containers with module:tcp or module:udp in their environment variables. Multiple key-value pairs use logical OR; 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<GetHostGroupRuleContainerRuleIncludeContainerLabelRegex>: 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 enter key-value pairs. Key is required; Value is optional. If Value is empty, all containers with the specified Key in their container Label are collected. If Value is not empty, only containers with the specified Key and a Value matching the Value field are collected. Value supports regular expressions. For example, set Key to app and Value to ^(test1|test2)$ to collect only containers with app:test1 or app:test2 in their container Label. The logical relationship between multiple key-value pairs is OR; any container Label matching any key-value pair will be included in the collection scope. When the container Label allowlist is enabled, Keys must not be duplicated.
kubernetesRule GetHostGroupRuleContainerRuleKubernetesRule: Kubernetes container collection rules.
stream String: Collection information. stdout: Container standard output (stdout). stderr: Container standard error (stderr). all: 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 are collected. Supports regular expressions. For example, setting the container name to ^(container-test)$ collects all containers named container-test.
envTags GetHostGroupRuleContainerRuleEnvTag[]: Whether to add environment variables as log tags to the raw log data. When enabled, Log Service adds container environment variable fields to 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, Log Service adds the field tagdata_source_*: DC to the log.
excludeContainerEnvRegexes GetHostGroupRuleContainerRuleExcludeContainerEnvRegex[]: Container environment variable denylist/blocklist specifies containers to exclude from collection. If the denylist/blocklist is not enabled, all containers are collected. If enabled, Key is required and Value is optional. If Value is empty, all containers with the specified Key in their environment variables are excluded. If Value is not empty, only containers matching the key-value pair are excluded—that is, containers with the specified Key and a Value matching the given pattern. Value supports regex matching. For example, set Key to module and Value to ^(tcp|udp)$ to exclude containers with module:tcp or module:udp in their environment variables. Multiple key-value pairs use logical OR: any container matching any pair is excluded from collection. When the denylist/blocklist is enabled, Keys cannot be duplicated.
excludeContainerLabelRegexes GetHostGroupRuleContainerRuleExcludeContainerLabelRegex[]: The container Label denylist specifies which containers to exclude from collection. If not enabled, all containers are collected. If the container Label denylist is enabled, Key is required and Value is optional. If Value is empty, all containers with the specified Key in the container Label are excluded. If Value is not empty, only containers matching the Key-Value pair are excluded, meaning only containers with the specified Key and a Value matching the pattern are excluded. Value supports regex matching. For example, set Key to app and Value to ^(test1|test2)$ to exclude containers with app:test1 or app:test2 in the container Label. The logical relationship between multiple Key-Value pairs is OR, meaning any container Label matching any pair will be excluded from collection. When enabling the container Label denylist, Keys must not be duplicated.
includeContainerEnvRegexes GetHostGroupRuleContainerRuleIncludeContainerEnvRegex[]: The container environment variable allowlist specifies which containers to collect by using environment variables as criteria. 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: collect all containers that contain the Key in their environment variables. If Value is not empty: only collect containers where the Key exists and its value matches Value. Value supports regex matching. For example, set Key to module and Value to ^(tcp|udp)$ to collect only containers with module:tcp or module:udp in their environment variables. Multiple key-value pairs use logical OR; 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 GetHostGroupRuleContainerRuleIncludeContainerLabelRegex[]: 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 enter key-value pairs. Key is required; Value is optional. If Value is empty, all containers with the specified Key in their container Label are collected. If Value is not empty, only containers with the specified Key and a Value matching the Value field are collected. Value supports regular expressions. For example, set Key to app and Value to ^(test1|test2)$ to collect only containers with app:test1 or app:test2 in their container Label. The logical relationship between multiple key-value pairs is OR; any container Label matching any key-value pair will be included in the collection scope. When the container Label allowlist is enabled, Keys must not be duplicated.
kubernetesRule GetHostGroupRuleContainerRuleKubernetesRule: Kubernetes container collection rules.
stream string: Collection information. stdout: Container standard output (stdout). stderr: Container standard error (stderr). all: 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 are collected. Supports regular expressions. For example, setting the container name to ^(container-test)$ collects all containers named container-test.
env_tags Sequence[GetHostGroupRuleContainerRuleEnvTag]: Whether to add environment variables as log tags to the raw log data. When enabled, Log Service adds container environment variable fields to 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, Log Service adds the field tagdata_source_*: DC to the log.
exclude_container_env_regexes Sequence[GetHostGroupRuleContainerRuleExcludeContainerEnvRegex]: Container environment variable denylist/blocklist specifies containers to exclude from collection. If the denylist/blocklist is not enabled, all containers are collected. If enabled, Key is required and Value is optional. If Value is empty, all containers with the specified Key in their environment variables are excluded. If Value is not empty, only containers matching the key-value pair are excluded—that is, containers with the specified Key and a Value matching the given pattern. Value supports regex matching. For example, set Key to module and Value to ^(tcp|udp)$ to exclude containers with module:tcp or module:udp in their environment variables. Multiple key-value pairs use logical OR: any container matching any pair is excluded from collection. When the denylist/blocklist is enabled, Keys cannot be duplicated.
exclude_container_label_regexes Sequence[GetHostGroupRuleContainerRuleExcludeContainerLabelRegex]: The container Label denylist specifies which containers to exclude from collection. If not enabled, all containers are collected. If the container Label denylist is enabled, Key is required and Value is optional. If Value is empty, all containers with the specified Key in the container Label are excluded. If Value is not empty, only containers matching the Key-Value pair are excluded, meaning only containers with the specified Key and a Value matching the pattern are excluded. Value supports regex matching. For example, set Key to app and Value to ^(test1|test2)$ to exclude containers with app:test1 or app:test2 in the container Label. The logical relationship between multiple Key-Value pairs is OR, meaning any container Label matching any pair will be excluded from collection. When enabling the container Label denylist, Keys must not be duplicated.
include_container_env_regexes Sequence[GetHostGroupRuleContainerRuleIncludeContainerEnvRegex]: The container environment variable allowlist specifies which containers to collect by using environment variables as criteria. 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: collect all containers that contain the Key in their environment variables. If Value is not empty: only collect containers where the Key exists and its value matches Value. Value supports regex matching. For example, set Key to module and Value to ^(tcp|udp)$ to collect only containers with module:tcp or module:udp in their environment variables. Multiple key-value pairs use logical OR; 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[GetHostGroupRuleContainerRuleIncludeContainerLabelRegex]: 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 enter key-value pairs. Key is required; Value is optional. If Value is empty, all containers with the specified Key in their container Label are collected. If Value is not empty, only containers with the specified Key and a Value matching the Value field are collected. Value supports regular expressions. For example, set Key to app and Value to ^(test1|test2)$ to collect only containers with app:test1 or app:test2 in their container Label. The logical relationship between multiple key-value pairs is OR; any container Label matching any key-value pair will be included in the collection scope. When the container Label allowlist is enabled, Keys must not be duplicated.
kubernetes_rule GetHostGroupRuleContainerRuleKubernetesRule: Kubernetes container collection rules.
stream str: Collection information. stdout: Container standard output (stdout). stderr: Container standard error (stderr). all: 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 are collected. Supports regular expressions. For example, setting the container name to ^(container-test)$ collects all containers named container-test.
envTags List<Property Map>: Whether to add environment variables as log tags to the raw log data. When enabled, Log Service adds container environment variable fields to 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, Log Service adds the field tagdata_source_*: DC to the log.
excludeContainerEnvRegexes List<Property Map>: Container environment variable denylist/blocklist specifies containers to exclude from collection. If the denylist/blocklist is not enabled, all containers are collected. If enabled, Key is required and Value is optional. If Value is empty, all containers with the specified Key in their environment variables are excluded. If Value is not empty, only containers matching the key-value pair are excluded—that is, containers with the specified Key and a Value matching the given pattern. Value supports regex matching. For example, set Key to module and Value to ^(tcp|udp)$ to exclude containers with module:tcp or module:udp in their environment variables. Multiple key-value pairs use logical OR: any container matching any pair is excluded from collection. When the denylist/blocklist is enabled, Keys cannot be duplicated.
excludeContainerLabelRegexes List<Property Map>: The container Label denylist specifies which containers to exclude from collection. If not enabled, all containers are collected. If the container Label denylist is enabled, Key is required and Value is optional. If Value is empty, all containers with the specified Key in the container Label are excluded. If Value is not empty, only containers matching the Key-Value pair are excluded, meaning only containers with the specified Key and a Value matching the pattern are excluded. Value supports regex matching. For example, set Key to app and Value to ^(test1|test2)$ to exclude containers with app:test1 or app:test2 in the container Label. The logical relationship between multiple Key-Value pairs is OR, meaning any container Label matching any pair will be excluded from collection. When enabling the container Label denylist, Keys must not be duplicated.
includeContainerEnvRegexes List<Property Map>: The container environment variable allowlist specifies which containers to collect by using environment variables as criteria. 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: collect all containers that contain the Key in their environment variables. If Value is not empty: only collect containers where the Key exists and its value matches Value. Value supports regex matching. For example, set Key to module and Value to ^(tcp|udp)$ to collect only containers with module:tcp or module:udp in their environment variables. Multiple key-value pairs use logical OR; 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 enter key-value pairs. Key is required; Value is optional. If Value is empty, all containers with the specified Key in their container Label are collected. If Value is not empty, only containers with the specified Key and a Value matching the Value field are collected. Value supports regular expressions. For example, set Key to app and Value to ^(test1|test2)$ to collect only containers with app:test1 or app:test2 in their container Label. The logical relationship between multiple key-value pairs is OR; any container Label matching any key-value pair will be included in the collection scope. When the container Label allowlist is enabled, Keys must not be duplicated.
kubernetesRule Property Map: Kubernetes container collection rules.
stream String: Collection information. stdout: Container standard output (stdout). stderr: Container standard error (stderr). all: Both container standard output (stdout) and standard error (stderr).

GetHostGroupRuleContainerRuleEnvTag

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 string: Key.
val string: Value.

key str: Key.
val str: Value.

key String: Key.
val String: Value.

GetHostGroupRuleContainerRuleExcludeContainerEnvRegex

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 string: Key.
val string: Value.

key str: Key.
val str: Value.

key String: Key.
val String: Value.

GetHostGroupRuleContainerRuleExcludeContainerLabelRegex

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 string: Key.
val string: Value.

key str: Key.
val str: Value.

key String: Key.
val String: Value.

GetHostGroupRuleContainerRuleIncludeContainerEnvRegex

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 string: Key.
val string: Value.

key str: Key.
val str: Value.

key String: Key.
val String: Value.

GetHostGroupRuleContainerRuleIncludeContainerLabelRegex

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 string: Key.
val string: Value.

key str: Key.
val str: Value.

key String: Key.
val String: Value.

GetHostGroupRuleContainerRuleKubernetesRule

AnnotationTags List<Volcengine.GetHostGroupRuleContainerRuleKubernetesRuleAnnotationTag>: Whether to add Kubernetes Annotations as log tags to the raw log data. When enabled, the log service adds Kubernetes Pod Annotation fields to the logs. Setting multiple key-value pairs adds multiple fields. For example, set Key to sink and Value to data_sink. If the Pod contains the Annotation sink=ck, the log will include the field tagdata_sink_*: ck.
EnableAllLabelTag bool: Whether to add all Kubernetes Labels as log tags to the raw log data. When enabled, the log service adds fields for all Labels in the Kubernetes Pod to the log. For example, if the Pod has Label source=DC and destination=CS, the log will include fields tagsource__: DC and **tag**destination__: CS.
ExcludePodAnnotationRegexes List<Volcengine.GetHostGroupRuleContainerRuleKubernetesRuleExcludePodAnnotationRegex>: 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 Key will be excluded. If Value is not empty, only containers under Pods whose Pod Annotation contains the Key and whose value matches the Value will be excluded. By default, Value uses string matching, meaning only when Value and the Pod Annotation value are exactly the same will it match. If the value starts with ^ and ends with $, it is treated as a regular expression match. For example, set Key to app and Value to ^(test1|test2)$ to match containers under Pods whose Pod Annotation contains app:test1 or app:test2. Note: The logical relationship between multiple Key-Value pairs is OR, meaning as long as the Pod Annotation matches any pair, it will be included in the collection scope. When enabling the Pod Annotation denylist, Keys must not be duplicated. For fuzzy regular expression matching, you must add .. For example, ^(http.)$ matches strings that start with http
ExcludePodLabelRegexes List<Volcengine.GetHostGroupRuleContainerRuleKubernetesRuleExcludePodLabelRegex>: 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 the Pod Label are excluded from collection. If Value is not empty, only containers with the specified Key and a Value matching the pattern are excluded. Value supports regex matching. For example, set Key to module and Value to ^(tcp|udp)$ to exclude containers with module:tcp or module:udp in the Pod Label. Note: The logical relationship between multiple Key-Value pairs is OR, meaning any Pod Label matching any pair will be excluded from collection. When enabling the Pod Label denylist, Keys must not be duplicated. For fuzzy regex matching, you must add .. For example, ^(http.)$ matches any string starting with http.
IncludePodAnnotationRegexes List<Volcengine.GetHostGroupRuleContainerRuleKubernetesRuleIncludePodAnnotationRegex>: Pod Annotation Allowlist specifies which containers to collect. If you need to set a Pod Annotation Allowlist, Key is required and Value is optional. If Value is empty, all containers in Pods with the specified Key in their Pod Annotation are matched. If Value is not empty, only containers in Pods where the Pod Annotation contains the Key and its value matches Value are matched. By default, Value uses string matching, meaning only exact matches between Value and the Pod Annotation value are considered. If Value starts with ^ and ends with $, it uses regex matching. For example, set Key to app and Value to ^(test1|test2)$ to match containers in Pods with Pod Annotation app:test1 or app:test2. Note: Multiple Key-Value pairs use logical OR, so any Pod Annotation matching any pair will be included in the collection scope. When enabling the Pod Annotation Allowlist, Keys must not be duplicated. For regex fuzzy matching, you must add .. For example, ^(http.)$ matches values starting with http
IncludePodLabelRegexes List<Volcengine.GetHostGroupRuleContainerRuleKubernetesRuleIncludePodLabelRegex>: Pod label allowlist specifies which containers to collect. If the Pod label allowlist is not enabled, all containers are collected. To set a Pod label allowlist, Key is required. If Value is empty, all containers with the Key in their Pod label are collected. If Value is not empty, only containers with the Key in their Pod label and a Value matching the specified pattern are collected. Value supports regex matching. For example, set Key to module and Value to ^(tcp|udp)$ to collect only containers with module:tcp or module:udp in their Pod label. Note: The logical relationship between multiple key-value pairs is OR, meaning any matching pair will include the Pod in the collection scope. When the Pod label allowlist is enabled, Keys must be unique. For fuzzy regex matching, you must add .. For example, ^(http.)$ matches strings starting with http.
LabelTags List<Volcengine.GetHostGroupRuleContainerRuleKubernetesRuleLabelTag>: Choose whether to add Kubernetes labels as log tags to the original 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, set Key to source and Value to data_source. If the Pod contains the label source=DC, the log will include the field tagdata_source_*: DC.
NamespaceNameRegex string: Name of the Kubernetes Namespace to be collected. If not specified, all containers are collected. Namespace names support regular expression matching. For example, setting the Namespace name to ^(tcp|udp)$ collects all containers under the tcp and udp namespaces.
PodNameRegex string: Pod name is used to specify the Pod(s) to be collected. If the Pod name is not specified, all containers are collected. Pod name supports regex 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 containers 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 are: Deployment: stateless workload StatefulSet: stateful workload DaemonSet: daemon process Job: job CronJob: scheduled job

AnnotationTags []GetHostGroupRuleContainerRuleKubernetesRuleAnnotationTag: Whether to add Kubernetes Annotations as log tags to the raw log data. When enabled, the log service adds Kubernetes Pod Annotation fields to the logs. Setting multiple key-value pairs adds multiple fields. For example, set Key to sink and Value to data_sink. If the Pod contains the Annotation sink=ck, the log will include the field tagdata_sink_*: ck.
EnableAllLabelTag bool: Whether to add all Kubernetes Labels as log tags to the raw log data. When enabled, the log service adds fields for all Labels in the Kubernetes Pod to the log. For example, if the Pod has Label source=DC and destination=CS, the log will include fields tagsource__: DC and **tag**destination__: CS.
ExcludePodAnnotationRegexes []GetHostGroupRuleContainerRuleKubernetesRuleExcludePodAnnotationRegex: 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 Key will be excluded. If Value is not empty, only containers under Pods whose Pod Annotation contains the Key and whose value matches the Value will be excluded. By default, Value uses string matching, meaning only when Value and the Pod Annotation value are exactly the same will it match. If the value starts with ^ and ends with $, it is treated as a regular expression match. For example, set Key to app and Value to ^(test1|test2)$ to match containers under Pods whose Pod Annotation contains app:test1 or app:test2. Note: The logical relationship between multiple Key-Value pairs is OR, meaning as long as the Pod Annotation matches any pair, it will be included in the collection scope. When enabling the Pod Annotation denylist, Keys must not be duplicated. For fuzzy regular expression matching, you must add .. For example, ^(http.)$ matches strings that start with http
ExcludePodLabelRegexes []GetHostGroupRuleContainerRuleKubernetesRuleExcludePodLabelRegex: 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 the Pod Label are excluded from collection. If Value is not empty, only containers with the specified Key and a Value matching the pattern are excluded. Value supports regex matching. For example, set Key to module and Value to ^(tcp|udp)$ to exclude containers with module:tcp or module:udp in the Pod Label. Note: The logical relationship between multiple Key-Value pairs is OR, meaning any Pod Label matching any pair will be excluded from collection. When enabling the Pod Label denylist, Keys must not be duplicated. For fuzzy regex matching, you must add .. For example, ^(http.)$ matches any string starting with http.
IncludePodAnnotationRegexes []GetHostGroupRuleContainerRuleKubernetesRuleIncludePodAnnotationRegex: Pod Annotation Allowlist specifies which containers to collect. If you need to set a Pod Annotation Allowlist, Key is required and Value is optional. If Value is empty, all containers in Pods with the specified Key in their Pod Annotation are matched. If Value is not empty, only containers in Pods where the Pod Annotation contains the Key and its value matches Value are matched. By default, Value uses string matching, meaning only exact matches between Value and the Pod Annotation value are considered. If Value starts with ^ and ends with $, it uses regex matching. For example, set Key to app and Value to ^(test1|test2)$ to match containers in Pods with Pod Annotation app:test1 or app:test2. Note: Multiple Key-Value pairs use logical OR, so any Pod Annotation matching any pair will be included in the collection scope. When enabling the Pod Annotation Allowlist, Keys must not be duplicated. For regex fuzzy matching, you must add .. For example, ^(http.)$ matches values starting with http
IncludePodLabelRegexes []GetHostGroupRuleContainerRuleKubernetesRuleIncludePodLabelRegex: Pod label allowlist specifies which containers to collect. If the Pod label allowlist is not enabled, all containers are collected. To set a Pod label allowlist, Key is required. If Value is empty, all containers with the Key in their Pod label are collected. If Value is not empty, only containers with the Key in their Pod label and a Value matching the specified pattern are collected. Value supports regex matching. For example, set Key to module and Value to ^(tcp|udp)$ to collect only containers with module:tcp or module:udp in their Pod label. Note: The logical relationship between multiple key-value pairs is OR, meaning any matching pair will include the Pod in the collection scope. When the Pod label allowlist is enabled, Keys must be unique. For fuzzy regex matching, you must add .. For example, ^(http.)$ matches strings starting with http.
LabelTags []GetHostGroupRuleContainerRuleKubernetesRuleLabelTag: Choose whether to add Kubernetes labels as log tags to the original 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, set Key to source and Value to data_source. If the Pod contains the label source=DC, the log will include the field tagdata_source_*: DC.
NamespaceNameRegex string: Name of the Kubernetes Namespace to be collected. If not specified, all containers are collected. Namespace names support regular expression matching. For example, setting the Namespace name to ^(tcp|udp)$ collects all containers under the tcp and udp namespaces.
PodNameRegex string: Pod name is used to specify the Pod(s) to be collected. If the Pod name is not specified, all containers are collected. Pod name supports regex 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 containers 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 are: Deployment: stateless workload StatefulSet: stateful workload DaemonSet: daemon process Job: job CronJob: scheduled job

annotation_tags list(object): Whether to add Kubernetes Annotations as log tags to the raw log data. When enabled, the log service adds Kubernetes Pod Annotation fields to the logs. Setting multiple key-value pairs adds multiple fields. For example, set Key to sink and Value to data_sink. If the Pod contains the Annotation sink=ck, the log will include the field tagdata_sink_*: ck.
enable_all_label_tag bool: Whether to add all Kubernetes Labels as log tags to the raw log data. When enabled, the log service adds fields for all Labels in the Kubernetes Pod to the log. For example, if the Pod has Label source=DC and destination=CS, the log will include fields tagsource__: DC and **tag**destination__: CS.
exclude_pod_annotation_regexes list(object): 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 Key will be excluded. If Value is not empty, only containers under Pods whose Pod Annotation contains the Key and whose value matches the Value will be excluded. By default, Value uses string matching, meaning only when Value and the Pod Annotation value are exactly the same will it match. If the value starts with ^ and ends with $, it is treated as a regular expression match. For example, set Key to app and Value to ^(test1|test2)$ to match containers under Pods whose Pod Annotation contains app:test1 or app:test2. Note: The logical relationship between multiple Key-Value pairs is OR, meaning as long as the Pod Annotation matches any pair, it will be included in the collection scope. When enabling the Pod Annotation denylist, Keys must not be duplicated. For fuzzy regular expression matching, you must add .. For example, ^(http.)$ matches strings that start with http
exclude_pod_label_regexes list(object): 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 the Pod Label are excluded from collection. If Value is not empty, only containers with the specified Key and a Value matching the pattern are excluded. Value supports regex matching. For example, set Key to module and Value to ^(tcp|udp)$ to exclude containers with module:tcp or module:udp in the Pod Label. Note: The logical relationship between multiple Key-Value pairs is OR, meaning any Pod Label matching any pair will be excluded from collection. When enabling the Pod Label denylist, Keys must not be duplicated. For fuzzy regex matching, you must add .. For example, ^(http.)$ matches any string starting with http.
include_pod_annotation_regexes list(object): Pod Annotation Allowlist specifies which containers to collect. If you need to set a Pod Annotation Allowlist, Key is required and Value is optional. If Value is empty, all containers in Pods with the specified Key in their Pod Annotation are matched. If Value is not empty, only containers in Pods where the Pod Annotation contains the Key and its value matches Value are matched. By default, Value uses string matching, meaning only exact matches between Value and the Pod Annotation value are considered. If Value starts with ^ and ends with $, it uses regex matching. For example, set Key to app and Value to ^(test1|test2)$ to match containers in Pods with Pod Annotation app:test1 or app:test2. Note: Multiple Key-Value pairs use logical OR, so any Pod Annotation matching any pair will be included in the collection scope. When enabling the Pod Annotation Allowlist, Keys must not be duplicated. For regex fuzzy matching, you must add .. For example, ^(http.)$ matches values starting with http
include_pod_label_regexes list(object): Pod label allowlist specifies which containers to collect. If the Pod label allowlist is not enabled, all containers are collected. To set a Pod label allowlist, Key is required. If Value is empty, all containers with the Key in their Pod label are collected. If Value is not empty, only containers with the Key in their Pod label and a Value matching the specified pattern are collected. Value supports regex matching. For example, set Key to module and Value to ^(tcp|udp)$ to collect only containers with module:tcp or module:udp in their Pod label. Note: The logical relationship between multiple key-value pairs is OR, meaning any matching pair will include the Pod in the collection scope. When the Pod label allowlist is enabled, Keys must be unique. For fuzzy regex matching, you must add .. For example, ^(http.)$ matches strings starting with http.
label_tags list(object): Choose whether to add Kubernetes labels as log tags to the original 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, set Key to source and Value to data_source. If the Pod contains the label source=DC, the log will include the field tagdata_source_*: DC.
namespace_name_regex string: Name of the Kubernetes Namespace to be collected. If not specified, all containers are collected. Namespace names support regular expression matching. For example, setting the Namespace name to ^(tcp|udp)$ collects all containers under the tcp and udp namespaces.
pod_name_regex string: Pod name is used to specify the Pod(s) to be collected. If the Pod name is not specified, all containers are collected. Pod name supports regex matching. For example, setting the Pod name to ^(http.*)$ collects all containers under Pods whose names start with http.
workload_name_regex 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.
workload_type string: Specify containers 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 are: Deployment: stateless workload StatefulSet: stateful workload DaemonSet: daemon process Job: job CronJob: scheduled job

annotationTags List<GetHostGroupRuleContainerRuleKubernetesRuleAnnotationTag>: Whether to add Kubernetes Annotations as log tags to the raw log data. When enabled, the log service adds Kubernetes Pod Annotation fields to the logs. Setting multiple key-value pairs adds multiple fields. For example, set Key to sink and Value to data_sink. If the Pod contains the Annotation sink=ck, the log will include the field tagdata_sink_*: ck.
enableAllLabelTag Boolean: Whether to add all Kubernetes Labels as log tags to the raw log data. When enabled, the log service adds fields for all Labels in the Kubernetes Pod to the log. For example, if the Pod has Label source=DC and destination=CS, the log will include fields tagsource__: DC and **tag**destination__: CS.
excludePodAnnotationRegexes List<GetHostGroupRuleContainerRuleKubernetesRuleExcludePodAnnotationRegex>: 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 Key will be excluded. If Value is not empty, only containers under Pods whose Pod Annotation contains the Key and whose value matches the Value will be excluded. By default, Value uses string matching, meaning only when Value and the Pod Annotation value are exactly the same will it match. If the value starts with ^ and ends with $, it is treated as a regular expression match. For example, set Key to app and Value to ^(test1|test2)$ to match containers under Pods whose Pod Annotation contains app:test1 or app:test2. Note: The logical relationship between multiple Key-Value pairs is OR, meaning as long as the Pod Annotation matches any pair, it will be included in the collection scope. When enabling the Pod Annotation denylist, Keys must not be duplicated. For fuzzy regular expression matching, you must add .. For example, ^(http.)$ matches strings that start with http
excludePodLabelRegexes List<GetHostGroupRuleContainerRuleKubernetesRuleExcludePodLabelRegex>: 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 the Pod Label are excluded from collection. If Value is not empty, only containers with the specified Key and a Value matching the pattern are excluded. Value supports regex matching. For example, set Key to module and Value to ^(tcp|udp)$ to exclude containers with module:tcp or module:udp in the Pod Label. Note: The logical relationship between multiple Key-Value pairs is OR, meaning any Pod Label matching any pair will be excluded from collection. When enabling the Pod Label denylist, Keys must not be duplicated. For fuzzy regex matching, you must add .. For example, ^(http.)$ matches any string starting with http.
includePodAnnotationRegexes List<GetHostGroupRuleContainerRuleKubernetesRuleIncludePodAnnotationRegex>: Pod Annotation Allowlist specifies which containers to collect. If you need to set a Pod Annotation Allowlist, Key is required and Value is optional. If Value is empty, all containers in Pods with the specified Key in their Pod Annotation are matched. If Value is not empty, only containers in Pods where the Pod Annotation contains the Key and its value matches Value are matched. By default, Value uses string matching, meaning only exact matches between Value and the Pod Annotation value are considered. If Value starts with ^ and ends with $, it uses regex matching. For example, set Key to app and Value to ^(test1|test2)$ to match containers in Pods with Pod Annotation app:test1 or app:test2. Note: Multiple Key-Value pairs use logical OR, so any Pod Annotation matching any pair will be included in the collection scope. When enabling the Pod Annotation Allowlist, Keys must not be duplicated. For regex fuzzy matching, you must add .. For example, ^(http.)$ matches values starting with http
includePodLabelRegexes List<GetHostGroupRuleContainerRuleKubernetesRuleIncludePodLabelRegex>: Pod label allowlist specifies which containers to collect. If the Pod label allowlist is not enabled, all containers are collected. To set a Pod label allowlist, Key is required. If Value is empty, all containers with the Key in their Pod label are collected. If Value is not empty, only containers with the Key in their Pod label and a Value matching the specified pattern are collected. Value supports regex matching. For example, set Key to module and Value to ^(tcp|udp)$ to collect only containers with module:tcp or module:udp in their Pod label. Note: The logical relationship between multiple key-value pairs is OR, meaning any matching pair will include the Pod in the collection scope. When the Pod label allowlist is enabled, Keys must be unique. For fuzzy regex matching, you must add .. For example, ^(http.)$ matches strings starting with http.
labelTags List<GetHostGroupRuleContainerRuleKubernetesRuleLabelTag>: Choose whether to add Kubernetes labels as log tags to the original 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, set Key to source and Value to data_source. If the Pod contains the label source=DC, the log will include the field tagdata_source_*: DC.
namespaceNameRegex String: Name of the Kubernetes Namespace to be collected. If not specified, all containers are collected. Namespace names support regular expression matching. For example, setting the Namespace name to ^(tcp|udp)$ collects all containers under the tcp and udp namespaces.
podNameRegex String: Pod name is used to specify the Pod(s) to be collected. If the Pod name is not specified, all containers are collected. Pod name supports regex 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 containers 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 are: Deployment: stateless workload StatefulSet: stateful workload DaemonSet: daemon process Job: job CronJob: scheduled job

annotationTags GetHostGroupRuleContainerRuleKubernetesRuleAnnotationTag[]: Whether to add Kubernetes Annotations as log tags to the raw log data. When enabled, the log service adds Kubernetes Pod Annotation fields to the logs. Setting multiple key-value pairs adds multiple fields. For example, set Key to sink and Value to data_sink. If the Pod contains the Annotation sink=ck, the log will include the field tagdata_sink_*: ck.
enableAllLabelTag boolean: Whether to add all Kubernetes Labels as log tags to the raw log data. When enabled, the log service adds fields for all Labels in the Kubernetes Pod to the log. For example, if the Pod has Label source=DC and destination=CS, the log will include fields tagsource__: DC and **tag**destination__: CS.
excludePodAnnotationRegexes GetHostGroupRuleContainerRuleKubernetesRuleExcludePodAnnotationRegex[]: 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 Key will be excluded. If Value is not empty, only containers under Pods whose Pod Annotation contains the Key and whose value matches the Value will be excluded. By default, Value uses string matching, meaning only when Value and the Pod Annotation value are exactly the same will it match. If the value starts with ^ and ends with $, it is treated as a regular expression match. For example, set Key to app and Value to ^(test1|test2)$ to match containers under Pods whose Pod Annotation contains app:test1 or app:test2. Note: The logical relationship between multiple Key-Value pairs is OR, meaning as long as the Pod Annotation matches any pair, it will be included in the collection scope. When enabling the Pod Annotation denylist, Keys must not be duplicated. For fuzzy regular expression matching, you must add .. For example, ^(http.)$ matches strings that start with http
excludePodLabelRegexes GetHostGroupRuleContainerRuleKubernetesRuleExcludePodLabelRegex[]: 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 the Pod Label are excluded from collection. If Value is not empty, only containers with the specified Key and a Value matching the pattern are excluded. Value supports regex matching. For example, set Key to module and Value to ^(tcp|udp)$ to exclude containers with module:tcp or module:udp in the Pod Label. Note: The logical relationship between multiple Key-Value pairs is OR, meaning any Pod Label matching any pair will be excluded from collection. When enabling the Pod Label denylist, Keys must not be duplicated. For fuzzy regex matching, you must add .. For example, ^(http.)$ matches any string starting with http.
includePodAnnotationRegexes GetHostGroupRuleContainerRuleKubernetesRuleIncludePodAnnotationRegex[]: Pod Annotation Allowlist specifies which containers to collect. If you need to set a Pod Annotation Allowlist, Key is required and Value is optional. If Value is empty, all containers in Pods with the specified Key in their Pod Annotation are matched. If Value is not empty, only containers in Pods where the Pod Annotation contains the Key and its value matches Value are matched. By default, Value uses string matching, meaning only exact matches between Value and the Pod Annotation value are considered. If Value starts with ^ and ends with $, it uses regex matching. For example, set Key to app and Value to ^(test1|test2)$ to match containers in Pods with Pod Annotation app:test1 or app:test2. Note: Multiple Key-Value pairs use logical OR, so any Pod Annotation matching any pair will be included in the collection scope. When enabling the Pod Annotation Allowlist, Keys must not be duplicated. For regex fuzzy matching, you must add .. For example, ^(http.)$ matches values starting with http
includePodLabelRegexes GetHostGroupRuleContainerRuleKubernetesRuleIncludePodLabelRegex[]: Pod label allowlist specifies which containers to collect. If the Pod label allowlist is not enabled, all containers are collected. To set a Pod label allowlist, Key is required. If Value is empty, all containers with the Key in their Pod label are collected. If Value is not empty, only containers with the Key in their Pod label and a Value matching the specified pattern are collected. Value supports regex matching. For example, set Key to module and Value to ^(tcp|udp)$ to collect only containers with module:tcp or module:udp in their Pod label. Note: The logical relationship between multiple key-value pairs is OR, meaning any matching pair will include the Pod in the collection scope. When the Pod label allowlist is enabled, Keys must be unique. For fuzzy regex matching, you must add .. For example, ^(http.)$ matches strings starting with http.
labelTags GetHostGroupRuleContainerRuleKubernetesRuleLabelTag[]: Choose whether to add Kubernetes labels as log tags to the original 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, set Key to source and Value to data_source. If the Pod contains the label source=DC, the log will include the field tagdata_source_*: DC.
namespaceNameRegex string: Name of the Kubernetes Namespace to be collected. If not specified, all containers are collected. Namespace names support regular expression matching. For example, setting the Namespace name to ^(tcp|udp)$ collects all containers under the tcp and udp namespaces.
podNameRegex string: Pod name is used to specify the Pod(s) to be collected. If the Pod name is not specified, all containers are collected. Pod name supports regex 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 containers 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 are: Deployment: stateless workload StatefulSet: stateful workload DaemonSet: daemon process Job: job CronJob: scheduled job

annotation_tags Sequence[GetHostGroupRuleContainerRuleKubernetesRuleAnnotationTag]: Whether to add Kubernetes Annotations as log tags to the raw log data. When enabled, the log service adds Kubernetes Pod Annotation fields to the logs. Setting multiple key-value pairs adds multiple fields. For example, set Key to sink and Value to data_sink. If the Pod contains the Annotation sink=ck, the log will include the field tagdata_sink_*: ck.
enable_all_label_tag bool: Whether to add all Kubernetes Labels as log tags to the raw log data. When enabled, the log service adds fields for all Labels in the Kubernetes Pod to the log. For example, if the Pod has Label source=DC and destination=CS, the log will include fields tagsource__: DC and **tag**destination__: CS.
exclude_pod_annotation_regexes Sequence[GetHostGroupRuleContainerRuleKubernetesRuleExcludePodAnnotationRegex]: 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 Key will be excluded. If Value is not empty, only containers under Pods whose Pod Annotation contains the Key and whose value matches the Value will be excluded. By default, Value uses string matching, meaning only when Value and the Pod Annotation value are exactly the same will it match. If the value starts with ^ and ends with $, it is treated as a regular expression match. For example, set Key to app and Value to ^(test1|test2)$ to match containers under Pods whose Pod Annotation contains app:test1 or app:test2. Note: The logical relationship between multiple Key-Value pairs is OR, meaning as long as the Pod Annotation matches any pair, it will be included in the collection scope. When enabling the Pod Annotation denylist, Keys must not be duplicated. For fuzzy regular expression matching, you must add .. For example, ^(http.)$ matches strings that start with http
exclude_pod_label_regexes Sequence[GetHostGroupRuleContainerRuleKubernetesRuleExcludePodLabelRegex]: 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 the Pod Label are excluded from collection. If Value is not empty, only containers with the specified Key and a Value matching the pattern are excluded. Value supports regex matching. For example, set Key to module and Value to ^(tcp|udp)$ to exclude containers with module:tcp or module:udp in the Pod Label. Note: The logical relationship between multiple Key-Value pairs is OR, meaning any Pod Label matching any pair will be excluded from collection. When enabling the Pod Label denylist, Keys must not be duplicated. For fuzzy regex matching, you must add .. For example, ^(http.)$ matches any string starting with http.
include_pod_annotation_regexes Sequence[GetHostGroupRuleContainerRuleKubernetesRuleIncludePodAnnotationRegex]: Pod Annotation Allowlist specifies which containers to collect. If you need to set a Pod Annotation Allowlist, Key is required and Value is optional. If Value is empty, all containers in Pods with the specified Key in their Pod Annotation are matched. If Value is not empty, only containers in Pods where the Pod Annotation contains the Key and its value matches Value are matched. By default, Value uses string matching, meaning only exact matches between Value and the Pod Annotation value are considered. If Value starts with ^ and ends with $, it uses regex matching. For example, set Key to app and Value to ^(test1|test2)$ to match containers in Pods with Pod Annotation app:test1 or app:test2. Note: Multiple Key-Value pairs use logical OR, so any Pod Annotation matching any pair will be included in the collection scope. When enabling the Pod Annotation Allowlist, Keys must not be duplicated. For regex fuzzy matching, you must add .. For example, ^(http.)$ matches values starting with http
include_pod_label_regexes Sequence[GetHostGroupRuleContainerRuleKubernetesRuleIncludePodLabelRegex]: Pod label allowlist specifies which containers to collect. If the Pod label allowlist is not enabled, all containers are collected. To set a Pod label allowlist, Key is required. If Value is empty, all containers with the Key in their Pod label are collected. If Value is not empty, only containers with the Key in their Pod label and a Value matching the specified pattern are collected. Value supports regex matching. For example, set Key to module and Value to ^(tcp|udp)$ to collect only containers with module:tcp or module:udp in their Pod label. Note: The logical relationship between multiple key-value pairs is OR, meaning any matching pair will include the Pod in the collection scope. When the Pod label allowlist is enabled, Keys must be unique. For fuzzy regex matching, you must add .. For example, ^(http.)$ matches strings starting with http.
label_tags Sequence[GetHostGroupRuleContainerRuleKubernetesRuleLabelTag]: Choose whether to add Kubernetes labels as log tags to the original 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, set Key to source and Value to data_source. If 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 be collected. If not specified, all containers are collected. Namespace names support regular expression matching. For example, setting the Namespace name to ^(tcp|udp)$ collects all containers under the tcp and udp namespaces.
pod_name_regex str: Pod name is used to specify the Pod(s) to be collected. If the Pod name is not specified, all containers are collected. Pod name supports regex 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 containers 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 are: Deployment: stateless workload StatefulSet: stateful workload DaemonSet: daemon process Job: job CronJob: scheduled job

annotationTags List<Property Map>: Whether to add Kubernetes Annotations as log tags to the raw log data. When enabled, the log service adds Kubernetes Pod Annotation fields to the logs. Setting multiple key-value pairs adds multiple fields. For example, set Key to sink and Value to data_sink. If the Pod contains the Annotation sink=ck, the log will include the field tagdata_sink_*: ck.
enableAllLabelTag Boolean: Whether to add all Kubernetes Labels as log tags to the raw log data. When enabled, the log service adds fields for all Labels in the Kubernetes Pod to the log. For example, if the Pod has Label source=DC and destination=CS, the log 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 Key will be excluded. If Value is not empty, only containers under Pods whose Pod Annotation contains the Key and whose value matches the Value will be excluded. By default, Value uses string matching, meaning only when Value and the Pod Annotation value are exactly the same will it match. If the value starts with ^ and ends with $, it is treated as a regular expression match. For example, set Key to app and Value to ^(test1|test2)$ to match containers under Pods whose Pod Annotation contains app:test1 or app:test2. Note: The logical relationship between multiple Key-Value pairs is OR, meaning as long as the Pod Annotation matches any pair, it will be included in the collection scope. When enabling the Pod Annotation denylist, Keys must not be duplicated. For fuzzy regular expression matching, you must add .. For example, ^(http.)$ matches strings that start 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 the Pod Label are excluded from collection. If Value is not empty, only containers with the specified Key and a Value matching the pattern are excluded. Value supports regex matching. For example, set Key to module and Value to ^(tcp|udp)$ to exclude containers with module:tcp or module:udp in the Pod Label. Note: The logical relationship between multiple Key-Value pairs is OR, meaning any Pod Label matching any pair will be excluded from collection. When enabling the Pod Label denylist, Keys must not be duplicated. For fuzzy regex matching, you must add .. For example, ^(http.)$ matches any string starting with http.
includePodAnnotationRegexes List<Property Map>: Pod Annotation Allowlist specifies which containers to collect. If you need to set a Pod Annotation Allowlist, Key is required and Value is optional. If Value is empty, all containers in Pods with the specified Key in their Pod Annotation are matched. If Value is not empty, only containers in Pods where the Pod Annotation contains the Key and its value matches Value are matched. By default, Value uses string matching, meaning only exact matches between Value and the Pod Annotation value are considered. If Value starts with ^ and ends with $, it uses regex matching. For example, set Key to app and Value to ^(test1|test2)$ to match containers in Pods with Pod Annotation app:test1 or app:test2. Note: Multiple Key-Value pairs use logical OR, so any Pod Annotation matching any pair will be included in the collection scope. When enabling the Pod Annotation Allowlist, Keys must not be duplicated. For regex fuzzy matching, you must add .. For example, ^(http.)$ matches values starting with http
includePodLabelRegexes List<Property Map>: Pod label allowlist specifies which containers to collect. If the Pod label allowlist is not enabled, all containers are collected. To set a Pod label allowlist, Key is required. If Value is empty, all containers with the Key in their Pod label are collected. If Value is not empty, only containers with the Key in their Pod label and a Value matching the specified pattern are collected. Value supports regex matching. For example, set Key to module and Value to ^(tcp|udp)$ to collect only containers with module:tcp or module:udp in their Pod label. Note: The logical relationship between multiple key-value pairs is OR, meaning any matching pair will include the Pod in the collection scope. When the Pod label allowlist is enabled, Keys must be unique. For fuzzy regex matching, you must add .. For example, ^(http.)$ matches strings starting with http.
labelTags List<Property Map>: Choose whether to add Kubernetes labels as log tags to the original 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, set Key to source and Value to data_source. If the Pod contains the label source=DC, the log will include the field tagdata_source_*: DC.
namespaceNameRegex String: Name of the Kubernetes Namespace to be collected. If not specified, all containers are collected. Namespace names support regular expression matching. For example, setting the Namespace name to ^(tcp|udp)$ collects all containers under the tcp and udp namespaces.
podNameRegex String: Pod name is used to specify the Pod(s) to be collected. If the Pod name is not specified, all containers are collected. Pod name supports regex 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 containers 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 are: Deployment: stateless workload StatefulSet: stateful workload DaemonSet: daemon process Job: job CronJob: scheduled job

GetHostGroupRuleContainerRuleKubernetesRuleAnnotationTag

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 string: Key.
val string: Value.

key str: Key.
val str: Value.

key String: Key.
val String: Value.

GetHostGroupRuleContainerRuleKubernetesRuleExcludePodAnnotationRegex

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 string: Key.
val string: Value.

key str: Key.
val str: Value.

key String: Key.
val String: Value.

GetHostGroupRuleContainerRuleKubernetesRuleExcludePodLabelRegex

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 string: Key.
val string: Value.

key str: Key.
val str: Value.

key String: Key.
val String: Value.

GetHostGroupRuleContainerRuleKubernetesRuleIncludePodAnnotationRegex

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 string: Key.
val string: Value.

key str: Key.
val str: Value.

key String: Key.
val String: Value.

GetHostGroupRuleContainerRuleKubernetesRuleIncludePodLabelRegex

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 string: Key.
val string: Value.

key str: Key.
val str: Value.

key String: Key.
val String: Value.

GetHostGroupRuleContainerRuleKubernetesRuleLabelTag

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 string: Key.
val string: Value.

key str: Key.
val str: Value.

key String: Key.
val String: Value.

GetHostGroupRuleExcludePath

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

GetHostGroupRuleExtractRule

BeginRegex string: The regex pattern required to match the first line of the log. This is valid only when LogType is multilinelog or fullregexlog. The pattern 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 report time with nanosecond precision. true: Enable nanosecond precision time. false: Disable nanosecond precision time.
FilterKeyRegexes List<Volcengine.GetHostGroupRuleExtractRuleFilterKeyRegex>: Filter rule list.
Keys List<string>: List of log field names (Keys).
LogRegex string: The entire log entry must match the regular expression. This is only valid when the log type is fullregex_log. The regular expression must be valid.
LogTemplate Volcengine.GetHostGroupRuleExtractRuleLogTemplate: Automatically extract log fields based on the specified log template.
Quote string: Quotation mark. Content enclosed by quotation marks is parsed as a complete field and not separated. 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 a specified time field in the log is used as the log timestamp, you must provide TimeKey and TimeFormat.
TimeKey string: Field name for the log time field. If a specified time field in the log is used as the log timestamp, you must provide TimeKey and TimeFormat.
TimeSample string: Sample time. Used to verify whether the specified 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.
UnMatchLogKey string: Key name for logs that failed to parse when uploading
UnMatchUpLoadSwitch bool: Upload logs that failed to parse. UnMatchUpLoadSwitch=true and UnMatchLogKey must be used together. true: Upload logs that failed to parse. false: Do not upload logs that failed to parse.

BeginRegex string: The regex pattern required to match the first line of the log. This is valid only when LogType is multilinelog or fullregexlog. The pattern 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 report time with nanosecond precision. true: Enable nanosecond precision time. false: Disable nanosecond precision time.
FilterKeyRegexes []GetHostGroupRuleExtractRuleFilterKeyRegex: Filter rule list.
Keys []string: List of log field names (Keys).
LogRegex string: The entire log entry must match the regular expression. This is only valid when the log type is fullregex_log. The regular expression must be valid.
LogTemplate GetHostGroupRuleExtractRuleLogTemplate: Automatically extract log fields based on the specified log template.
Quote string: Quotation mark. Content enclosed by quotation marks is parsed as a complete field and not separated. 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 a specified time field in the log is used as the log timestamp, you must provide TimeKey and TimeFormat.
TimeKey string: Field name for the log time field. If a specified time field in the log is used as the log timestamp, you must provide TimeKey and TimeFormat.
TimeSample string: Sample time. Used to verify whether the specified 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.
UnMatchLogKey string: Key name for logs that failed to parse when uploading
UnMatchUpLoadSwitch bool: Upload logs that failed to parse. UnMatchUpLoadSwitch=true and UnMatchLogKey must be used together. true: Upload logs that failed to parse. false: Do not upload logs that failed to parse.

begin_regex string: The regex pattern required to match the first line of the log. This is valid only when LogType is multilinelog or fullregexlog. The pattern must be a valid regular expression.
delimiter string: Log delimiter. Valid only when LogType is delimiter_log.
enable_nanosecond bool: Enable nanosecond precision time. When enabled, log time parsing will report time with nanosecond precision. true: Enable nanosecond precision time. false: Disable nanosecond precision time.
filter_key_regexes list(object): Filter rule list.
keys list(string): List of log field names (Keys).
log_regex string: The entire log entry must match the regular expression. This is only valid when the log type is fullregex_log. The regular expression must be valid.
log_template object: Automatically extract log fields based on the specified log template.
quote string: Quotation mark. Content enclosed by quotation marks is parsed as a complete field and not separated. Only valid when LogType is delimiter_log.
time_extract_regex string: Regular expression for extracting time, used to extract the time value from the TimeKey field and parse it as the collection time.
time_format string: Parsing format for the time field. If a specified time field in the log is used as the log timestamp, you must provide TimeKey and TimeFormat.
time_key string: Field name for the log time field. If a specified time field in the log is used as the log timestamp, you must provide TimeKey and TimeFormat.
time_sample string: Sample time. Used to verify whether the specified time parsing format is correct.
time_zone string: Time zone. Supports machine time zone (default) and custom time zone. Custom time zone supports GMT and UTC.
un_match_log_key string: Key name for logs that failed to parse when uploading
un_match_up_load_switch bool: Upload logs that failed to parse. UnMatchUpLoadSwitch=true and UnMatchLogKey must be used together. true: Upload logs that failed to parse. false: Do not upload logs that failed to parse.

beginRegex String: The regex pattern required to match the first line of the log. This is valid only when LogType is multilinelog or fullregexlog. The pattern 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 report time with nanosecond precision. true: Enable nanosecond precision time. false: Disable nanosecond precision time.
filterKeyRegexes List<GetHostGroupRuleExtractRuleFilterKeyRegex>: Filter rule list.
keys List<String>: List of log field names (Keys).
logRegex String: The entire log entry must match the regular expression. This is only valid when the log type is fullregex_log. The regular expression must be valid.
logTemplate GetHostGroupRuleExtractRuleLogTemplate: Automatically extract log fields based on the specified log template.
quote String: Quotation mark. Content enclosed by quotation marks is parsed as a complete field and not separated. 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 a specified time field in the log is used as the log timestamp, you must provide TimeKey and TimeFormat.
timeKey String: Field name for the log time field. If a specified time field in the log is used as the log timestamp, you must provide TimeKey and TimeFormat.
timeSample String: Sample time. Used to verify whether the specified 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.
unMatchLogKey String: Key name for logs that failed to parse when uploading
unMatchUpLoadSwitch Boolean: Upload logs that failed to parse. UnMatchUpLoadSwitch=true and UnMatchLogKey must be used together. true: Upload logs that failed to parse. false: Do not upload logs that failed to parse.

beginRegex string: The regex pattern required to match the first line of the log. This is valid only when LogType is multilinelog or fullregexlog. The pattern 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 report time with nanosecond precision. true: Enable nanosecond precision time. false: Disable nanosecond precision time.
filterKeyRegexes GetHostGroupRuleExtractRuleFilterKeyRegex[]: Filter rule list.
keys string[]: List of log field names (Keys).
logRegex string: The entire log entry must match the regular expression. This is only valid when the log type is fullregex_log. The regular expression must be valid.
logTemplate GetHostGroupRuleExtractRuleLogTemplate: Automatically extract log fields based on the specified log template.
quote string: Quotation mark. Content enclosed by quotation marks is parsed as a complete field and not separated. 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 a specified time field in the log is used as the log timestamp, you must provide TimeKey and TimeFormat.
timeKey string: Field name for the log time field. If a specified time field in the log is used as the log timestamp, you must provide TimeKey and TimeFormat.
timeSample string: Sample time. Used to verify whether the specified 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.
unMatchLogKey string: Key name for logs that failed to parse when uploading
unMatchUpLoadSwitch boolean: Upload logs that failed to parse. UnMatchUpLoadSwitch=true and UnMatchLogKey must be used together. true: Upload logs that failed to parse. false: Do not upload logs that failed to parse.

begin_regex str: The regex pattern required to match the first line of the log. This is valid only when LogType is multilinelog or fullregexlog. The pattern 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 report time with nanosecond precision. true: Enable nanosecond precision time. false: Disable nanosecond precision time.
filter_key_regexes Sequence[GetHostGroupRuleExtractRuleFilterKeyRegex]: Filter rule list.
keys Sequence[str]: List of log field names (Keys).
log_regex str: The entire log entry must match the regular expression. This is only valid when the log type is fullregex_log. The regular expression must be valid.
log_template GetHostGroupRuleExtractRuleLogTemplate: Automatically extract log fields based on the specified log template.
quote str: Quotation mark. Content enclosed by quotation marks is parsed as a complete field and not separated. 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 a specified time field in the log is used as the log timestamp, you must provide TimeKey and TimeFormat.
time_key str: Field name for the log time field. If a specified time field in the log is used as the log timestamp, you must provide TimeKey and TimeFormat.
time_sample str: Sample time. Used to verify whether the specified 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.
un_match_log_key str: Key name for logs that failed to parse when uploading
un_match_up_load_switch bool: Upload logs that failed to parse. UnMatchUpLoadSwitch=true and UnMatchLogKey must be used together. true: Upload logs that failed to parse. false: Do not upload logs that failed to parse.

beginRegex String: The regex pattern required to match the first line of the log. This is valid only when LogType is multilinelog or fullregexlog. The pattern 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 report time with nanosecond precision. true: Enable nanosecond precision time. false: Disable nanosecond precision time.
filterKeyRegexes List<Property Map>: Filter rule list.
keys List<String>: List of log field names (Keys).
logRegex String: The entire log entry must match the regular expression. This is only valid when the log type is fullregex_log. The regular expression must be valid.
logTemplate Property Map: Automatically extract log fields based on the specified log template.
quote String: Quotation mark. Content enclosed by quotation marks is parsed as a complete field and not separated. 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 a specified time field in the log is used as the log timestamp, you must provide TimeKey and TimeFormat.
timeKey String: Field name for the log time field. If a specified time field in the log is used as the log timestamp, you must provide TimeKey and TimeFormat.
timeSample String: Sample time. Used to verify whether the specified 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.
unMatchLogKey String: Key name for logs that failed to parse when uploading
unMatchUpLoadSwitch Boolean: Upload logs that failed to parse. UnMatchUpLoadSwitch=true and UnMatchLogKey must be used together. true: Upload logs that failed to parse. false: Do not upload logs that failed to parse.

GetHostGroupRuleExtractRuleFilterKeyRegex

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

GetHostGroupRuleExtractRuleLogTemplate

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

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

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

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

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

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

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

GetHostGroupRuleUserDefineRule

Advanced Volcengine.GetHostGroupRuleUserDefineRuleAdvanced: Advanced parameters are 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 conditions for releasing handles are specified, the handle will be released and log file monitoring will end as soon as any condition is met.
EnableHostGroupLabel bool: Whether to upload the Label information of the host group to the log service. Disabled by default. 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): LogCollector does not upload the Label information of the host group.
EnableHostname bool: Whether to upload the hostname field. Default is disabled. true: Adds a field to the original log to record the log source's hostname. Specify the hostname field name using HostnameKey. false (default): Does not add the hostname field.
EnableRawLog bool: Whether to upload raw logs. true: Upload raw logs. false (default): Do not upload raw logs.
Fields List<Volcengine.GetHostGroupRuleUserDefineRuleField>: Add constant fields to logs. Constant fields must follow these restrictions: Up to 5 constant fields can be uploaded. Field name (Key) must be unique and not empty. Length: 1–128 characters, including letters, numbers, and special characters (-*./), and cannot start with an underscore. Field value (Value) must not be empty, maximum length is 512 KiB.
HostGroupLabelKey string: Field name used to store machine group label information.
HostnameKey string: hostname field name. Only required when EnableHostname is set to true.
IgnoreOlder int: Ignore log files that have not been updated for a specified duration, in hours.
MultiCollectsType string: Allows multiple log file collections. Empty: Uses the log file ID (including file inode, device, and checksum of the first N bytes) to uniquely identify the log file. RuleID: Uses the collection rule ID and log file ID to uniquely identify the log file. TopicIDRuleName: Uses the log topic ID, collection rule Name, and log file ID to uniquely identify the log file.
ParsePathRule Volcengine.GetHostGroupRuleUserDefineRuleParsePathRule: Rules for parsing the collection path. After setting the rule, fields in the collection path are extracted using the specified regex and added as metadata to the log data. Note: This parameter is not supported when collecting container standard output.
Plugin Volcengine.GetHostGroupRuleUserDefineRulePlugin: 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: Original log field name. 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 together with the parsed log data
ShardHashKey Volcengine.GetHostGroupRuleUserDefineRuleShardHashKey: 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 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 strategy, specifying whether LogCollector collects incremental logs or full logs. The default is false, which means full log collection. true: incremental collection. When LogCollector collects logs, it only collects newly added content in the file. When a monitored log file receives new log entries, LogCollector is triggered to collect logs. For log files being collected for the first time, 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 new 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, meaning only incremental logs are collected. For log files that are not being collected for the first time, LogCollector determines the collection position based on the Checkpoint and continues collecting. false: (default) full collection. LogCollector collects logs from the beginning of each file, including historical log data.
TailSizeKb int: Incremental collection backtracking threshold, 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 TailSizeKb from the end of the file.

Advanced GetHostGroupRuleUserDefineRuleAdvanced: Advanced parameters are 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 conditions for releasing handles are specified, the handle will be released and log file monitoring will end as soon as any condition is met.
EnableHostGroupLabel bool: Whether to upload the Label information of the host group to the log service. Disabled by default. 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): LogCollector does not upload the Label information of the host group.
EnableHostname bool: Whether to upload the hostname field. Default is disabled. true: Adds a field to the original log to record the log source's hostname. Specify the hostname field name using HostnameKey. false (default): Does not add the hostname field.
EnableRawLog bool: Whether to upload raw logs. true: Upload raw logs. false (default): Do not upload raw logs.
Fields []GetHostGroupRuleUserDefineRuleField: Add constant fields to logs. Constant fields must follow these restrictions: Up to 5 constant fields can be uploaded. Field name (Key) must be unique and not empty. Length: 1–128 characters, including letters, numbers, and special characters (-*./), and cannot start with an underscore. Field value (Value) must not be empty, maximum length is 512 KiB.
HostGroupLabelKey string: Field name used to store machine group label information.
HostnameKey string: hostname field name. Only required when EnableHostname is set to true.
IgnoreOlder int: Ignore log files that have not been updated for a specified duration, in hours.
MultiCollectsType string: Allows multiple log file collections. Empty: Uses the log file ID (including file inode, device, and checksum of the first N bytes) to uniquely identify the log file. RuleID: Uses the collection rule ID and log file ID to uniquely identify the log file. TopicIDRuleName: Uses the log topic ID, collection rule Name, and log file ID to uniquely identify the log file.
ParsePathRule GetHostGroupRuleUserDefineRuleParsePathRule: Rules for parsing the collection path. After setting the rule, fields in the collection path are extracted using the specified regex and added as metadata to the log data. Note: This parameter is not supported when collecting container standard output.
Plugin GetHostGroupRuleUserDefineRulePlugin: 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: Original log field name. 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 together with the parsed log data
ShardHashKey GetHostGroupRuleUserDefineRuleShardHashKey: 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 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 strategy, specifying whether LogCollector collects incremental logs or full logs. The default is false, which means full log collection. true: incremental collection. When LogCollector collects logs, it only collects newly added content in the file. When a monitored log file receives new log entries, LogCollector is triggered to collect logs. For log files being collected for the first time, 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 new 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, meaning only incremental logs are collected. For log files that are not being collected for the first time, LogCollector determines the collection position based on the Checkpoint and continues collecting. false: (default) full collection. LogCollector collects logs from the beginning of each file, including historical log data.
TailSizeKb int: Incremental collection backtracking threshold, 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 TailSizeKb from the end of the file.

advanced object: Advanced parameters are 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 conditions for releasing handles are specified, the handle will be released and log file monitoring will end 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. Disabled by default. 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): LogCollector does not upload the Label information of the host group.
enable_hostname bool: Whether to upload the hostname field. Default is disabled. true: Adds a field to the original log to record the log source's hostname. Specify the hostname field name using HostnameKey. false (default): Does not add the hostname field.
enable_raw_log bool: Whether to upload raw logs. true: Upload raw logs. false (default): Do not upload raw logs.
fields list(object): Add constant fields to logs. Constant fields must follow these restrictions: Up to 5 constant fields can be uploaded. Field name (Key) must be unique and not empty. Length: 1–128 characters, including letters, numbers, and special characters (-*./), and cannot start with an underscore. Field value (Value) must not be empty, maximum length is 512 KiB.
host_group_label_key string: Field name used to store machine group label information.
hostname_key string: hostname field name. Only required when EnableHostname is set to true.
ignore_older number: Ignore log files that have not been updated for a specified duration, in hours.
multi_collects_type string: Allows multiple log file collections. Empty: Uses the log file ID (including file inode, device, and checksum of the first N bytes) to uniquely identify the log file. RuleID: Uses the collection rule ID and log file ID to uniquely identify the log file. TopicIDRuleName: Uses the log topic ID, collection rule Name, and log file ID to uniquely identify the log file.
parse_path_rule object: Rules for parsing the collection path. After setting the rule, fields in the collection path are extracted using the specified regex and added as metadata to the log data. Note: This parameter is not supported when collecting container standard output.
plugin object: 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 string: Original log field name. 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 together with the parsed log data
shard_hash_key object: 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 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 strategy, specifying whether LogCollector collects incremental logs or full logs. The default is false, which means full log collection. true: incremental collection. When LogCollector collects logs, it only collects newly added content in the file. When a monitored log file receives new log entries, LogCollector is triggered to collect logs. For log files being collected for the first time, 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 new 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, meaning only incremental logs are collected. For log files that are not being collected for the first time, LogCollector determines the collection position based on the Checkpoint and continues collecting. false: (default) full collection. LogCollector collects logs from the beginning of each file, including historical log data.
tail_size_kb number: Incremental collection backtracking threshold, 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 TailSizeKb from the end of the file.

advanced GetHostGroupRuleUserDefineRuleAdvanced: Advanced parameters are 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 conditions for releasing handles are specified, the handle will be released and log file monitoring will end as soon as any condition is met.
enableHostGroupLabel Boolean: Whether to upload the Label information of the host group to the log service. Disabled by default. 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): LogCollector does not upload the Label information of the host group.
enableHostname Boolean: Whether to upload the hostname field. Default is disabled. true: Adds a field to the original log to record the log source's hostname. Specify the hostname field name using HostnameKey. false (default): Does not add the hostname field.
enableRawLog Boolean: Whether to upload raw logs. true: Upload raw logs. false (default): Do not upload raw logs.
fields List<GetHostGroupRuleUserDefineRuleField>: Add constant fields to logs. Constant fields must follow these restrictions: Up to 5 constant fields can be uploaded. Field name (Key) must be unique and not empty. Length: 1–128 characters, including letters, numbers, and special characters (-*./), and cannot start with an underscore. Field value (Value) must not be empty, maximum length is 512 KiB.
hostGroupLabelKey String: Field name used to store machine group label information.
hostnameKey String: hostname field name. Only required when EnableHostname is set to true.
ignoreOlder Integer: Ignore log files that have not been updated for a specified duration, in hours.
multiCollectsType String: Allows multiple log file collections. Empty: Uses the log file ID (including file inode, device, and checksum of the first N bytes) to uniquely identify the log file. RuleID: Uses the collection rule ID and log file ID to uniquely identify the log file. TopicIDRuleName: Uses the log topic ID, collection rule Name, and log file ID to uniquely identify the log file.
parsePathRule GetHostGroupRuleUserDefineRuleParsePathRule: Rules for parsing the collection path. After setting the rule, fields in the collection path are extracted using the specified regex and added as metadata to the log data. Note: This parameter is not supported when collecting container standard output.
plugin GetHostGroupRuleUserDefineRulePlugin: 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: Original log field name. 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 together with the parsed log data
shardHashKey GetHostGroupRuleUserDefineRuleShardHashKey: 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 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 strategy, specifying whether LogCollector collects incremental logs or full logs. The default is false, which means full log collection. true: incremental collection. When LogCollector collects logs, it only collects newly added content in the file. When a monitored log file receives new log entries, LogCollector is triggered to collect logs. For log files being collected for the first time, 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 new 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, meaning only incremental logs are collected. For log files that are not being collected for the first time, LogCollector determines the collection position based on the Checkpoint and continues collecting. false: (default) full collection. LogCollector collects logs from the beginning of each file, including historical log data.
tailSizeKb Integer: Incremental collection backtracking threshold, 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 TailSizeKb from the end of the file.

advanced GetHostGroupRuleUserDefineRuleAdvanced: Advanced parameters are 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 conditions for releasing handles are specified, the handle will be released and log file monitoring will end as soon as any condition is met.
enableHostGroupLabel boolean: Whether to upload the Label information of the host group to the log service. Disabled by default. 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): LogCollector does not upload the Label information of the host group.
enableHostname boolean: Whether to upload the hostname field. Default is disabled. true: Adds a field to the original log to record the log source's hostname. Specify the hostname field name using HostnameKey. false (default): Does not add the hostname field.
enableRawLog boolean: Whether to upload raw logs. true: Upload raw logs. false (default): Do not upload raw logs.
fields GetHostGroupRuleUserDefineRuleField[]: Add constant fields to logs. Constant fields must follow these restrictions: Up to 5 constant fields can be uploaded. Field name (Key) must be unique and not empty. Length: 1–128 characters, including letters, numbers, and special characters (-*./), and cannot start with an underscore. Field value (Value) must not be empty, maximum length is 512 KiB.
hostGroupLabelKey string: Field name used to store machine group label information.
hostnameKey string: hostname field name. Only required when EnableHostname is set to true.
ignoreOlder number: Ignore log files that have not been updated for a specified duration, in hours.
multiCollectsType string: Allows multiple log file collections. Empty: Uses the log file ID (including file inode, device, and checksum of the first N bytes) to uniquely identify the log file. RuleID: Uses the collection rule ID and log file ID to uniquely identify the log file. TopicIDRuleName: Uses the log topic ID, collection rule Name, and log file ID to uniquely identify the log file.
parsePathRule GetHostGroupRuleUserDefineRuleParsePathRule: Rules for parsing the collection path. After setting the rule, fields in the collection path are extracted using the specified regex and added as metadata to the log data. Note: This parameter is not supported when collecting container standard output.
plugin GetHostGroupRuleUserDefineRulePlugin: 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: Original log field name. 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 together with the parsed log data
shardHashKey GetHostGroupRuleUserDefineRuleShardHashKey: 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 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 strategy, specifying whether LogCollector collects incremental logs or full logs. The default is false, which means full log collection. true: incremental collection. When LogCollector collects logs, it only collects newly added content in the file. When a monitored log file receives new log entries, LogCollector is triggered to collect logs. For log files being collected for the first time, 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 new 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, meaning only incremental logs are collected. For log files that are not being collected for the first time, LogCollector determines the collection position based on the Checkpoint and continues collecting. false: (default) full collection. LogCollector collects logs from the beginning of each file, including historical log data.
tailSizeKb number: Incremental collection backtracking threshold, 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 TailSizeKb from the end of the file.

advanced GetHostGroupRuleUserDefineRuleAdvanced: Advanced parameters are 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 conditions for releasing handles are specified, the handle will be released and log file monitoring will end 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. Disabled by default. 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): LogCollector does not upload the Label information of the host group.
enable_hostname bool: Whether to upload the hostname field. Default is disabled. true: Adds a field to the original log to record the log source's hostname. Specify the hostname field name using HostnameKey. false (default): Does not add the hostname field.
enable_raw_log bool: Whether to upload raw logs. true: Upload raw logs. false (default): Do not upload raw logs.
fields Sequence[GetHostGroupRuleUserDefineRuleField]: Add constant fields to logs. Constant fields must follow these restrictions: Up to 5 constant fields can be uploaded. Field name (Key) must be unique and not empty. Length: 1–128 characters, including letters, numbers, and special characters (-*./), and cannot start with an underscore. Field value (Value) must not be empty, maximum length is 512 KiB.
host_group_label_key str: Field name used to store machine group label information.
hostname_key str: hostname field name. Only required when EnableHostname is set to true.
ignore_older int: Ignore log files that have not been updated for a specified duration, in hours.
multi_collects_type str: Allows multiple log file collections. Empty: Uses the log file ID (including file inode, device, and checksum of the first N bytes) to uniquely identify the log file. RuleID: Uses the collection rule ID and log file ID to uniquely identify the log file. TopicIDRuleName: Uses the log topic ID, collection rule Name, and log file ID to uniquely identify the log file.
parse_path_rule GetHostGroupRuleUserDefineRuleParsePathRule: Rules for parsing the collection path. After setting the rule, fields in the collection path are extracted using the specified regex and added as metadata to the log data. Note: This parameter is not supported when collecting container standard output.
plugin GetHostGroupRuleUserDefineRulePlugin: 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: Original log field name. 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 together with the parsed log data
shard_hash_key GetHostGroupRuleUserDefineRuleShardHashKey: 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 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 strategy, specifying whether LogCollector collects incremental logs or full logs. The default is false, which means full log collection. true: incremental collection. When LogCollector collects logs, it only collects newly added content in the file. When a monitored log file receives new log entries, LogCollector is triggered to collect logs. For log files being collected for the first time, 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 new 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, meaning only incremental logs are collected. For log files that are not being collected for the first time, LogCollector determines the collection position based on the 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: Incremental collection backtracking threshold, 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 TailSizeKb from the end of the file.

advanced Property Map: Advanced parameters are 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 conditions for releasing handles are specified, the handle will be released and log file monitoring will end as soon as any condition is met.
enableHostGroupLabel Boolean: Whether to upload the Label information of the host group to the log service. Disabled by default. 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): LogCollector does not upload the Label information of the host group.
enableHostname Boolean: Whether to upload the hostname field. Default is disabled. true: Adds a field to the original log to record the log source's hostname. Specify the hostname field name using HostnameKey. false (default): Does not add the hostname field.
enableRawLog Boolean: Whether to 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: Up to 5 constant fields can be uploaded. Field name (Key) must be unique and not empty. Length: 1–128 characters, including letters, numbers, and special characters (-*./), and cannot start with an underscore. Field value (Value) must not be empty, maximum length is 512 KiB.
hostGroupLabelKey String: Field name used to store machine group label information.
hostnameKey String: hostname field name. Only required when EnableHostname is set to true.
ignoreOlder Number: Ignore log files that have not been updated for a specified duration, in hours.
multiCollectsType String: Allows multiple log file collections. Empty: Uses the log file ID (including file inode, device, and checksum of the first N bytes) to uniquely identify the log file. RuleID: Uses the collection rule ID and log file ID to uniquely identify the log file. TopicIDRuleName: Uses the log topic ID, collection rule Name, and log file ID to uniquely identify the log file.
parsePathRule Property Map: Rules for parsing the collection path. After setting the rule, fields in the collection path are extracted using the specified regex 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: Original log field name. 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 together 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 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 strategy, specifying whether LogCollector collects incremental logs or full logs. The default is false, which means full log collection. true: incremental collection. When LogCollector collects logs, it only collects newly added content in the file. When a monitored log file receives new log entries, LogCollector is triggered to collect logs. For log files being collected for the first time, 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 new 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, meaning only incremental logs are collected. For log files that are not being collected for the first time, LogCollector determines the collection position based on the Checkpoint and continues collecting. false: (default) full collection. LogCollector collects logs from the beginning of each file, including historical log data.
tailSizeKb Number: Incremental collection backtracking threshold, 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 TailSizeKb from the end of the file.

GetHostGroupRuleUserDefineRuleAdvanced

CloseEof bool: After reading to the end of the log file, whether to release the file handle. Default is false.
CloseInactive int: Wait time before releasing log file handles. If no new logs are written to a log file for the specified duration, the handle for that log file is released. Unit: seconds. Range: 1–300 seconds. Default: 60 seconds.
CloseRemoved bool: Whether to release the handle of the log file after it is removed. Default is false.
CloseRenamed bool: Whether to release the handle of the log file after it is renamed. Default is false.
CloseTimeout int: Maximum duration for LogCollector to monitor log files, in seconds. The default is 0 seconds, meaning LogCollector does not limit the monitoring duration. Timing starts when LogCollector begins monitoring the log file. After the specified duration is exceeded, regardless of whether the log file has been fully read, LogCollector immediately releases the file handle and stops monitoring.
NoLineTerminatorEofMaxTime int: Maximum wait time when LogCollector does not read a line break. Unit: seconds. Default: 5s. LogCollector starts timing when it begins reading log file content. If no line break is read within the specified time, it will send the buffered logs. If the file write interval is large, 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, whether to release the file handle. Default is false.
CloseInactive int: Wait time before releasing log file handles. If no new logs are written to a log file for the specified duration, the handle for that log file is released. Unit: seconds. Range: 1–300 seconds. Default: 60 seconds.
CloseRemoved bool: Whether to release the handle of the log file after it is removed. Default is false.
CloseRenamed bool: Whether to release the handle of the log file after it is renamed. Default is false.
CloseTimeout int: Maximum duration for LogCollector to monitor log files, in seconds. The default is 0 seconds, meaning LogCollector does not limit the monitoring duration. Timing starts when LogCollector begins monitoring the log file. After the specified duration is exceeded, regardless of whether the log file has been fully read, LogCollector immediately releases the file handle and stops monitoring.
NoLineTerminatorEofMaxTime int: Maximum wait time when LogCollector does not read a line break. Unit: seconds. Default: 5s. LogCollector starts timing when it begins reading log file content. If no line break is read within the specified time, it will send the buffered logs. If the file write interval is large, 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, whether to release the file handle. Default is false.
close_inactive number: Wait time before releasing log file handles. If no new logs are written to a log file for the specified duration, the handle for that log file is released. Unit: seconds. Range: 1–300 seconds. Default: 60 seconds.
close_removed bool: Whether to release the handle of the log file after it is removed. Default is false.
close_renamed bool: Whether to release the handle of the log file after it is renamed. Default is false.
close_timeout number: Maximum duration for LogCollector to monitor log files, in seconds. The default is 0 seconds, meaning LogCollector does not limit the monitoring duration. Timing starts when LogCollector begins monitoring the log file. After the specified duration is exceeded, regardless of whether the log file has been fully read, LogCollector immediately releases the file handle and stops monitoring.
no_line_terminator_eof_max_time number: Maximum wait time when LogCollector does not read a line break. Unit: seconds. Default: 5s. LogCollector starts timing when it begins reading log file content. If no line break is read within the specified time, it will send the buffered logs. If the file write interval is large, 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, whether to release the file handle. Default is false.
closeInactive Integer: Wait time before releasing log file handles. If no new logs are written to a log file for the specified duration, the handle for that log file is released. Unit: seconds. Range: 1–300 seconds. Default: 60 seconds.
closeRemoved Boolean: Whether to release the handle of the log file after it is removed. Default is false.
closeRenamed Boolean: Whether to release the handle of the log file after it is renamed. Default is false.
closeTimeout Integer: Maximum duration for LogCollector to monitor log files, in seconds. The default is 0 seconds, meaning LogCollector does not limit the monitoring duration. Timing starts when LogCollector begins monitoring the log file. After the specified duration is exceeded, regardless of whether the log file has been fully read, LogCollector immediately releases the file handle and stops monitoring.
noLineTerminatorEofMaxTime Integer: Maximum wait time when LogCollector does not read a line break. Unit: seconds. Default: 5s. LogCollector starts timing when it begins reading log file content. If no line break is read within the specified time, it will send the buffered logs. If the file write interval is large, 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, whether to release the file handle. Default is false.
closeInactive number: Wait time before releasing log file handles. If no new logs are written to a log file for the specified duration, the handle for that log file is released. Unit: seconds. Range: 1–300 seconds. Default: 60 seconds.
closeRemoved boolean: Whether to release the handle of the log file after it is removed. Default is false.
closeRenamed boolean: Whether to release the handle of the log file after it is renamed. Default is false.
closeTimeout number: Maximum duration for LogCollector to monitor log files, in seconds. The default is 0 seconds, meaning LogCollector does not limit the monitoring duration. Timing starts when LogCollector begins monitoring the log file. After the specified duration is exceeded, regardless of whether the log file has been fully read, LogCollector immediately releases the file handle and stops monitoring.
noLineTerminatorEofMaxTime number: Maximum wait time when LogCollector does not read a line break. Unit: seconds. Default: 5s. LogCollector starts timing when it begins reading log file content. If no line break is read within the specified time, it will send the buffered logs. If the file write interval is large, 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, whether to release the file handle. Default is false.
close_inactive int: Wait time before releasing log file handles. If no new logs are written to a log file for the specified duration, the handle for that log file is released. Unit: seconds. Range: 1–300 seconds. Default: 60 seconds.
close_removed bool: Whether to release the handle of the log file after it is removed. Default is false.
close_renamed bool: Whether to release the handle of the log file after it is renamed. Default is false.
close_timeout int: Maximum duration for LogCollector to monitor log files, in seconds. The default is 0 seconds, meaning LogCollector does not limit the monitoring duration. Timing starts when LogCollector begins monitoring the log file. After the specified duration is exceeded, regardless of whether the log file has been fully read, LogCollector immediately releases the file handle and stops monitoring.
no_line_terminator_eof_max_time int: Maximum wait time when LogCollector does not read a line break. Unit: seconds. Default: 5s. LogCollector starts timing when it begins reading log file content. If no line break is read within the specified time, it will send the buffered logs. If the file write interval is large, 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, whether to release the file handle. Default is false.
closeInactive Number: Wait time before releasing log file handles. If no new logs are written to a log file for the specified duration, the handle for that log file is released. Unit: seconds. Range: 1–300 seconds. Default: 60 seconds.
closeRemoved Boolean: Whether to release the handle of the log file after it is removed. Default is false.
closeRenamed Boolean: Whether to release the handle of the log file after it is renamed. Default is false.
closeTimeout Number: Maximum duration for LogCollector to monitor log files, in seconds. The default is 0 seconds, meaning LogCollector does not limit the monitoring duration. Timing starts when LogCollector begins monitoring the log file. After the specified duration is exceeded, regardless of whether the log file has been fully read, LogCollector immediately releases the file handle and stops monitoring.
noLineTerminatorEofMaxTime Number: Maximum wait time when LogCollector does not read a line break. Unit: seconds. Default: 5s. LogCollector starts timing when it begins reading log file content. If no line break is read within the specified time, it will send the buffered logs. If the file write interval is large, a complete log entry may be split into two parts and written separately. Adjust this parameter based on your log write interval.

GetHostGroupRuleUserDefineRuleField

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 string: Key.
val string: Value.

key str: Key.
val str: Value.

key String: Key.
val String: Value.

GetHostGroupRuleUserDefineRuleParsePathRule

Keys List<string>: List of field names. Log Service parses PathSample into multiple fields using regular expressions (Regex). 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 path must be an absolute path. Wildcards *, ?, ** are not allowed in the sample path.
Regex string: Regular expression used to extract the path field. It must match the example collection path; otherwise, extraction will fail.

Keys []string: List of field names. Log Service parses PathSample into multiple fields using regular expressions (Regex). 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 path must be an absolute path. Wildcards *, ?, ** are not allowed in the sample path.
Regex string: Regular expression used to extract the path field. It must match the example collection path; otherwise, extraction will fail.

keys list(string): List of field names. Log Service parses PathSample into multiple fields using regular expressions (Regex). Keys specify the name of each field. You can configure up to 100 field names. Field names cannot be empty or duplicated.
path_sample string: Sample collection path for actual scenarios. The sample path must be an absolute path. Wildcards *, ?, ** are not allowed in the sample path.
regex string: Regular expression used to extract the path field. It must match the example collection path; otherwise, extraction will fail.

keys List<String>: List of field names. Log Service parses PathSample into multiple fields using regular expressions (Regex). 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 path must be an absolute path. Wildcards *, ?, ** are not allowed in the sample path.
regex String: Regular expression used to extract the path field. It must match the example collection path; otherwise, extraction will fail.

keys string[]: List of field names. Log Service parses PathSample into multiple fields using regular expressions (Regex). 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 path must be an absolute path. Wildcards *, ?, ** are not allowed in the sample path.
regex string: Regular expression used to extract the path field. It must match the example collection path; otherwise, extraction will fail.

keys Sequence[str]: List of field names. Log Service parses PathSample into multiple fields using regular expressions (Regex). 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 path must be an absolute path. Wildcards *, ?, ** are not allowed in the sample path.
regex str: Regular expression used to extract the path field. It must match the example collection path; otherwise, extraction will fail.

keys List<String>: List of field names. Log Service parses PathSample into multiple fields using regular expressions (Regex). 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 path must be an absolute path. Wildcards *, ?, ** are not allowed in the sample path.
regex String: Regular expression used to extract the path field. It must match the example collection path; otherwise, extraction will fail.

GetHostGroupRuleUserDefineRulePlugin

Processors string: LogCollector plugins. For supported plugin lists and parameter descriptions, see LogCollector plugin overview.

Processors string: LogCollector plugins. For supported plugin lists and parameter descriptions, see LogCollector plugin overview.

processors string: LogCollector plugins. For supported plugin lists and parameter descriptions, see LogCollector plugin overview.

processors String: LogCollector plugins. For supported plugin lists and parameter descriptions, see LogCollector plugin overview.

processors string: LogCollector plugins. For supported plugin lists and parameter descriptions, see LogCollector plugin overview.

processors str: LogCollector plugins. For supported plugin lists and parameter descriptions, see LogCollector plugin overview.

processors String: LogCollector plugins. For supported plugin lists and parameter descriptions, see LogCollector plugin overview.

GetHostGroupRuleUserDefineRuleShardHashKey

HashKey string: The HashKey of the log group specifies the shard where the current log group will be written. The valid range for this parameter is [00000000000000000000000000000000-ffffffffffffffffffffffffffffffff).

HashKey string: The HashKey of the log group specifies the shard where the current log group will be written. The valid range for this parameter is [00000000000000000000000000000000-ffffffffffffffffffffffffffffffff).

hash_key string: The HashKey of the log group specifies the shard where the current log group will be written. The valid range for this parameter is [00000000000000000000000000000000-ffffffffffffffffffffffffffffffff).

hashKey String: The HashKey of the log group specifies the shard where the current log group will be written. The valid range for this parameter is [00000000000000000000000000000000-ffffffffffffffffffffffffffffffff).

hashKey string: The HashKey of the log group specifies the shard where the current log group will be written. The valid range for this parameter is [00000000000000000000000000000000-ffffffffffffffffffffffffffffffff).

hash_key str: The HashKey of the log group specifies the shard where the current log group will be written. The valid range for this parameter is [00000000000000000000000000000000-ffffffffffffffffffffffffffffffff).

hashKey String: The HashKey of the log group specifies the shard where the current log group will be written. The valid 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.

Viewing docs for volcenginecc v0.0.50
published on Monday, Jul 20, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

volcenginecc.tls.getHostGroup

On this page

On this page

Using getHostGroup

getHostGroup Result

Supporting Types

GetHostGroupRule

GetHostGroupRuleContainerRule

GetHostGroupRuleContainerRuleEnvTag

GetHostGroupRuleContainerRuleExcludeContainerEnvRegex

GetHostGroupRuleContainerRuleExcludeContainerLabelRegex

GetHostGroupRuleContainerRuleIncludeContainerEnvRegex

GetHostGroupRuleContainerRuleIncludeContainerLabelRegex

GetHostGroupRuleContainerRuleKubernetesRule

GetHostGroupRuleContainerRuleKubernetesRuleAnnotationTag

GetHostGroupRuleContainerRuleKubernetesRuleExcludePodAnnotationRegex

GetHostGroupRuleContainerRuleKubernetesRuleExcludePodLabelRegex

GetHostGroupRuleContainerRuleKubernetesRuleIncludePodAnnotationRegex

GetHostGroupRuleContainerRuleKubernetesRuleIncludePodLabelRegex

GetHostGroupRuleContainerRuleKubernetesRuleLabelTag

GetHostGroupRuleExcludePath

GetHostGroupRuleExtractRule

GetHostGroupRuleExtractRuleFilterKeyRegex

GetHostGroupRuleExtractRuleLogTemplate

GetHostGroupRuleUserDefineRule

GetHostGroupRuleUserDefineRuleAdvanced

GetHostGroupRuleUserDefineRuleField

GetHostGroupRuleUserDefineRuleParsePathRule

GetHostGroupRuleUserDefineRulePlugin

GetHostGroupRuleUserDefineRuleShardHashKey

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

volcenginecc.tls.getHostGroup

On this page

On this page

Using getHostGroup

getHostGroup Result

Supporting Types

GetHostGroupRule

GetHostGroupRuleContainerRule

GetHostGroupRuleContainerRuleEnvTag

GetHostGroupRuleContainerRuleExcludeContainerEnvRegex

GetHostGroupRuleContainerRuleExcludeContainerLabelRegex

GetHostGroupRuleContainerRuleIncludeContainerEnvRegex

GetHostGroupRuleContainerRuleIncludeContainerLabelRegex

GetHostGroupRuleContainerRuleKubernetesRule

GetHostGroupRuleContainerRuleKubernetesRuleAnnotationTag

GetHostGroupRuleContainerRuleKubernetesRuleExcludePodAnnotationRegex

GetHostGroupRuleContainerRuleKubernetesRuleExcludePodLabelRegex

GetHostGroupRuleContainerRuleKubernetesRuleIncludePodAnnotationRegex

GetHostGroupRuleContainerRuleKubernetesRuleIncludePodLabelRegex

GetHostGroupRuleContainerRuleKubernetesRuleLabelTag

GetHostGroupRuleExcludePath

GetHostGroupRuleExtractRule

GetHostGroupRuleExtractRuleFilterKeyRegex

GetHostGroupRuleExtractRuleLogTemplate

GetHostGroupRuleUserDefineRule

GetHostGroupRuleUserDefineRuleAdvanced

GetHostGroupRuleUserDefineRuleField

GetHostGroupRuleUserDefineRuleParsePathRule

GetHostGroupRuleUserDefineRulePlugin

GetHostGroupRuleUserDefineRuleShardHashKey

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.