Skip to content

Update flags.md #469

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update flags.md #469

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 47 additions & 48 deletions docs/managing-dragonfly/flags.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,21 +52,16 @@ flags which include specified substring in either in the name, description or pa

`default: "dump-{timestamp}"`

### `--dir`
Working directory

`default: ""`

### `--snapshot_cron`
Cron expression for the time to save a snapshot, crontab style.

`default:`

### `--use_set2`
If true use DenseSet for an optimized set data structure.

`default: true`

### `--use_zset_tree`
If true use b+tree for zset implementation.

`default: true`

### `--admin_bind`
If set, the admin console TCP connection would be bind to the given address.
This supports both HTTP and RESP protocols.
Expand Down Expand Up @@ -100,15 +95,15 @@ flags which include specified substring in either in the name, description or pa

`default: false`

### `--subscriber_thread_limit`
### `--publish_buffer_limit`
Amount of memory to use for storing pub commands in bytes - per IO thread.

`default: 134217728`
`default: 128MB`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`default: 128MB`
`default: 128MiB`


### `--pipeline_squash`
Number of queued pipelined commands above which squashing is enabled, 0 means disabled.

`default: 10`
`default: 1`

### `--primary_port_http_enabled`
If true allows accessing http console on main TCP port.
Expand Down Expand Up @@ -181,7 +176,6 @@ flags which include specified substring in either in the name, description or pa

`default:`


### `--lock_on_hashtags`
When true, locks are done in the {hashtag} level instead of key level. Only use this with `--cluster_mode=emulated|yes`.

Expand Down Expand Up @@ -237,6 +231,22 @@ flags which include specified substring in either in the name, description or pa

`default: 100`

### `--oom_deny_ratio`
commands with flag denyoom will return OOM when the ratio between maxmemory and used memory is above this value.

`default: 1.1`

### `--masterauth`
Password for authentication with master.

`default: ""`

### `--replicaof`
Specifies a host and port which point to a target master to replicate.
Format should be `<IPv4>:<PORT>` or `host:<PORT>` or `[<IPv6>]:<PORT>`.

`default:`

### `--mem_defrag_page_utilization_threshold`
Memory page under utilization threshold. Ratio between used and committed size, below this, memory in
this page will defragmented.
Expand All @@ -260,17 +270,32 @@ flags which include specified substring in either in the name, description or pa

`default: ""`

### `--singlehop_blocking`
Use single hop optimization for blocking commands.

`default: true`

### `--spill_file_prefix`
### `--tiered_prefix`
Enables tiered storage if set. The string denotes the path and prefix of the files associated
with tiered storage. For example, `spill_file_prefix=/path/to/file-prefix`.
with tiered storage. For example, `tiered_prefix=/path/to/file-prefix`.

`default: ""`

### `--tiered_offload_threshold`
Ratio of free memory (free/max memory) below which offloading starts

`default: 0.5`

### `--tiered_upload_threshold`
Ratio of free memory (free/max memory) below which uploading stops.

`default: 0.1`

### `--tiered_storage_write_depth`
Maximum number of concurrent stash requests issued by background offload.

`default: 32`
Copy link
Contributor

@Niennienzz Niennienzz Oct 5, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please double-check this value. I have 50 for Dragonfly v1.34.1 by running ./dragonfly --helpfull.


### `--tiered_min_value_size`
Minimum size of values eligible for offloading. Must be at least 64

`default: 64`

### `--keys_output_limit`
Maximum number of keys output by keys command.

Expand Down Expand Up @@ -321,22 +346,6 @@ flags which include specified substring in either in the name, description or pa

`default: 0`

### `--oom_deny_ratio`
commands with flag denyoom will return OOM when the ratio between maxmemory and used memory is above this value.

`default: 1.1`

### `--masterauth`
Password for authentication with master.

`default: ""`

### `--replicaof`
Specifies a host and port which point to a target master to replicate.
Format should be `<IPv4>:<PORT>` or `host:<PORT>` or `[<IPv6>]:<PORT>`.

`default:`

### `--tls_replication`
Enable TLS on replication.

Expand Down Expand Up @@ -402,11 +411,6 @@ flags which include specified substring in either in the name, description or pa

`default: true`

### `--dir`
Working directory

`default: ""`

### `--epoll_file_threads`
Thread size for file workers when running in epoll mode, default is hardware concurrent threads.

Expand Down Expand Up @@ -465,11 +469,6 @@ flags which include specified substring in either in the name, description or pa

`default: false`

### `--tiered_storage_max_pending_writes`
Maximal number of pending writes per thread.

`default: 32`

### `--aclfile`
Path and name to aclfile.

Expand Down Expand Up @@ -497,7 +496,7 @@ flags which include specified substring in either in the name, description or pa
`default: "on"`

### `--proactor_threads`
Number of io threads in the pool.
Number of io threads in the pool. If zero is specified, it will use as many as there are CPU cores.

`default: 0`

Expand Down