elasticsearch_disk

Description

The elasticsearch_disk parameter sets the size of each of the Rack's Elasticsearch log volumes. Elasticsearch stores the logs that convox logs without --service and convox rack logs read. The Rack runs two Elasticsearch Pods, or one when high_availability is false, each with its own persistent volume of this size. The volumes are separate DigitalOcean volumes, not node disk.

When a volume reaches 80% full, the Rack deletes the oldest day of logs, so the size of the volumes limits how much log history the Rack keeps. See Log Retention.

Default Value

The default value is 5Gi, the size every Rack's volumes are created at.

Accepted Values

A whole number of Gi, at least 5Gi, such as 5Gi, 20Gi or 100Gi. The CLI rejects any other value:

ERROR: param 'elasticsearch_disk' must be a whole number of Gi and at least 5Gi, such as 20Gi

The volumes can grow but never shrink, so the CLI also refuses a value below the one convox rack params currently lists:

ERROR: param 'elasticsearch_disk' cannot be below the current 10Gi: the volumes can grow but not shrink (use --force to set it anyway)

A lower value set with --force is stored and leaves the volumes at their current size.

The parameter cannot be cleared.

Use Cases

• Longer log history: keep more days of logs on a busy Rack.
• Room for one day of logs: the Rack never deletes the current UTC day, so a Rack that writes close to a full volume in one day needs larger volumes.

Setting the Parameter

$ convox rack params set elasticsearch_disk=20Gi -r rackName
Updating parameters... OK

The change restarts the Rack API, which then raises the volumes. On DigitalOcean they grow within a few minutes while Elasticsearch keeps running. convox rack logs shows a line like this for each volume:

ns=elastic at=expand claim=elasticsearch-data-elasticsearch-0 from=5Gi to=20Gi

Each volume is billed as a separate DigitalOcean volume of this size, two of them unless high_availability is false.

Viewing Current Configuration

$ convox rack params -r rackName

The parameter is listed only once it is set. convox rack params -g storage -r rackName shows it with the other storage parameters.

Additional Information

• A value given on convox rack install creates the volumes at 5Gi, and the Rack grows them to the value once it is running.
• Requires Rack version 3.25.11 or later, and CLI version 3.25.11 or later to set it. An older CLI rejects the parameter on DigitalOcean with unknown parameter 'elasticsearch_disk' for do provider.
• Available on GCP, Azure, DigitalOcean and metal Racks. See GCP and Azure. On metal Racks, set it through the CLI.
• Downgrading below 3.25.11 removes the parameter with NOTICE: removing parameters not supported by version <version>: elasticsearch_disk on stderr. The volumes keep their size. Logs written while the Rack ran 3.25.11 are hidden from convox logs until the Rack is updated to 3.25.11 or later again; nothing is deleted. A Rack managed through the Console keeps the stored value and applies it again on the upgrade. A self-managed Rack drops the value, and convox rack params does not list it until it is set again.

See Also

• Log Retention for how the Rack deletes old logs
• Elasticsearch on GCP, Azure, DigitalOcean and Metal Racks for how logs are stored and read
• logs for reading App logs
• high_availability for the number of Elasticsearch Pods
• registry_disk for the size of the Rack registry's disk
• fluentd_memory for the memory of the Fluentd log collector
• syslog for forwarding logs to an external service for long-term storage