published on Monday, Jul 20, 2026 by Byteplus
published on Monday, Jul 20, 2026 by Byteplus
Machine group in Log Service, used to manage a group of log collection machines.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as bytepluscc from "@byteplus/pulumi-bytepluscc";
const tLSHostGroupDemo = new bytepluscc.tls.HostGroup("TLSHostGroupDemo", {
autoUpdate: true,
hostGroupName: "ccapi-test-1",
hostGroupType: "IP",
hostIpLists: [
"192.168.1.1",
"192.168.1.2",
],
serviceLogging: false,
updateEndTime: "06:00",
updateStartTime: "00:00",
iamProjectName: "default",
});
import pulumi
import pulumi_bytepluscc as bytepluscc
t_ls_host_group_demo = bytepluscc.tls.HostGroup("TLSHostGroupDemo",
auto_update=True,
host_group_name="ccapi-test-1",
host_group_type="IP",
host_ip_lists=[
"192.168.1.1",
"192.168.1.2",
],
service_logging=False,
update_end_time="06:00",
update_start_time="00:00",
iam_project_name="default")
package main
import (
"github.com/byteplus-sdk/pulumi-bytepluscc/sdk/go/bytepluscc/tls"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := tls.NewHostGroup(ctx, "TLSHostGroupDemo", &tls.HostGroupArgs{
AutoUpdate: pulumi.Bool(true),
HostGroupName: pulumi.String("ccapi-test-1"),
HostGroupType: pulumi.String("IP"),
HostIpLists: pulumi.StringArray{
pulumi.String("192.168.1.1"),
pulumi.String("192.168.1.2"),
},
ServiceLogging: pulumi.Bool(false),
UpdateEndTime: pulumi.String("06:00"),
UpdateStartTime: pulumi.String("00:00"),
IamProjectName: pulumi.String("default"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Bytepluscc = Byteplus.Pulumi.Bytepluscc;
return await Deployment.RunAsync(() =>
{
var tLSHostGroupDemo = new Bytepluscc.Tls.HostGroup("TLSHostGroupDemo", new()
{
AutoUpdate = true,
HostGroupName = "ccapi-test-1",
HostGroupType = "IP",
HostIpLists = new[]
{
"192.168.1.1",
"192.168.1.2",
},
ServiceLogging = false,
UpdateEndTime = "06:00",
UpdateStartTime = "00:00",
IamProjectName = "default",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.byteplus.bytepluscc.tls.HostGroup;
import com.byteplus.bytepluscc.tls.HostGroupArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var tLSHostGroupDemo = new HostGroup("tLSHostGroupDemo", HostGroupArgs.builder()
.autoUpdate(true)
.hostGroupName("ccapi-test-1")
.hostGroupType("IP")
.hostIpLists(
"192.168.1.1",
"192.168.1.2")
.serviceLogging(false)
.updateEndTime("06:00")
.updateStartTime("00:00")
.iamProjectName("default")
.build());
}
}
resources:
tLSHostGroupDemo:
type: bytepluscc:tls:HostGroup
name: TLSHostGroupDemo
properties:
autoUpdate: true
hostGroupName: ccapi-test-1
hostGroupType: IP
hostIpLists:
- 192.168.1.1
- 192.168.1.2
serviceLogging: false
updateEndTime: 06:00
updateStartTime: 00:00
iamProjectName: default
pulumi {
required_providers {
bytepluscc = {
source = "pulumi/bytepluscc"
}
}
}
resource "bytepluscc_tls_hostgroup" "TLSHostGroupDemo" {
auto_update = true
host_group_name = "ccapi-test-1"
host_group_type = "IP"
host_ip_lists = ["192.168.1.1", "192.168.1.2"]
service_logging = false
update_end_time = "06:00"
update_start_time = "00:00"
iam_project_name = "default"
}
Create HostGroup Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new HostGroup(name: string, args: HostGroupArgs, opts?: CustomResourceOptions);@overload
def HostGroup(resource_name: str,
args: HostGroupArgs,
opts: Optional[ResourceOptions] = None)
@overload
def HostGroup(resource_name: str,
opts: Optional[ResourceOptions] = None,
host_group_name: Optional[str] = None,
host_group_type: Optional[str] = None,
auto_update: Optional[bool] = None,
delete_abnormal_hosts: Optional[bool] = None,
host_identifier: Optional[str] = None,
host_ip_lists: Optional[Sequence[str]] = None,
iam_project_name: Optional[str] = None,
service_logging: Optional[bool] = None,
update_end_time: Optional[str] = None,
update_start_time: Optional[str] = None)func NewHostGroup(ctx *Context, name string, args HostGroupArgs, opts ...ResourceOption) (*HostGroup, error)public HostGroup(string name, HostGroupArgs args, CustomResourceOptions? opts = null)
public HostGroup(String name, HostGroupArgs args)
public HostGroup(String name, HostGroupArgs args, CustomResourceOptions options)
type: bytepluscc:tls:HostGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "bytepluscc_tls_host_group" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args HostGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args HostGroupArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args HostGroupArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args HostGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args HostGroupArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var hostGroupResource = new Bytepluscc.Tls.HostGroup("hostGroupResource", new()
{
HostGroupName = "string",
HostGroupType = "string",
AutoUpdate = false,
DeleteAbnormalHosts = false,
HostIdentifier = "string",
HostIpLists = new[]
{
"string",
},
IamProjectName = "string",
ServiceLogging = false,
UpdateEndTime = "string",
UpdateStartTime = "string",
});
example, err := tls.NewHostGroup(ctx, "hostGroupResource", &tls.HostGroupArgs{
HostGroupName: pulumi.String("string"),
HostGroupType: pulumi.String("string"),
AutoUpdate: pulumi.Bool(false),
DeleteAbnormalHosts: pulumi.Bool(false),
HostIdentifier: pulumi.String("string"),
HostIpLists: pulumi.StringArray{
pulumi.String("string"),
},
IamProjectName: pulumi.String("string"),
ServiceLogging: pulumi.Bool(false),
UpdateEndTime: pulumi.String("string"),
UpdateStartTime: pulumi.String("string"),
})
resource "bytepluscc_tls_host_group" "hostGroupResource" {
lifecycle {
create_before_destroy = true
}
host_group_name = "string"
host_group_type = "string"
auto_update = false
delete_abnormal_hosts = false
host_identifier = "string"
host_ip_lists = ["string"]
iam_project_name = "string"
service_logging = false
update_end_time = "string"
update_start_time = "string"
}
var hostGroupResource = new com.byteplus.bytepluscc.tls.HostGroup("hostGroupResource", com.byteplus.bytepluscc.tls.HostGroupArgs.builder()
.hostGroupName("string")
.hostGroupType("string")
.autoUpdate(false)
.deleteAbnormalHosts(false)
.hostIdentifier("string")
.hostIpLists("string")
.iamProjectName("string")
.serviceLogging(false)
.updateEndTime("string")
.updateStartTime("string")
.build());
host_group_resource = bytepluscc.tls.HostGroup("hostGroupResource",
host_group_name="string",
host_group_type="string",
auto_update=False,
delete_abnormal_hosts=False,
host_identifier="string",
host_ip_lists=["string"],
iam_project_name="string",
service_logging=False,
update_end_time="string",
update_start_time="string")
const hostGroupResource = new bytepluscc.tls.HostGroup("hostGroupResource", {
hostGroupName: "string",
hostGroupType: "string",
autoUpdate: false,
deleteAbnormalHosts: false,
hostIdentifier: "string",
hostIpLists: ["string"],
iamProjectName: "string",
serviceLogging: false,
updateEndTime: "string",
updateStartTime: "string",
});
type: bytepluscc:tls:HostGroup
properties:
autoUpdate: false
deleteAbnormalHosts: false
hostGroupName: string
hostGroupType: string
hostIdentifier: string
hostIpLists:
- string
iamProjectName: string
serviceLogging: false
updateEndTime: string
updateStartTime: string
HostGroup Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The HostGroup resource accepts the following input properties:
- Host
Group stringName - Host group name
- Host
Group stringType - 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.
- 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.
- Delete
Abnormal boolHosts - Clean all machines with abnormal heartbeat in the machine group with one click. Machines without heartbeat records cannot be deleted currently
- Host
Identifier string - Machine identifier. Required when HostGroupType is Label.
- Host
Ip List<string>Lists - List of IP addresses for the host group. Required when HostGroupType is IP.
- Iam
Project stringName - IAM project name. If this parameter is not specified, Log Service adds the machine group to the IAM project named default.
- Service
Logging bool - Enable Logcollector service log feature. true: enabled. false: (default) disabled.
- Update
End stringTime - 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 stringTime - 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.
- Host
Group stringName - Host group name
- Host
Group stringType - 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.
- 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.
- Delete
Abnormal boolHosts - Clean all machines with abnormal heartbeat in the machine group with one click. Machines without heartbeat records cannot be deleted currently
- Host
Identifier string - Machine identifier. Required when HostGroupType is Label.
- Host
Ip []stringLists - List of IP addresses for the host group. Required when HostGroupType is IP.
- Iam
Project stringName - IAM project name. If this parameter is not specified, Log Service adds the machine group to the IAM project named default.
- Service
Logging bool - Enable Logcollector service log feature. true: enabled. false: (default) disabled.
- Update
End stringTime - 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 stringTime - 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.
- host_
group_ stringname - Host group name
- host_
group_ stringtype - 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.
- 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.
- delete_
abnormal_ boolhosts - Clean all machines with abnormal heartbeat in the machine group with one click. Machines without heartbeat records cannot be deleted currently
- host_
identifier string - Machine identifier. Required when HostGroupType is Label.
- host_
ip_ list(string)lists - List of IP addresses for the host group. Required when HostGroupType is IP.
- iam_
project_ stringname - IAM project name. If this parameter is not specified, Log Service adds the machine group to the IAM project named default.
- service_
logging bool - Enable Logcollector service log feature. true: enabled. false: (default) disabled.
- update_
end_ stringtime - 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_ stringtime - 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.
- host
Group StringName - Host group name
- host
Group StringType - 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.
- auto
Update 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.
- delete
Abnormal BooleanHosts - Clean all machines with abnormal heartbeat in the machine group with one click. Machines without heartbeat records cannot be deleted currently
- host
Identifier String - Machine identifier. Required when HostGroupType is Label.
- host
Ip List<String>Lists - List of IP addresses for the host group. Required when HostGroupType is IP.
- iam
Project StringName - IAM project name. If this parameter is not specified, Log Service adds the machine group to the IAM project named default.
- service
Logging Boolean - Enable Logcollector service log feature. true: enabled. false: (default) disabled.
- update
End StringTime - 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 StringTime - 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.
- host
Group stringName - Host group name
- host
Group stringType - 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.
- auto
Update 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.
- delete
Abnormal booleanHosts - Clean all machines with abnormal heartbeat in the machine group with one click. Machines without heartbeat records cannot be deleted currently
- host
Identifier string - Machine identifier. Required when HostGroupType is Label.
- host
Ip string[]Lists - List of IP addresses for the host group. Required when HostGroupType is IP.
- iam
Project stringName - IAM project name. If this parameter is not specified, Log Service adds the machine group to the IAM project named default.
- service
Logging boolean - Enable Logcollector service log feature. true: enabled. false: (default) disabled.
- update
End stringTime - 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 stringTime - 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.
- host_
group_ strname - Host group name
- host_
group_ strtype - 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.
- 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.
- delete_
abnormal_ boolhosts - Clean all machines with abnormal heartbeat in the machine group with one click. Machines without heartbeat records cannot be deleted currently
- host_
identifier str - Machine identifier. Required when HostGroupType is Label.
- host_
ip_ Sequence[str]lists - List of IP addresses for the host group. Required when HostGroupType is IP.
- iam_
project_ strname - IAM project name. If this parameter is not specified, Log Service adds the machine group to the IAM project named default.
- service_
logging bool - Enable Logcollector service log feature. true: enabled. false: (default) disabled.
- update_
end_ strtime - 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_ strtime - 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.
- host
Group StringName - Host group name
- host
Group StringType - 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.
- auto
Update 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.
- delete
Abnormal BooleanHosts - Clean all machines with abnormal heartbeat in the machine group with one click. Machines without heartbeat records cannot be deleted currently
- host
Identifier String - Machine identifier. Required when HostGroupType is Label.
- host
Ip List<String>Lists - List of IP addresses for the host group. Required when HostGroupType is IP.
- iam
Project StringName - IAM project name. If this parameter is not specified, Log Service adds the machine group to the IAM project named default.
- service
Logging Boolean - Enable Logcollector service log feature. true: enabled. false: (default) disabled.
- update
End StringTime - 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 StringTime - 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.
Outputs
All input properties are implicitly available as output properties. Additionally, the HostGroup resource produces the following output properties:
- Abnormal
Heartbeat intStatus Number - Number of abnormal machines.
- Agent
Latest stringVersion - Latest agent version.
- Create
Time string - Creation time.
- Host
Count int - Number of machines.
- Host
Group stringId - Host group ID
- Id string
- The provider-assigned unique ID for this managed resource.
- Modify
Time string - Modification time.
- Normal
Heartbeat intStatus Number - Number of healthy machines.
- Rule
Count int - Number of rules
- Rules
List<Byteplus.
Host Group Rule> - Collection configuration information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Abnormal
Heartbeat intStatus Number - Number of abnormal machines.
- Agent
Latest stringVersion - Latest agent version.
- Create
Time string - Creation time.
- Host
Count int - Number of machines.
- Host
Group stringId - Host group ID
- Id string
- The provider-assigned unique ID for this managed resource.
- Modify
Time string - Modification time.
- Normal
Heartbeat intStatus Number - Number of healthy machines.
- Rule
Count int - Number of rules
- Rules
[]Host
Group Rule - Collection configuration information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- abnormal_
heartbeat_ numberstatus_ number - Number of abnormal machines.
- agent_
latest_ stringversion - Latest agent version.
- create_
time string - Creation time.
- host_
count number - Number of machines.
- host_
group_ stringid - Host group ID
- id string
- The provider-assigned unique ID for this managed resource.
- modify_
time string - Modification time.
- normal_
heartbeat_ numberstatus_ number - Number of healthy machines.
- rule_
count number - Number of rules
- rules list(object)
- Collection configuration information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- abnormal
Heartbeat IntegerStatus Number - Number of abnormal machines.
- agent
Latest StringVersion - Latest agent version.
- create
Time String - Creation time.
- host
Count Integer - Number of machines.
- host
Group StringId - Host group ID
- id String
- The provider-assigned unique ID for this managed resource.
- modify
Time String - Modification time.
- normal
Heartbeat IntegerStatus Number - Number of healthy machines.
- rule
Count Integer - Number of rules
- rules
List<Host
Group Rule> - Collection configuration information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- abnormal
Heartbeat numberStatus Number - Number of abnormal machines.
- agent
Latest stringVersion - Latest agent version.
- create
Time string - Creation time.
- host
Count number - Number of machines.
- host
Group stringId - Host group ID
- id string
- The provider-assigned unique ID for this managed resource.
- modify
Time string - Modification time.
- normal
Heartbeat numberStatus Number - Number of healthy machines.
- rule
Count number - Number of rules
- rules
Host
Group Rule[] - Collection configuration information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- abnormal_
heartbeat_ intstatus_ number - Number of abnormal machines.
- agent_
latest_ strversion - Latest agent version.
- create_
time str - Creation time.
- host_
count int - Number of machines.
- host_
group_ strid - Host group ID
- id str
- The provider-assigned unique ID for this managed resource.
- modify_
time str - Modification time.
- normal_
heartbeat_ intstatus_ number - Number of healthy machines.
- rule_
count int - Number of rules
- rules
Sequence[Host
Group Rule] - Collection configuration information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- abnormal
Heartbeat NumberStatus Number - Number of abnormal machines.
- agent
Latest StringVersion - Latest agent version.
- create
Time String - Creation time.
- host
Count Number - Number of machines.
- host
Group StringId - Host group ID
- id String
- The provider-assigned unique ID for this managed resource.
- modify
Time String - Modification time.
- normal
Heartbeat NumberStatus Number - Number of healthy machines.
- rule
Count Number - Number of rules
- rules List<Property Map>
- Collection configuration information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
Look up Existing HostGroup Resource
Get an existing HostGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: HostGroupState, opts?: CustomResourceOptions): HostGroup@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
abnormal_heartbeat_status_number: Optional[int] = None,
agent_latest_version: Optional[str] = None,
auto_update: Optional[bool] = None,
create_time: Optional[str] = None,
delete_abnormal_hosts: Optional[bool] = None,
host_count: Optional[int] = None,
host_group_id: Optional[str] = None,
host_group_name: Optional[str] = None,
host_group_type: Optional[str] = None,
host_identifier: Optional[str] = None,
host_ip_lists: Optional[Sequence[str]] = None,
iam_project_name: Optional[str] = None,
modify_time: Optional[str] = None,
normal_heartbeat_status_number: Optional[int] = None,
rule_count: Optional[int] = None,
rules: Optional[Sequence[HostGroupRuleArgs]] = None,
service_logging: Optional[bool] = None,
update_end_time: Optional[str] = None,
update_start_time: Optional[str] = None) -> HostGroupfunc GetHostGroup(ctx *Context, name string, id IDInput, state *HostGroupState, opts ...ResourceOption) (*HostGroup, error)public static HostGroup Get(string name, Input<string> id, HostGroupState? state, CustomResourceOptions? opts = null)public static HostGroup get(String name, Output<String> id, HostGroupState state, CustomResourceOptions options)resources: _: type: bytepluscc:tls:HostGroup get: id: ${id}import {
to = bytepluscc_tls_host_group.example
id = "${id}"
}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Abnormal
Heartbeat intStatus Number - Number of abnormal machines.
- Agent
Latest stringVersion - 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 boolHosts - 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 stringId - Host group ID
- Host
Group stringName - Host group name
- Host
Group stringType - 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 List<string>Lists - List of IP addresses for the host group. Required when HostGroupType is IP.
- Iam
Project stringName - IAM project name. If this parameter is not specified, Log Service adds the machine group to the IAM project named default.
- Modify
Time string - Modification time.
- Normal
Heartbeat intStatus Number - Number of healthy machines.
- Rule
Count int - Number of rules
- Rules
List<Byteplus.
Host Group Rule> - Collection configuration information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Service
Logging bool - Enable Logcollector service log feature. true: enabled. false: (default) disabled.
- Update
End stringTime - 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 stringTime - 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 intStatus Number - Number of abnormal machines.
- Agent
Latest stringVersion - 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 boolHosts - 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 stringId - Host group ID
- Host
Group stringName - Host group name
- Host
Group stringType - 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 []stringLists - List of IP addresses for the host group. Required when HostGroupType is IP.
- Iam
Project stringName - IAM project name. If this parameter is not specified, Log Service adds the machine group to the IAM project named default.
- Modify
Time string - Modification time.
- Normal
Heartbeat intStatus Number - Number of healthy machines.
- Rule
Count int - Number of rules
- Rules
[]Host
Group Rule Args - Collection configuration information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Service
Logging bool - Enable Logcollector service log feature. true: enabled. false: (default) disabled.
- Update
End stringTime - 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 stringTime - 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_ numberstatus_ number - Number of abnormal machines.
- agent_
latest_ stringversion - 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_ boolhosts - 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_ stringid - Host group ID
- host_
group_ stringname - Host group name
- host_
group_ stringtype - 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_ list(string)lists - List of IP addresses for the host group. Required when HostGroupType is IP.
- iam_
project_ stringname - IAM project name. If this parameter is not specified, Log Service adds the machine group to the IAM project named default.
- modify_
time string - Modification time.
- normal_
heartbeat_ numberstatus_ number - Number of healthy machines.
- rule_
count number - Number of rules
- rules list(object)
- Collection configuration information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- service_
logging bool - Enable Logcollector service log feature. true: enabled. false: (default) disabled.
- update_
end_ stringtime - 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_ stringtime - 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 IntegerStatus Number - Number of abnormal machines.
- agent
Latest StringVersion - Latest agent version.
- auto
Update 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.
- create
Time String - Creation time.
- delete
Abnormal BooleanHosts - Clean all machines with abnormal heartbeat in the machine group with one click. Machines without heartbeat records cannot be deleted currently
- host
Count Integer - Number of machines.
- host
Group StringId - Host group ID
- host
Group StringName - Host group name
- host
Group StringType - 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 List<String>Lists - List of IP addresses for the host group. Required when HostGroupType is IP.
- iam
Project StringName - IAM project name. If this parameter is not specified, Log Service adds the machine group to the IAM project named default.
- modify
Time String - Modification time.
- normal
Heartbeat IntegerStatus Number - Number of healthy machines.
- rule
Count Integer - Number of rules
- rules
List<Host
Group Rule> - Collection configuration information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- service
Logging Boolean - Enable Logcollector service log feature. true: enabled. false: (default) disabled.
- update
End StringTime - 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 StringTime - 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 numberStatus Number - Number of abnormal machines.
- agent
Latest stringVersion - Latest agent version.
- auto
Update 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.
- create
Time string - Creation time.
- delete
Abnormal booleanHosts - 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 stringId - Host group ID
- host
Group stringName - Host group name
- host
Group stringType - 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 string[]Lists - List of IP addresses for the host group. Required when HostGroupType is IP.
- iam
Project stringName - IAM project name. If this parameter is not specified, Log Service adds the machine group to the IAM project named default.
- modify
Time string - Modification time.
- normal
Heartbeat numberStatus Number - Number of healthy machines.
- rule
Count number - Number of rules
- rules
Host
Group Rule[] - Collection configuration information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- service
Logging boolean - Enable Logcollector service log feature. true: enabled. false: (default) disabled.
- update
End stringTime - 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 stringTime - 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_ intstatus_ number - Number of abnormal machines.
- agent_
latest_ strversion - 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_ boolhosts - 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_ strid - Host group ID
- host_
group_ strname - Host group name
- host_
group_ strtype - 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_ Sequence[str]lists - List of IP addresses for the host group. Required when HostGroupType is IP.
- iam_
project_ strname - IAM project name. If this parameter is not specified, Log Service adds the machine group to the IAM project named default.
- modify_
time str - Modification time.
- normal_
heartbeat_ intstatus_ number - Number of healthy machines.
- rule_
count int - Number of rules
- rules
Sequence[Host
Group Rule Args] - Collection configuration information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- service_
logging bool - Enable Logcollector service log feature. true: enabled. false: (default) disabled.
- update_
end_ strtime - 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_ strtime - 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 NumberStatus Number - Number of abnormal machines.
- agent
Latest StringVersion - Latest agent version.
- auto
Update 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.
- create
Time String - Creation time.
- delete
Abnormal BooleanHosts - 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 StringId - Host group ID
- host
Group StringName - Host group name
- host
Group StringType - 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 List<String>Lists - List of IP addresses for the host group. Required when HostGroupType is IP.
- iam
Project StringName - IAM project name. If this parameter is not specified, Log Service adds the machine group to the IAM project named default.
- modify
Time String - Modification time.
- normal
Heartbeat NumberStatus Number - Number of healthy machines.
- rule
Count Number - Number of rules
- rules List<Property Map>
- Collection configuration information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- service
Logging Boolean - Enable Logcollector service log feature. true: enabled. false: (default) disabled.
- update
End StringTime - 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 StringTime - 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
HostGroupRule, HostGroupRuleArgs
- Container
Rule Byteplus.Host Group Rule Container Rule - Container collection rules
- Create
Time string - Time when the collection configuration was created.
- Exclude
Paths List<Byteplus.Host Group Rule Exclude Path> - Extraction rule list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Extract
Rule Byteplus.Host Group Rule Extract Rule - Extraction rules
- Input
Type int - 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 int
- 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 Byteplus.Rule Host Group Rule User Define Rule - User-defined collection rules.
- Container
Rule HostGroup Rule Container Rule - Container collection rules
- Create
Time string - Time when the collection configuration was created.
- Exclude
Paths []HostGroup Rule Exclude Path - Extraction rule list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Extract
Rule HostGroup Rule Extract Rule - Extraction rules
- Input
Type int - 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 []string
- Data collection path list
- Pause int
- 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 HostRule Group Rule User Define Rule - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- 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_ objectrule - User-defined collection rules.
- container
Rule HostGroup Rule Container Rule - Container collection rules
- create
Time String - Time when the collection configuration was created.
- exclude
Paths List<HostGroup Rule Exclude Path> - Extraction rule list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- extract
Rule HostGroup Rule Extract Rule - Extraction rules
- input
Type Integer - 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 Integer
- 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 HostRule Group Rule User Define Rule - User-defined collection rules.
- container
Rule HostGroup Rule Container Rule - Container collection rules
- create
Time string - Time when the collection configuration was created.
- exclude
Paths HostGroup Rule Exclude Path[] - Extraction rule list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- extract
Rule HostGroup Rule Extract Rule - 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 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 HostRule Group Rule User Define Rule - User-defined collection rules.
- container_
rule HostGroup Rule Container Rule - Container collection rules
- create_
time str - Time when the collection configuration was created.
- exclude_
paths Sequence[HostGroup Rule Exclude Path] - Extraction rule list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- extract_
rule HostGroup Rule Extract Rule - 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_ Hostrule Group Rule User Define Rule - User-defined collection rules.
- container
Rule Property Map - Container collection rules
- create
Time String - Time when the collection configuration was created.
- exclude
Paths List<Property Map> - Extraction rule list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- extract
Rule Property Map - 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 Property MapRule - User-defined collection rules.
HostGroupRuleContainerRule, HostGroupRuleContainerRuleArgs
- Container
Name stringRegex - 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.
-
List<Byteplus.
Host Group Rule Container Rule Env Tag> - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Exclude
Container List<Byteplus.Env Regexes Host Group Rule Container Rule Exclude Container Env Regex> - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Exclude
Container List<Byteplus.Label Regexes Host Group Rule Container Rule Exclude Container Label Regex> - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Include
Container List<Byteplus.Env Regexes Host Group Rule Container Rule Include Container Env Regex> - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Include
Container List<Byteplus.Label Regexes Host Group Rule Container Rule Include Container Label Regex> - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Kubernetes
Rule Byteplus.Host Group Rule Container Rule Kubernetes Rule - 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 stringRegex - 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.
-
[]Host
Group Rule Container Rule Env Tag - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Exclude
Container []HostEnv Regexes Group Rule Container Rule Exclude Container Env Regex - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Exclude
Container []HostLabel Regexes Group Rule Container Rule Exclude Container Label Regex - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Include
Container []HostEnv Regexes Group Rule Container Rule Include Container Env Regex - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Include
Container []HostLabel Regexes Group Rule Container Rule Include Container Label Regex - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Kubernetes
Rule HostGroup Rule Container Rule Kubernetes Rule - 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_ stringregex - 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.
- 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- exclude_
container_ list(object)env_ regexes - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- exclude_
container_ list(object)label_ regexes - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- include_
container_ list(object)env_ regexes - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- include_
container_ list(object)label_ regexes - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- 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).
- container
Name StringRegex - 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.
-
List<Host
Group Rule Container Rule Env Tag> - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- exclude
Container List<HostEnv Regexes Group Rule Container Rule Exclude Container Env Regex> - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- exclude
Container List<HostLabel Regexes Group Rule Container Rule Exclude Container Label Regex> - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- include
Container List<HostEnv Regexes Group Rule Container Rule Include Container Env Regex> - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- include
Container List<HostLabel Regexes Group Rule Container Rule Include Container Label Regex> - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- kubernetes
Rule HostGroup Rule Container Rule Kubernetes Rule - 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 stringRegex - 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.
-
Host
Group Rule Container Rule Env Tag[] - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- exclude
Container HostEnv Regexes Group Rule Container Rule Exclude Container Env Regex[] - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- exclude
Container HostLabel Regexes Group Rule Container Rule Exclude Container Label Regex[] - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- include
Container HostEnv Regexes Group Rule Container Rule Include Container Env Regex[] - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- include
Container HostLabel Regexes Group Rule Container Rule Include Container Label Regex[] - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- kubernetes
Rule HostGroup Rule Container Rule Kubernetes Rule - 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_ strregex - 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.
-
Sequence[Host
Group Rule Container Rule Env Tag] - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- exclude_
container_ Sequence[Hostenv_ regexes Group Rule Container Rule Exclude Container Env Regex] - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- exclude_
container_ Sequence[Hostlabel_ regexes Group Rule Container Rule Exclude Container Label Regex] - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- include_
container_ Sequence[Hostenv_ regexes Group Rule Container Rule Include Container Env Regex] - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- include_
container_ Sequence[Hostlabel_ regexes Group Rule Container Rule Include Container Label Regex] - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- kubernetes_
rule HostGroup Rule Container Rule Kubernetes Rule - 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).
- container
Name StringRegex - 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.
- 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- exclude
Container List<Property Map>Env Regexes - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- exclude
Container List<Property Map>Label Regexes - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- include
Container List<Property Map>Env Regexes - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- include
Container List<Property Map>Label Regexes - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- kubernetes
Rule 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).
HostGroupRuleContainerRuleEnvTag, HostGroupRuleContainerRuleEnvTagArgs
HostGroupRuleContainerRuleExcludeContainerEnvRegex, HostGroupRuleContainerRuleExcludeContainerEnvRegexArgs
HostGroupRuleContainerRuleExcludeContainerLabelRegex, HostGroupRuleContainerRuleExcludeContainerLabelRegexArgs
HostGroupRuleContainerRuleIncludeContainerEnvRegex, HostGroupRuleContainerRuleIncludeContainerEnvRegexArgs
HostGroupRuleContainerRuleIncludeContainerLabelRegex, HostGroupRuleContainerRuleIncludeContainerLabelRegexArgs
HostGroupRuleContainerRuleKubernetesRule, HostGroupRuleContainerRuleKubernetesRuleArgs
-
List<Byteplus.
Host Group Rule Container Rule Kubernetes Rule Annotation Tag> - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Enable
All boolLabel Tag - 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 List<Byteplus.Annotation Regexes Host Group Rule Container Rule Kubernetes Rule Exclude Pod Annotation Regex> - 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 Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Exclude
Pod List<Byteplus.Label Regexes Host Group Rule Container Rule Kubernetes Rule Exclude Pod Label Regex> - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Include
Pod List<Byteplus.Annotation Regexes Host Group Rule Container Rule Kubernetes Rule Include Pod Annotation Regex> - 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 Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Include
Pod List<Byteplus.Label Regexes Host Group Rule Container Rule Kubernetes Rule Include Pod Label Regex> - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
-
List<Byteplus.
Host Group Rule Container Rule Kubernetes Rule Label Tag> - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Namespace
Name stringRegex - 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 stringRegex - 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 stringRegex - 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
-
[]Host
Group Rule Container Rule Kubernetes Rule Annotation Tag - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Enable
All boolLabel Tag - 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 []HostAnnotation Regexes Group Rule Container Rule Kubernetes Rule Exclude Pod Annotation Regex - 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 Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Exclude
Pod []HostLabel Regexes Group Rule Container Rule Kubernetes Rule Exclude Pod Label Regex - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Include
Pod []HostAnnotation Regexes Group Rule Container Rule Kubernetes Rule Include Pod Annotation Regex - 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 Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Include
Pod []HostLabel Regexes Group Rule Container Rule Kubernetes Rule Include Pod Label Regex - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
-
[]Host
Group Rule Container Rule Kubernetes Rule Label Tag - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Namespace
Name stringRegex - 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 stringRegex - 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 stringRegex - 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
- 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- enable_
all_ boollabel_ tag - 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_ list(object)annotation_ regexes - 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 Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- exclude_
pod_ list(object)label_ regexes - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- include_
pod_ list(object)annotation_ regexes - 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 Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- include_
pod_ list(object)label_ regexes - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- namespace_
name_ stringregex - 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_ stringregex - 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_ stringregex - 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
-
List<Host
Group Rule Container Rule Kubernetes Rule Annotation Tag> - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- enable
All BooleanLabel Tag - 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 List<HostAnnotation Regexes Group Rule Container Rule Kubernetes Rule Exclude Pod Annotation Regex> - 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 Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- exclude
Pod List<HostLabel Regexes Group Rule Container Rule Kubernetes Rule Exclude Pod Label Regex> - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- include
Pod List<HostAnnotation Regexes Group Rule Container Rule Kubernetes Rule Include Pod Annotation Regex> - 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 Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- include
Pod List<HostLabel Regexes Group Rule Container Rule Kubernetes Rule Include Pod Label Regex> - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
-
List<Host
Group Rule Container Rule Kubernetes Rule Label Tag> - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- namespace
Name StringRegex - 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 StringRegex - 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 StringRegex - 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
-
Host
Group Rule Container Rule Kubernetes Rule Annotation Tag[] - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- enable
All booleanLabel Tag - 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 HostAnnotation Regexes Group Rule Container Rule Kubernetes Rule Exclude Pod Annotation Regex[] - 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 Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- exclude
Pod HostLabel Regexes Group Rule Container Rule Kubernetes Rule Exclude Pod Label Regex[] - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- include
Pod HostAnnotation Regexes Group Rule Container Rule Kubernetes Rule Include Pod Annotation Regex[] - 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 Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- include
Pod HostLabel Regexes Group Rule Container Rule Kubernetes Rule Include Pod Label Regex[] - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
-
Host
Group Rule Container Rule Kubernetes Rule Label Tag[] - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- namespace
Name stringRegex - 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 stringRegex - 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 stringRegex - 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
-
Sequence[Host
Group Rule Container Rule Kubernetes Rule Annotation Tag] - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- enable_
all_ boollabel_ tag - 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_ Sequence[Hostannotation_ regexes Group Rule Container Rule Kubernetes Rule Exclude Pod Annotation Regex] - 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 Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- exclude_
pod_ Sequence[Hostlabel_ regexes Group Rule Container Rule Kubernetes Rule Exclude Pod Label Regex] - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- include_
pod_ Sequence[Hostannotation_ regexes Group Rule Container Rule Kubernetes Rule Include Pod Annotation Regex] - 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 Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- include_
pod_ Sequence[Hostlabel_ regexes Group Rule Container Rule Kubernetes Rule Include Pod Label Regex] - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
-
Sequence[Host
Group Rule Container Rule Kubernetes Rule Label Tag] - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- namespace_
name_ strregex - 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_ strregex - 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_ strregex - 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
- 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- enable
All BooleanLabel Tag - 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 List<Property Map>Annotation Regexes - 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 Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- exclude
Pod List<Property Map>Label Regexes - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- include
Pod List<Property Map>Annotation Regexes - 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 Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- include
Pod List<Property Map>Label Regexes - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- namespace
Name StringRegex - 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 StringRegex - 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 StringRegex - 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
HostGroupRuleContainerRuleKubernetesRuleAnnotationTag, HostGroupRuleContainerRuleKubernetesRuleAnnotationTagArgs
HostGroupRuleContainerRuleKubernetesRuleExcludePodAnnotationRegex, HostGroupRuleContainerRuleKubernetesRuleExcludePodAnnotationRegexArgs
HostGroupRuleContainerRuleKubernetesRuleExcludePodLabelRegex, HostGroupRuleContainerRuleKubernetesRuleExcludePodLabelRegexArgs
HostGroupRuleContainerRuleKubernetesRuleIncludePodAnnotationRegex, HostGroupRuleContainerRuleKubernetesRuleIncludePodAnnotationRegexArgs
HostGroupRuleContainerRuleKubernetesRuleIncludePodLabelRegex, HostGroupRuleContainerRuleKubernetesRuleIncludePodLabelRegexArgs
HostGroupRuleContainerRuleKubernetesRuleLabelTag, HostGroupRuleContainerRuleKubernetesRuleLabelTagArgs
HostGroupRuleExcludePath, HostGroupRuleExcludePathArgs
HostGroupRuleExtractRule, HostGroupRuleExtractRuleArgs
- 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 List<Byteplus.Regexes Host Group Rule Extract Rule Filter Key Regex> - Filter rule list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- 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 Byteplus.Host Group Rule Extract Rule Log Template - 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 stringRegex - 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 stringLog Key - Key name for logs that failed to parse when uploading
- Un
Match boolUp Load Switch - 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 []HostRegexes Group Rule Extract Rule Filter Key Regex - Filter rule list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Keys []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 HostGroup Rule Extract Rule Log Template - 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 stringRegex - 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 stringLog Key - Key name for logs that failed to parse when uploading
- Un
Match boolUp Load Switch - 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_ list(object)regexes - Filter rule list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- 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_ stringregex - 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_ stringlog_ key - Key name for logs that failed to parse when uploading
- un_
match_ boolup_ load_ switch - 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 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.
- filter
Key List<HostRegexes Group Rule Extract Rule Filter Key Regex> - Filter rule list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- 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 HostGroup Rule Extract Rule Log Template - 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 StringRegex - 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 StringLog Key - Key name for logs that failed to parse when uploading
- un
Match BooleanUp Load Switch - 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 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.
- filter
Key HostRegexes Group Rule Extract Rule Filter Key Regex[] - Filter rule list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- keys 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 HostGroup Rule Extract Rule Log Template - 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 stringRegex - 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 stringLog Key - Key name for logs that failed to parse when uploading
- un
Match booleanUp Load Switch - 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_ Sequence[Hostregexes Group Rule Extract Rule Filter Key Regex] - Filter rule list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- 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 HostGroup Rule Extract Rule Log Template - 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_ strregex - 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_ strlog_ key - Key name for logs that failed to parse when uploading
- un_
match_ boolup_ load_ switch - 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 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.
- filter
Key List<Property Map>Regexes - Filter rule list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- 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 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.
- time
Extract StringRegex - 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 StringLog Key - Key name for logs that failed to parse when uploading
- un
Match BooleanUp Load Switch - 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.
HostGroupRuleExtractRuleFilterKeyRegex, HostGroupRuleExtractRuleFilterKeyRegexArgs
HostGroupRuleExtractRuleLogTemplate, HostGroupRuleExtractRuleLogTemplateArgs
HostGroupRuleUserDefineRule, HostGroupRuleUserDefineRuleArgs
- Advanced
Byteplus.
Host Group Rule User Define Rule Advanced - 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 boolGroup Label - 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 boolLog - Whether to upload raw logs. true: Upload raw logs. false (default): Do not upload raw logs.
- Fields
List<Byteplus.
Host Group Rule User Define Rule Field> - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Host
Group stringLabel Key - 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 int - Ignore log files that have not been updated for a specified duration, in hours.
- Multi
Collects stringType - 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 Byteplus.Rule Host Group Rule User Define Rule Parse Path Rule - 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
Byteplus.
Host Group Rule User Define Rule Plugin - 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 stringKey - 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
-
Byteplus.
Host Group Rule User Define Rule Shard Hash Key - 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 intKb - 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
Host
Group Rule User Define Rule Advanced - 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 boolGroup Label - 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 boolLog - Whether to upload raw logs. true: Upload raw logs. false (default): Do not upload raw logs.
- Fields
[]Host
Group Rule User Define Rule Field - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Host
Group stringLabel Key - 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 int - Ignore log files that have not been updated for a specified duration, in hours.
- Multi
Collects stringType - 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 HostRule Group Rule User Define Rule Parse Path Rule - 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
Host
Group Rule User Define Rule Plugin - 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 stringKey - 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
-
Host
Group Rule User Define Rule Shard Hash Key - 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 intKb - 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_ boolgroup_ label - 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_ boollog - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- host_
group_ stringlabel_ key - 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_ stringtype - 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_ objectrule - 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_ stringkey - 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
- 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_ numberkb - 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
Host
Group Rule User Define Rule Advanced - 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 BooleanGroup Label - 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 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.
- enable
Raw BooleanLog - Whether to upload raw logs. true: Upload raw logs. false (default): Do not upload raw logs.
- fields
List<Host
Group Rule User Define Rule Field> - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- host
Group StringLabel Key - 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 Integer - Ignore log files that have not been updated for a specified duration, in hours.
- multi
Collects StringType - 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 HostRule Group Rule User Define Rule Parse Path Rule - 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
Host
Group Rule User Define Rule Plugin - 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 StringKey - 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
-
Host
Group Rule User Define Rule Shard Hash Key - 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 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.
- tail
Size IntegerKb - 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
Host
Group Rule User Define Rule Advanced - 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 booleanGroup Label - 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 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.
- enable
Raw booleanLog - Whether to upload raw logs. true: Upload raw logs. false (default): Do not upload raw logs.
- fields
Host
Group Rule User Define Rule Field[] - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- host
Group stringLabel Key - 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 stringType - 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 HostRule Group Rule User Define Rule Parse Path Rule - 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
Host
Group Rule User Define Rule Plugin - 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 stringKey - 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
-
Host
Group Rule User Define Rule Shard Hash Key - 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 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.
- tail
Size numberKb - 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
Host
Group Rule User Define Rule Advanced - 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_ boolgroup_ label - 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_ boollog - Whether to upload raw logs. true: Upload raw logs. false (default): Do not upload raw logs.
- fields
Sequence[Host
Group Rule User Define Rule Field] - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- host_
group_ strlabel_ key - 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_ strtype - 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_ Hostrule Group Rule User Define Rule Parse Path Rule - 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
Host
Group Rule User Define Rule Plugin - 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_ strkey - 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
-
Host
Group Rule User Define Rule Shard Hash Key - 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_ intkb - 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.
- enable
Host BooleanGroup Label - 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 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.
- enable
Raw BooleanLog - 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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- host
Group StringLabel Key - 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 StringType - 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 Property MapRule - 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.
- raw
Log StringKey - 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
- 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.
- tail
Files 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.
- tail
Size NumberKb - 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.
HostGroupRuleUserDefineRuleAdvanced, HostGroupRuleUserDefineRuleAdvancedArgs
- 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 intTerminator Eof Max Time - 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 intTerminator Eof Max Time - 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_ numberterminator_ eof_ max_ time - 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 Boolean - After reading to the end of the log file, whether to release the file handle. Default is false.
- close
Inactive 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.
- close
Removed Boolean - Whether to release the handle of the log file after it is removed. Default is false.
- close
Renamed Boolean - Whether to release the handle of the log file after it is renamed. Default is false.
- close
Timeout 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.
- no
Line IntegerTerminator Eof Max Time - 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 boolean - 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 boolean - Whether to release the handle of the log file after it is removed. Default is false.
- close
Renamed boolean - 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 numberTerminator Eof Max Time - 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_ intterminator_ eof_ max_ time - 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 Boolean - 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 Boolean - Whether to release the handle of the log file after it is removed. Default is false.
- close
Renamed Boolean - 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 NumberTerminator Eof Max Time - 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.
HostGroupRuleUserDefineRuleField, HostGroupRuleUserDefineRuleFieldArgs
HostGroupRuleUserDefineRuleParsePathRule, HostGroupRuleUserDefineRuleParsePathRuleArgs
- 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 []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.
- 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.
- 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 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 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.
- 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.
HostGroupRuleUserDefineRulePlugin, HostGroupRuleUserDefineRulePluginArgs
- 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.
HostGroupRuleUserDefineRuleShardHashKey, HostGroupRuleUserDefineRuleShardHashKeyArgs
- 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).
- 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).
- 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).
- 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).
- 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).
- 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).
- 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).
Import
$ pulumi import bytepluscc:tls/hostGroup:HostGroup example "host_group_id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- bytepluscc byteplus-sdk/pulumi-bytepluscc
- License
- MPL-2.0
- Notes
- This Pulumi package is based on the
byteplusccTerraform Provider.
published on Monday, Jul 20, 2026 by Byteplus