collectors

Overview

Name	collectors
Type	Resource
Id	sumologic.collectors.collectors

Fields

Name	Datatype	Description
id	integer	Identifier
name	string	Name of the Collector. It must be unique on your account.
description	string	Description of the Collector.
alive	boolean	When a Collector is running it sends Sumo a heartbeat message every 15 seconds. If no heartbeat message is received after 30 minutes this becomes false.
category	string	The Category of the Collector, used as metadata when searching data.
collectorType	string	The Collector type: Installable or Hosted
collectorVersion	string	Version of the Collector software installed.
cutoffRelativeTime	string	Can be specified instead of cutoffTimestamp to provide a relative offset with respect to the current time. Example: use "-1h", "-1d", or "-1w" to collect data thats less than one hour, one day, or one week old, respectively.
cutoffTimestamp	integer	0 (collects all data)|Only collect data from files with a modified date more recent than this timestamp, specified as milliseconds since epoch
ephemeral	boolean	When true, the collector will be deleted after 12 hours of inactivity. For more information, see Setting a Collector as Ephemeral.
fields	object	JSON map of key-value fields (metadata) to apply to the Collector.
hostName	string	Host name of the Collector. The hostname can be a maximum of 128 characters.
lastSeenAlive	integer	The last time the Sumo Logic service received an active heartbeat from the Collector, specified as milliseconds since epoch.
links	array
osArch	string	Architecture of the OS that Collector is installed on. [Installed Collectors only]
osName	string	Name of OS that Collector is installed on. [Installed Collectors only]
osTime	integer	Time that the Collector has been running, in milliseconds. [Installed Collectors only]
osVersion	string	Version of the OS that Collector is installed on. [Installed Collectors only]
sourceSyncMode	string	For installed Collectors, whether the Collector is using local source configuration management (using a JSON file), or cloud management (using the UI)
targetCpu	integer	When CPU utilization exceeds this threshold, the Collector will slow down its rate of ingestion to lower its CPU utilization.
timeZone	string	Time zone of the Collector. For a list of possible values, refer to the "TZ" column in this Wikipedia article.

Methods

Name	Accessible by	Required Params	Description
get_collector_by_name	SELECT	name, region	Get the Collector with the specified name.
list_collectors	SELECT	region	Get a list of Collectors with an optional limit and offset.
create_collector	INSERT	region	Create Hosted Collector. This method can only be used to create Hosted Collectors. You must install a Collector manually to create an Installed Collector.
delete_collector	DELETE	id, region	Delete Collector by ID
get_collector_by_id	EXEC	id, region	Get the Collector with the specified Identifier.
update_collector	EXEC	id, region	Update a Collector