ClusterNode is a datatype for a node in the a LogScale Cluster.

Table: ClusterNode

ParameterTypeRequiredDefaultDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 24, 2024
assignedTasks[NodeTaskEnum]yes The datatype for this is an array of enumerated list of values: storage, digest, or query.
bootedAtdatetimeyes The date and time, in the ISO-8601 instant format (e.g., 2022-12-03T10:15:30.00Z), whem the host was booted.
canBeSafelyUnregisteredbooleanyes Whether the node can be safely unregistered.
consideredAliveUntildatetimeyes The date and time, in the ISO-8601 instant format (e.g., 2022-12-03T10:15:30.00Z), for when the node is to be considered alive or active.
clusterInfoAgeSecondsfloatyes text
currentSizefloatyes The size in gigabytes of data currently on this node.
evictionStatusEvictionStatusyes The data describing the status of eviction. See EvictionStatus.
freeOnPrimaryfloatyes The size in gigabytes of the free space on this node of the primary storage location.
freeOnSecondaryfloatyes The size in gigabytes of the free space on this node of the secondary storage location. Zero if no secondary is configured.
hasDigestRolebooleanyes Whether the node can process Kafka partitions.
hasStorageRolebooleanyes Whether the node has local segment storage.
humioVersionstringyes The version of LogScale used by the cluster node.
idintegeryes The unique identifier of the cluster node.
inboundSegmentSizefloatyes The size in gigabytes of data this node needs to receive.
isAvailablebooleanyes Whether the node is considered up or down by the cluster coordinated. This is based on the lastHeartbeat field.
isBeingEvictedbooleanyes Whether the node is marked for eviction. The Falcon LogScale cluster will start to move segments, digesters and queries it contains.
lastHeartbeatdatetimeyes The last time, in the ISO-8601 instant format (e.g., 2022-12-03T10:15:30.00Z), a heartbeat was received from the node.
namestringyes The name of the cluster node.
outboundSegmentSizefloatyes The size in gigabytes of data this node has that others need.
primarySizefloatyes The size in gigabytes of the data currently on this node that are in the primary storage location.
reasonsNodeCannotBeSafelyUnregisteredReasonsNodeCannotBeSafelyUnregisteredyes The reasons the node cannot be safely unregistered. See ReasonsNodeCannotBeSafelyUnregistered.>.
secondarySizefloatyes The size in gigabytes of the data currently on this node that are in the secondary storage location. Zero (i.e., 0) if no secondary is configured.
solitarySegmentSizefloatyes The size in gigabytes of data that only exists on this node - i.e. only one replica exists in the cluster.
supportedTasks[NodeTaskEnum]yes A list of supported tasks. See NodeTaskEnum.>.
targetSizefloatyes The size in gigabytes of data once the node has received the data allocated to it.
timeSinceLastHeartbeatlongyes The time since a heartbeat was received from the node.
totalSizeOfPrimaryfloatyes The total size in gigabytes of the primary storage location on this node.
totalSizeOfSecondaryfloatyes The total size in gigabytes of the secondary storage location on this node. Zero if no secondary is configured.
timeSinceBootedlongyes The time since the last boot.
unassignedTasks[NodeTaskEnum]yes A list of unassigned tasks. See NodeTaskEnum.>.
uristringyes The URI (Uniform Resource Identifier) of the cluster node.
uuidstringyes The UUID (Universally Unique 128-bit Identifier) of the cluster node.
wipSizefloatyes The size in gigabytes of work-in-progress data files.
zonestring  text