Skip to content

Document the --recover-deferred-snapshots option #7738

Description

@jstirnaman

Problem

--recover-deferred-snapshots isn't documented anywhere in docs-v2.

The v3.11.3 release notes and the Enterprise storage engine configuration
reference both refer to it, because the new
--recover-deferred-snapshots-in-flight-limit option only has meaning in
relation to it. A reader who follows either reference finds no definition of
the option that does the recovering.

What's missing

The "Deferred snapshot recovery" section in
content/influxdb3/enterprise/reference/storage-engine-config-options.md
(under Compactor) documents the in-flight limit but not its parent option.
It needs a table row for --recover-deferred-snapshots covering:

  • What the option does: returns deferred snapshots to compaction.
  • Its default. Presumably disabled, but this needs engineering confirmation
    rather than an inference from the option name.
  • Its type: whether it's a boolean flag or takes a value.
  • Its environment variable, if it differs from the name-derived
    INFLUXDB3_RECOVER_DEFERRED_SNAPSHOTS.
  • Whether it's safe to leave on permanently, or is meant to be set, run, and
    removed.

Context

Added in the v3.11.3 release notes work. See influxdb_pro#5502 for the
in-flight limit option that prompted this.

Done when

--recover-deferred-snapshots appears in the Enterprise storage engine
configuration reference with a confirmed default and behavior, and the
"Deferred snapshot recovery" section reads correctly without depending on
outside knowledge of the option.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    product:v3-monolithInfluxDB 3 Core and Enterprise (single-node / clusterable)

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions