Queue (queue)

The queue block is part of the Sinks (sinks) and configures the behaviour of the queue.

Note

The memory queue no longer supports configuration of maxEventsPerRequest, it inherits the maximum bytes per request from the sink maxBatchSize.

yaml
sinks:
  sink_name:
    queue:
      type: memory
      # fullAction determines queue behavior when it is full.
      #   pause = queue pauses ingesting new batches if it is full (Default if not mentioned) deleteLatest is no longer supported and automatically set to pause.
      #   deleteOldest = queue deletes the oldest batch to accept new batches if it is full
      # Default: pause
      fullAction: pause
      maxLimitInMB: 1024
      # The flushTimeOutInMillisecond option only applies to "memory".
      flushTimeOutInMillisecond: 1000
      # The storageDir option only applies to "disk".
      #storageDir: [storage directory path]

Table: Queue

ParameterTypeRequiredDefault ValueDescription
fullActionstringoptional[a] pause Specify the action to take when the queue is full. The possible values are:

  • deleteOldest accepts new batches but deletes the oldest batch and whichever is reached first triggers the data to be sent to Humio.

  • pause this is the default value. The queue does not ingest new batches when it is full. Note that deleteLatest is no longer supported and automatically set to pause.

typestringoptional[a]   Can be set to memory or disk when disk is specified the data is written in the dataDirectory/queue/sinkName/ by default.

[a] Optional parameters use their default value unless explicitly set.


Table: Memory

ParameterTypeRequiredDefault ValueDescription
flushTimeOutInMillisecondintegeroptional[a] 1000 Specify how often data is sent to Falcon Log Collector.
maxLimitInMBintegeroptional[a]   Sets the maxLimitInMB this sets the maximum size of the queue.

[a] Optional parameters use their default value unless explicitly set.


When disk is specified the data is written in the dataDirectory/queue/sinkName/ unless, optionally, specified using storageDir.

Table: Disk

ParameterTypeRequiredDefault ValueDescription
maxLimitInMBintegeroptional[a] 1024 Sets the maxLimitInMB this sets the maximum size of the queue.
storageDirstringoptional[a] path of the dataDirectory When Disk is specified, this specifies where the data will be saved. This parameter is not required and is by default the queue data will reside inside a subfolder in the dataDirectory path.

[a] Optional parameters use their default value unless explicitly set.