REST Resource: projects.locations.instances.forwarders.collectors

Resource: Collector

Collectors detail the configuration for a specific data type. NEXT TAG: 8

JSON representation 
{
  "name": string,
  "displayName": string,
  "config": {
    object (CollectorConfig)
  },
  "state": enum (State),
  "type": enum (Type),
  "overrideTimezone": boolean,
  "timeZone": string
}
Fields
name

string

Immutable. The resource ID of the Collector. Format: projects/{project}/locations/{location}/instances/{instance}/forwarders/{forwarder}/collectors/{collector}
displayName

string

User-specified collector name.
config

object (CollectorConfig)

Collector configuration settings.
state

enum (State)

Output only. State of the collector.
type

enum (Type)

Output only. Type of the collector.
overrideTimezone

boolean

Optional. Indicates if the timezone should be overridden, this field will be used for self serve timezone override functionality and the logic is handled in the RPC's
timeZone

string

Optional. The timezone to override.this field will be used for self serve timezone override functionality and the logic is handled in the RPC's ,We can't add audit for this file as it is location field and we can't add audit for location fields.

CollectorConfig

CollectorConfig. Default configuration values will be applied during resource creation for the following fields when they are missing or zero-valued: - maxSecondsPerBatch - maxBytesPerBatch NEXT TAG: 13

JSON representation 
{
  "logType": string,
  "metadata": {
    object (ForwarderMetadata)
  },
  "regexFilters": [
    {
      object (RegexFilter)
    }
  ],
  "diskBuffer": {
    object (DiskBuffer)
  },
  "maxSecondsPerBatch": integer,
  "maxBytesPerBatch": string,

  // Union field settings can be only one of the following:
  "fileSettings": {
    object (FileSettings)
  },
  "kafkaSettings": {
    object (KafkaSettings)
  },
  "pcapSettings": {
    object (PcapSettings)
  },
  "splunkSettings": {
    object (SplunkSettings)
  },
  "syslogSettings": {
    object (SyslogSettings)
  },
  "webproxySettings": {
    object (WebProxySettings)
  }
  // End of list of possible types for union field settings.
}
Fields
logType

string

Required. Type of logs collected.
metadata

object (ForwarderMetadata)

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.
regexFilters[]

object (RegexFilter)

Filters applied at the collector level, which can override filters defined at the Forwarder level.
diskBuffer

object (DiskBuffer)

Disk Buffering configuration at the collector level.
maxSecondsPerBatch

integer

Maximum number of seconds between Forwarder batch uploads.
maxBytesPerBatch

string (int64 format)

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:
fileSettings

object (FileSettings)

File settings.
kafkaSettings

object (KafkaSettings)

Kafka settings.
pcapSettings

object (PcapSettings)

PCAP settings.
splunkSettings

object (SplunkSettings)

Splunk settings.
syslogSettings

object (SyslogSettings)

Syslog settings.
webproxySettings

object (WebProxySettings)

WebProxy settings.

FileSettings

FileSettings for a Collector. NEXT TAG: 2

JSON representation 
{
  "filePath": string
}
Fields
filePath

string

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 (UsernamePasswordAuth)
  },
  "topic": string,
  "groupId": string,
  "timeout": string,
  "brokers": [
    string
  ],
  "tlsSettings": {
    object (TLSSettings)
  }
}
Fields
authentication

object (UsernamePasswordAuth)

Username/Password for Kafka instance.
topic

string

Kafka Topic.
groupId

string

Kafka Group ID.
timeout

string (Duration format)

Kafka Timeout value, which will be truncated to seconds.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
brokers[]

string

Kafka Brokers.
tlsSettings

object (TLSSettings)

TLS Settings.

UsernamePasswordAuth

Username/Password based authentication information.

JSON representation 
{
  "username": string,
  "password": string
}
Fields
username

string

Username of an identity used for authentication.
password

string

Password of the account identified by username.

TLSSettings

TLS Settings information for Collectors with TLS support (e.g. Kafka, Syslog)

JSON representation 
{
  "certificate": string,
  "certificateKey": string,
  "minimumTlsVersion": string,
  "insecureSkipVerification": boolean
}
Fields
certificate

string

TLS Certificate.
certificateKey

string

TLS Certificate Key.
minimumTlsVersion

string

Minimum TLS Version.
insecureSkipVerification

boolean

Disables SSL certification verification.

PcapSettings

PcapSettings for a Collector. NEXT TAG: 3

JSON representation 
{
  "networkInterface": string,
  "berkeleyPacketFilter": string
}
Fields
networkInterface

string

Interface to listen for PCAP data.
berkeleyPacketFilter

string

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: - minimumWindowSize - maximumWindowSize NEXT TAG: 9

JSON representation 
{
  "authentication": {
    object (UsernamePasswordAuth)
  },
  "host": string,
  "port": integer,
  "minimumWindowSize": string,
  "maximumWindowSize": string,
  "queryString": string,
  "queryMode": string,
  "certIgnored": boolean
}
Fields
authentication

object (UsernamePasswordAuth)

Username/Password for Splunk instance.
host

string

Host or IP for Splunk instance REST API.
port

integer

Port associated with the Splunk instance, used with the host field.
minimumWindowSize

string (Duration format)

Minimum time range, truncated to seconds, for the Splunk query.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
maximumWindowSize

string (Duration format)

Maximum time range, truncated to seconds, for the Splunk query.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
queryString

string

Query used to filter records within Splunk.
queryMode

string

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

boolean

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: - bufferSize - connectionTimeout NEXT TAG: 7

JSON representation 
{
  "protocol": enum (Protocol),
  "address": string,
  "port": integer,
  "bufferSize": string,
  "connectionTimeout": string,
  "tlsSettings": {
    object (TLSSettings)
  }
}
Fields
protocol

enum (Protocol)

Syslog collector will listen using this protocol.
address

string

IP Address or Hostname (will be resolved to an IP) on which the Forwarder's syslog collector will listen.
port

integer

Port on which the Forwarder's syslog collector will listen.
bufferSize

string (int64 format)

Protocol Buffer Size.
connectionTimeout

string (Duration format)

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 's'. Example: "3.5s".
tlsSettings

object (TLSSettings)

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 
{
  "networkInterface": string,
  "berkeleyPacketFilter": string
}
Fields
networkInterface

string

Interface to listen for WebProxy data.
berkeleyPacketFilter

string

Berkeley Packet Filter (BPF) for WebProxy handle.

DiskBuffer

DiskBuffering configuration applied at the collector level. NEXT TAG: 4

JSON representation 
{
  "enabled": boolean,
  "directoryPath": string,
  "maxFileBufferBytes": string
}
Fields
enabled

boolean

Describes whether disk buffering is enabled on the collector.
directoryPath

string

Directory path for files written.
maxFileBufferBytes

string (int64 format)

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

 Create a collector.

delete

 Delete a collector by collector ID.

get

 Get a collector by collector ID.

list

 List all collectors for the forwarder.

patch

 Update a collector.