# Copyright (C) 2019-present MongoDB, Inc.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the Server Side Public License, version 1,
# as published by MongoDB, Inc.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# Server Side Public License for more details.
#
# You should have received a copy of the Server Side Public License
# along with this program. If not, see
# <http://www.mongodb.com/licensing/server-side-public-license>.
#
# As a special exception, the copyright holders give permission to link the
# code of portions of this program with the OpenSSL library under certain
# conditions as described in each individual source file and distribute
# linked combinations including the program with the OpenSSL library. You
# must comply with the Server Side Public License in all respects for
# all of the code used other than as permitted herein. If you modify file(s)
# with this exception, you may extend this exception to your version of the
# file(s), but you are not obligated to do so. If you do not wish to do so,
# delete this exception statement from your version. If you delete this
# exception statement from all source files in the program, then also delete
# it in the license file.
#

global:
    cpp_namespace: "mongo"
    cpp_includes:
        - "mongo/bson/bson_depth.h"
        - "mongo/db/storage/storage_options.h"

server_parameters:
    # This is an alias for the 'storage.syncPeriodSecs' config, and the default is defined in the
    # StorageGlobalParams struct to resolve a conflict between config parameter and set parameter evaluation.
    syncdelay:
        # In almost every situation you should not set this value and use the default setting.
        description: >-
            Interval in seconds between fsync operations where mongod flushes its
            working memory to disk. By default, mongod flushes memory to disk every 60 seconds.
        set_at: [startup, runtime]
        cpp_varname: "storageGlobalParams.syncdelay"
        validator:
            gte: 0.0
            lte: {expr: "StorageGlobalParams::kMaxSyncdelaySecs"}
        redact: false

    # This is an alias for the 'storage.journal.commitIntervalMs' config, and the default is defined in the
    # StorageGlobalParams struct to resolve a conflict between config parameter and set parameter evaluation.
    journalCommitInterval:
        description: "Number of milliseconds between journal commits"
        set_at: [startup, runtime]
        cpp_varname: "storageGlobalParams.journalCommitIntervalMs"
        validator:
            gte: 1
            lte: {expr: "StorageGlobalParams::kMaxJournalCommitIntervalMs"}
        redact: false

    takeUnstableCheckpointOnShutdown:
        description: "Take unstable checkpoint on shutdown"
        cpp_vartype: bool
        cpp_varname: gTakeUnstableCheckpointOnShutdown
        set_at: startup
        default: false
        redact: false

    operationMemoryPoolBlockInitialSizeKB:
        description: "Initial block size in KB for the per operation temporary object memory pool"
        set_at: [startup, runtime]
        cpp_vartype: AtomicWord<int32_t>
        cpp_varname: gOperationMemoryPoolBlockInitialSizeKB
        default: 1
        validator:
            gte: 1
        redact: false

    operationMemoryPoolBlockMaxSizeKB:
        description: "Maximum block size in KB for the per operation temporary object memory pool"
        set_at: [startup, runtime]
        cpp_vartype: AtomicWord<int32_t>
        cpp_varname: gOperationMemoryPoolBlockMaxSizeKB
        default: 2048
        validator:
            gte: 1
        redact: false

    indexMaxNumGeneratedKeysPerDocument:
        description: "Maximum number of index keys a single document is allowed to generate"
        set_at: [startup]
        cpp_vartype: int32_t
        cpp_varname: gIndexMaxNumGeneratedKeysPerDocument
        default: 100000
        validator:
            gte: 200
        redact: false

    storageGlobalParams.directoryperdb:
        description: "Read-only view of directory per db config parameter"
        set_at: "readonly"
        cpp_class:
            name: StorageDirectoryPerDbParameter
        redact: false

    timeseriesValidateCompressedBuckets:
        description: "Validate that there is no data loss before committing compressed timeseries buckets"
        set_at: [startup, runtime]
        cpp_vartype: AtomicWord<bool>
        cpp_varname: gValidateTimeseriesCompression
        default: true
        redact: false

    internalInsertMaxBatchSize:
        description: "Maximum number of documents that we will insert in a single batch."
        set_at: [startup, runtime]
        cpp_varname: "internalInsertMaxBatchSize"
        cpp_vartype: AtomicWord<int>
        default: 500
        validator:
            gt: 0
        redact: false

    maxNumberOfBatchedOperationsInSingleOplogEntry:
        description: >-
            Maximum number of operations to pack into a single oplog entry, when multi-oplog
            format for batched writes is in use. See batchedDeletesTargetBatchDocs and
            maxNumberOfTransactionOperationsInSingleOplogEntry.
        set_at: startup
        cpp_vartype: int
        cpp_varname: gMaxNumberOfBatchedOperationsInSingleOplogEntry
        default: 2147483647 # INT_MAX
        validator: {gte: 1}
        redact: false

    maxSizeOfBatchedOperationsInSingleOplogEntryBytes:
        description: >-
            Maximum size (bytes) of operations to pack into a single oplog entry, when multi-oplog
            format for batched writes is in use.
            See batchedDeletesTargetStagedDocBytes and BSONObjMaxUserSize.
        set_at: startup
        cpp_vartype: int
        cpp_varname: gMaxSizeOfBatchedOperationsInSingleOplogEntryBytes
        default: 16777216 # 16 MB
        validator: {gte: 1}
        redact: false

    maxNumberOfInsertsBatchInsertsForRenameAcrossDatabases:
        description: >-
            Maximum number of inserts that cross-db collection renames can batch into one applyOps
            oplog entry.
        set_at: [startup, runtime]
        cpp_vartype: AtomicWord<int>
        cpp_varname: gMaxNumberOfInsertsBatchInsertsForRenameAcrossDatabases
        default: 500
        validator: {gte: 1, lte: 16777216}
        redact: false

    maxSizeOfBatchedInsertsForRenameAcrossDatabasesBytes:
        description: >-
            Maximum size (bytes) of each batched applyOps oplog entry for cross-db collection renames.
            If any one document exceeds this limit, falls back to a plain insert oplog entry for that doc.
        set_at: [startup, runtime]
        cpp_vartype: AtomicWord<int>
        cpp_varname: gMaxSizeOfBatchedInsertsForRenameAcrossDatabasesBytes
        default:
            4194304 # 4 MB, an arbitrary but conservative fraction of the 16 MB BSON limit. Similar
            # in spirit to batchedDeletesTargetStagedDocBytes.
        validator: {gte: 1, lte: 16777216}
        redact: false

    collectionSamplingLogIntervalSeconds:
        description: "The approximate interval between log messages indicating collection sampling progress. Once interval seconds have elapsed since the last log message, a progress message will be logged after the current sample is completed. A value of zero will disable this logging."
        set_at: [startup, runtime]
        cpp_vartype: "AtomicWord<int>"
        cpp_varname: gCollectionSamplingLogIntervalSeconds
        deprecated_name:
            - oplogSamplingLogIntervalSeconds
        default: 10
        validator: {gte: 0}
        redact: false

    allowUnsafeUntimestampedWrites:
        description: >-
            Allows a replica set member in standalone mode to perform unsafe untimestamped writes
        set_at: [startup]
        cpp_varname: gAllowUnsafeUntimestampedWrites
        cpp_vartype: bool
        default: false
        redact: false

    skipDroppingHashedShardKeyIndex:
        description: >-
            Skips dropping hashed shard key supporting indexes when calling dropIndexes with the '*' parameter. Used for testing purposes.
        set_at: [startup, runtime]
        cpp_vartype: bool
        cpp_varname: skipDroppingHashedShardKeyIndex
        default: false
        redact: false

    enableAutoCompaction:
        description: "Enable auto compact at startup."
        cpp_vartype: bool
        cpp_varname: gEnableAutoCompaction
        set_at: startup
        default: false
        redact: false

    cachePressureEvictionStallThresholdProportion:
        description: "To adjust the thread pressure sensitivity proportion in detecting cache pressure for the storage engine."
        set_at: [startup, runtime]
        cpp_vartype: "AtomicWord<double>"
        cpp_varname: gCachePressureEvictionStallThresholdProportion
        default: 0.95
        validator: {gte: 0, lte: 1}
        redact: false

    cachePressureEvictionStallDetectionWindowSeconds:
        description: "The duration of time to allow cache pressure statistics to accumulate and average."
        set_at: [startup, runtime]
        cpp_vartype: "AtomicWord<int>"
        cpp_varname: gCachePressureEvictionStallDetectionWindowSeconds
        default: 30
        validator: {gte: 1}
        redact: false

    cachePressureExponentiallyDecayingMovingAverageAlphaValue:
        description: "The alpha value used to calculate the exponentially decaying moving average of total tickets."
        set_at: [startup, runtime]
        cpp_vartype: "AtomicWord<double>"
        cpp_varname: gCachePressureExponentiallyDecayingMovingAverageAlphaValue
        default: 0.1
        validator: {gte: 0, lte: 1}
        redact: false

    spillTableInsertBatchSizeBytes:
        description: >-
            The amount of data that a call to SpillTable::insertRecords will batch together into a
            single storage transaction.
        set_at: [startup, runtime]
        cpp_vartype: Atomic<long long>
        cpp_varname: gSpillTableInsertBatchSizeBytes
        default: 16777216 # 16 MB
        validator:
            gte: 0
        redact: false

