offline_collectors

Creates, updates, deletes, gets or lists an offline_collectors resource.

Overview

Name	offline_collectors
Type	Resource
Id	sumologic.collectors.offline_collectors

Fields

The following fields are returned by SELECT queries:

list_offline_collectors

Name	Datatype	Description
id	integer	Identifier
name	string	Name of the Collector. It must be unique on your account.
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
description	string	Description of the Collector.
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

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_offline_collectors	select	region	aliveBeforeDays, limit, offset	Get a list of Installed Collectors last seen alive before a specified number of days with an optional limit and offset.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	SumoLogic region (enum: [us2, au, ca, de, eu, fed, in, jp], default: us2)
aliveBeforeDays	integer	Filter the Collectors returned using one of the available filter types:installed, hosted, dead, or alive.
limit	integer	Minimum number of days the Collectors have been offline, must be at least 1 day.
offset	integer	Offset into the list of Collectors.

SELECT examples

list_offline_collectors

Get a list of Installed Collectors last seen alive before a specified number of days with an optional limit and offset.

SELECT
id,
name,
alive,
category,
collectorType,
collectorVersion,
cutoffRelativeTime,
cutoffTimestamp,
description,
ephemeral,
fields,
hostName,
lastSeenAlive,
links,
osArch,
osName,
osTime,
osVersion,
sourceSyncMode,
targetCpu,
timeZone
FROM sumologic.collectors.offline_collectors
WHERE region = '{{ region }}' -- required
AND aliveBeforeDays = '{{ aliveBeforeDays }}'
AND limit = '{{ limit }}'
AND offset = '{{ offset }}'
;