ClusterNode is a
datatype for a node in the a LogScale Cluster.
Table: ClusterNode
| Parameter | Type | Required | Default | Stability | Description |
|---|---|---|---|---|---|
| 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: Mar 25, 2025 | |||||
assignedTasks | [NodeTaskEnum] | yes | Short-Term | The datatype for this is an enumerated list of values. See NodeTaskEnum. | |
bootedAt | datetime | yes | Long-Term | The date and time, in the ISO-8601 instant format (e.g., 2022-12-03T10:15:30.00Z), whem the host was booted. | |
canBeSafelyUnregistered | boolean | yes | Long-Term | Whether the node can be safely unregistered. | |
consideredAliveUntil | datetime | yes | Short-Term | 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. | |
clusterInfoAgeSeconds | float | yes | Long-Term | text | |
currentSize | float | yes | Long-Term | The size in gigabytes of data currently on this node. | |
evictionStatus | EvictionStatus | yes | Long-Term | The data describing the status of eviction. See EvictionStatus. | |
freeOnPrimary | float | yes | Long-Term | The size in gigabytes of the free space on this node of the primary storage location. | |
freeOnSecondary | float | yes | Long-Term | The size in gigabytes of the free space on this node of the secondary storage location. Zero if no secondary is configured. | |
hasDigestRole | boolean | yes | Long-Term | Whether the node can process Kafka partitions. | |
hasStorageRole | boolean | yes | Long-Term | Whether the node has local segment storage. | |
humioVersion | string | yes | Long-Term | The version of LogScale used by the cluster node. | |
id | integer | yes | Long-Term | The unique identifier of the cluster node. | |
inboundSegmentSize | float | yes | Long-Term | The size in gigabytes of data this node needs to receive. | |
isAvailable | boolean | yes | Long-Term | Whether the node is considered up or down by the cluster coordinated. This is based on the lastHeartbeat field. | |
isBeingEvicted | boolean | yes | Long-Term | Whether the node is marked for eviction. The Falcon LogScale cluster will start to move segments, digesters and queries it contains. | |
lastHeartbeat | datetime | yes | Long-Term | The last time, in the ISO-8601 instant format (e.g., 2022-12-03T10:15:30.00Z), a heartbeat was received from the node. | |
Name | string | yes | Long-Term | The name of the cluster node. | |
outboundSegmentSize | float | yes | Short-Term | The size in gigabytes of data this node has that others need. | |
primarySize | float | yes | Long-Term | The size in gigabytes of the data currently on this node that are in the primary storage location. | |
reasonsNodeCannotBeSafelyUnregistered | ReasonsNodeCannotBeSafelyUnregistered | yes | Long-Term | The reasons the node cannot be safely unregistered. See ReasonsNodeCannotBeSafelyUnregistered.>. | |
secondarySize | float | yes | Long-Term | 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. | |
solitarySegmentSize | float | yes | Long-Term | The size in gigabytes of data that only exists on this node - i.e. only one replica exists in the cluster. | |
supportedTasks | [NodeTaskEnum] | yes | Short-Term | A list of supported tasks. See NodeTaskEnum.>. | |
targetSize | float | yes | Long-Term | The size in gigabytes of data once the node has received the data allocated to it. | |
timeSinceLastHeartbeat | long | yes | Long-Term | The time since a heartbeat was received from the node. | |
totalSizeOfPrimary | float | yes | Long-Term | The total size in gigabytes of the primary storage location on this node. | |
totalSizeOfSecondary | float | yes | Long-Term | The total size in gigabytes of the secondary storage location on this node. Zero if no secondary is configured. | |
timeSinceBooted | long | yes | Long-Term | The time since the last boot. | |
unassignedTasks | [NodeTaskEnum] | yes | Short-Term | A list of unassigned tasks. See NodeTaskEnum.>. | |
uri | string | yes | Long-Term | The URI (Uniform Resource Identifier) of the cluster node. | |
uuid | string | yes | Long-Term | The UUID (Universally Unique 128-bit Identifier) of the cluster node. | |
wipSize | float | yes | Long-Term | The size in gigabytes of work-in-progress data files. | |
zone | string | Long-Term | text | ||