- Resource: Collector
- CollectorConfig
- FileSettings
- KafkaSettings
- UsernamePasswordAuth
- TLSSettings
- PcapSettings
- SplunkSettings
- SyslogSettings
- Protocol
- WebProxySettings
- DiskBuffer
- State
- Type
- Methods
Resource: Collector
Collectors detail the configuration for a specific data type. NEXT TAG: 6
JSON representation |
---|
{ "name": string, "display_name": string, "config": { object ( |
Fields | |
---|---|
name |
Immutable. The resource ID of the Collector. Format: projects/{project}/locations/{location}/instances/{instance}/forwarders/{forwarder}/collectors/{collector} |
display_name |
User-specified collector name. |
config |
Collector configuration settings. |
state |
Output only. State of the collector. |
type |
Output only. Type of the collector. |
CollectorConfig
CollectorConfig. Default configuration values will be applied during resource creation for the following fields when they are missing or zero-valued: - max_seconds_per_batch - max_bytes_per_batch NEXT TAG: 13
JSON representation |
---|
{ "log_type": string, "metadata": { object ( |
Fields | |
---|---|
log_type |
Required. Type of logs collected. |
metadata |
Metadata applied at the Collector level. This can be used in conjunction with, or take precedence over, Metadata applied at the Forwarder level. Refer to each Metadata field for further information. |
regex_filters[] |
Filters applied at the collector level, which can override filters defined at the Forwarder level. |
disk_buffer |
Disk Buffering configuration at the collector level. |
max_seconds_per_batch |
Maximum number of seconds between Forwarder batch uploads. |
max_bytes_per_batch |
Maximum number of bytes queued before Forwarder batch upload. |
Union field settings . Ingestion settings of the collector. settings can be only one of the following: |
|
file_settings |
File settings. |
kafka_settings |
Kafka settings. |
pcap_settings |
PCAP settings. |
splunk_settings |
Splunk settings. |
syslog_settings |
Syslog settings. |
webproxy_settings |
WebProxy settings. |
FileSettings
FileSettings for a Collector. NEXT TAG: 2
JSON representation |
---|
{ "file_path": string } |
Fields | |
---|---|
file_path |
Path of file to monitor. |
KafkaSettings
KafkaSettings for a Collector. Default configuration values will be applied during resource creation for the following fields when they are missing or zero-valued: - timeout NEXT TAG: 7
JSON representation |
---|
{ "authentication": { object ( |
Fields | |
---|---|
authentication |
Username/Password for Kafka instance. |
topic |
Kafka Topic. |
group_id |
Kafka Group ID. |
timeout |
Kafka Timeout value, which will be truncated to seconds. A duration in seconds with up to nine fractional digits, ending with ' |
brokers[] |
Kafka Brokers. |
tls_settings |
TLS Settings. |
UsernamePasswordAuth
Username/Password based authentication information.
JSON representation |
---|
{ "username": string, "password": string } |
Fields | |
---|---|
username |
Username of an identity used for authentication. |
password |
Password of the account identified by username. |
TLSSettings
TLS Settings information for Collectors with TLS support (e.g. Kafka, Syslog)
JSON representation |
---|
{ "certificate": string, "certificate_key": string, "minimum_tls_version": string, "insecure_skip_verification": boolean } |
Fields | |
---|---|
certificate |
TLS Certificate. |
certificate_key |
TLS Certificate Key. |
minimum_tls_version |
Minimum TLS Version. |
insecure_skip_verification |
Disables SSL certification verification. |
PcapSettings
PcapSettings for a Collector. NEXT TAG: 3
JSON representation |
---|
{ "network_interface": string, "berkeley_packet_filter": string } |
Fields | |
---|---|
network_interface |
Interface to listen for PCAP data. |
berkeley_packet_filter |
Berkeley Packet Filter (BPF) for PCAP handle. |
SplunkSettings
SplunkSettings for a Collector. Default configuration values will be applied during resource creation for the following fields when they are missing or zero-valued: - minimum_window_size - maximum_window_size NEXT TAG: 9
JSON representation |
---|
{
"authentication": {
object ( |
Fields | |
---|---|
authentication |
Username/Password for Splunk instance. |
host |
Host or IP for Splunk instance REST API. |
port |
Port associated with the Splunk instance, used with the host field. |
minimum_window_size |
Minimum time range, truncated to seconds, for the Splunk query. A duration in seconds with up to nine fractional digits, ending with ' |
maximum_window_size |
Maximum time range, truncated to seconds, for the Splunk query. A duration in seconds with up to nine fractional digits, ending with ' |
query_string |
Query used to filter records within Splunk. |
query_mode |
Query mode for Splunk. Currently, only a value of "realtime" is supported, For details about real-time searches in Splunk, please see the Splunk documentation. |
cert_ignored |
Ignore Certificate. |
SyslogSettings
SyslogSettings for a Collector. Default configuration values will be applied during resource creation for the following fields when they are missing or zero-valued: - buffer_size - connection_timeout NEXT TAG: 7
JSON representation |
---|
{ "protocol": enum ( |
Fields | |
---|---|
protocol |
Syslog collector will listen using this protocol. |
address |
IP Address or Hostname (will be resolved to an IP) on which the Forwarder's syslog collector will listen. |
port |
Port on which the Forwarder's syslog collector will listen. |
buffer_size |
Protocol Buffer Size. |
connection_timeout |
The time, truncated to seconds, after which TCP connections will drop-off after being inactive. A duration in seconds with up to nine fractional digits, ending with ' |
tls_settings |
TLS Settings. |
Protocol
Protocol on which a syslog collector can listen.
Enums | |
---|---|
PROTOCOL_UNSPECIFIED |
Attempting to set this default value will result in a validation error. |
TCP |
Syslog collector will listen for data using TCP. |
UDP |
Syslog collector will listen for data using UDP. |
WebProxySettings
WebProxySettings for a Collector. NEXT TAG: 3
JSON representation |
---|
{ "network_interface": string, "berkeley_packet_filter": string } |
Fields | |
---|---|
network_interface |
Interface to listen for WebProxy data. |
berkeley_packet_filter |
Berkeley Packet Filter (BPF) for WebProxy handle. |
DiskBuffer
DiskBuffering configuration applied at the collector level. NEXT TAG: 4
JSON representation |
---|
{ "enabled": boolean, "directory_path": string, "max_file_buffer_bytes": string } |
Fields | |
---|---|
enabled |
Describes whether disk buffering is enabled on the collector. |
directory_path |
Directory path for files written. |
max_file_buffer_bytes |
Maximum Buffered File Size. |
State
States of a collector.
Enums | |
---|---|
STATE_UNSPECIFIED |
The default value. This value is used if the state is omitted. |
ACTIVE |
Collector is allowed to accept data. |
SUSPENDED |
Collector is not allowed to accept data. |
Type
Collector type.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Default/Unset value. |
FILE |
File input. |
KAFKA |
Kafka input. |
PCAP |
Pcap input. |
SPLUNK |
Splunk input. |
WEBPROXY |
Webproxy input. |
SYSLOG |
Syslog input. |
Methods |
|
---|---|
|
Create a collector. |
|
Delete a collector by collector ID. |
|
Get a collector by collector ID. |
|
List all collectors for the forwarder. |
|
Update a collector. |