Skip to main content

offline_collectors

Overview

Nameoffline_collectors
TypeResource
Idsumologic.collectors.offline_collectors

Fields

NameDatatypeDescription
idintegerIdentifier
namestringName of the Collector. It must be unique on your account.
descriptionstringDescription of the Collector.
alivebooleanWhen 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.
categorystringThe Category of the Collector, used as metadata when searching data.
collectorTypestringThe Collector type: Installable or Hosted
collectorVersionstringVersion of the Collector software installed.
cutoffRelativeTimestringCan 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.
cutoffTimestampinteger0 (collects all data)|Only collect data from files with a modified date more recent than this timestamp, specified as milliseconds since epoch
ephemeralbooleanWhen true, the collector will be deleted after 12 hours of inactivity. For more information, see Setting a Collector as Ephemeral.
fieldsobjectJSON map of key-value fields (metadata) to apply to the Collector.
hostNamestringHost name of the Collector. The hostname can be a maximum of 128 characters.
lastSeenAliveintegerThe last time the Sumo Logic service received an active heartbeat from the Collector, specified as milliseconds since epoch.
linksarray
osArchstringArchitecture of the OS that Collector is installed on. [Installed Collectors only]
osNamestringName of OS that Collector is installed on. [Installed Collectors only]
osTimeintegerTime that the Collector has been running, in milliseconds. [Installed Collectors only]
osVersionstringVersion of the OS that Collector is installed on. [Installed Collectors only]
sourceSyncModestringFor installed Collectors, whether the Collector is using local source configuration management (using a JSON file), or cloud management (using the UI)
targetCpuintegerWhen CPU utilization exceeds this threshold, the Collector will slow down its rate of ingestion to lower its CPU utilization.
timeZonestringTime zone of the Collector. For a list of possible values, refer to the "TZ" column in this Wikipedia article.

Methods

NameAccessible byRequired Params
list_offline_collectorsSELECTregion