feature_flags:
    featureFlagLargeBatchedOperations:
        description: >-
            Enable support for replicating batched operations over multiple applyOps oplog
            entries. Otherwise, batched operations that do not fit within a single applyOps
            oplog entry will fail with a TransactionTooLarge error.
            See maxNumberOfBatchedOperationsInSingleOplogEntry and
            maxSizeOfBatchedOperationsInSingleOplogEntryBytes.
        cpp_varname: gFeatureFlagLargeBatchedOperations
        default: true
        version: 8.0
        fcv_gated: true
    featureFlagDocumentSourceListCatalog:
        description: "When enabled, allow the use of the $listCatalog aggregation stage"
        cpp_varname: feature_flags::gDocumentSourceListCatalog
        default: true
        version: 6.0
        fcv_gated: true
    featureFlagInternalWritesAreReplicatedTransactionally:
        description: Feature flag to enable internal writes to use the transactionally replicated WriteUnitOfWork API by default.
        cpp_varname: gFeatureFlagInternalWritesAreReplicatedTransactionally
        default: false
        fcv_gated: true
    featureFlagTimeseriesDeletesSupport:
        description: "Enable support for arbitrary deletes on time-series collections"
        cpp_varname: feature_flags::gTimeseriesDeletesSupport
        default: true
        version: 7.0
        fcv_gated: true
    featureFlagTimeseriesUpdatesSupport:
        description: "Enable support for arbitrary updates on time-series collections"
        cpp_varname: feature_flags::gTimeseriesUpdatesSupport
        default: false
        fcv_gated: true
    featureFlagTSBucketingParametersUnchanged:
        description: "Enable storing the 'timeseriesBucketingParametersHaveChanged' parameter on disk"
        cpp_varname: feature_flags::gTSBucketingParametersUnchanged
        default: false
        fcv_gated: true
    featureFlagStorageEngineInterruptibility:
        description: "Enable support for interrupting user operations in storage engines and rolling back transactions immediately that are targeted by the storage engine."
        cpp_varname: feature_flags::gStorageEngineInterruptibility
        default: false
        fcv_gated: false
    featureFlagCreateSpillKVEngine:
        description: "When enabled, create a second storage engine instance that is used for creating SpillTables."
        cpp_varname: feature_flags::gFeatureFlagCreateSpillKVEngine
        default: true
        fcv_gated: false
    featureFlagReplicateLocalCatalogIdentifiers:
        description: >-
            Enable replication of local catalog identifiers across replica set nodes, ensuring the
            _mdb_catalog and its associated storage table 'ident' mappings remain consistent.
        cpp_varname: feature_flags::gFeatureFlagReplicateLocalCatalogIdentifiers
        default: false
        fcv_gated: true
    featureFlagPrimaryDrivenIndexBuilds:
        description: "Enable primary-driven index builds."
        cpp_varname: feature_flags::gFeatureFlagPrimaryDrivenIndexBuilds
        default: false
        fcv_gated: true