From df886f3dd2b7449be93eeb927bb78604325c49cf Mon Sep 17 00:00:00 2001 From: CircleCI Job Date: Sat, 9 Aug 2025 07:42:53 +0000 Subject: [PATCH] [skip ci] Automatic commit of generated files from CircleCI --- site/data/3.11/arangod.json | 14 +- site/data/3.12/allMetrics.yaml | 105 ++++++++ site/data/3.12/arangobackup.json | 4 +- site/data/3.12/arangobench.json | 4 +- site/data/3.12/arangod.json | 388 ++++++++++++++++++++++++++++-- site/data/3.12/arangodump.json | 4 +- site/data/3.12/arangoexport.json | 4 +- site/data/3.12/arangoimport.json | 10 +- site/data/3.12/arangoinspect.json | 4 +- site/data/3.12/arangorestore.json | 4 +- site/data/3.12/arangosh.json | 11 +- site/data/3.13/allMetrics.yaml | 105 ++++++++ site/data/3.13/arangod.json | 379 +++++++++++++++++++++++++++-- site/data/3.13/arangoimport.json | 6 +- 14 files changed, 962 insertions(+), 80 deletions(-) diff --git a/site/data/3.11/arangod.json b/site/data/3.11/arangod.json index 9ca1527d83..8b192d8c97 100644 --- a/site/data/3.11/arangod.json +++ b/site/data/3.11/arangod.json @@ -1400,7 +1400,7 @@ "agent", "single" ], - "default" : 7735568384, + "default" : 7735569408, "deprecatedIn" : null, "description" : "The global size limit for all caches (in bytes).", "dynamic" : true, @@ -7575,7 +7575,7 @@ "type" : "boolean" }, "query.global-memory-limit" : { - "base" : 33089757184, + "base" : 33089761280, "category" : "option", "component" : [ "coordinator", @@ -7583,7 +7583,7 @@ "agent", "single" ], - "default" : 26802703319, + "default" : 26802706636, "deprecatedIn" : null, "description" : "The memory threshold for all AQL queries combined (in bytes, 0 = no limit).", "dynamic" : true, @@ -7873,7 +7873,7 @@ "type" : "double" }, "query.memory-limit" : { - "base" : 33089757184, + "base" : 33089761280, "category" : "option", "component" : [ "coordinator", @@ -7881,7 +7881,7 @@ "agent", "single" ], - "default" : 19853854311, + "default" : 19853856768, "deprecatedIn" : null, "description" : "The memory threshold per AQL query (in bytes, 0 = no limit).", "dynamic" : true, @@ -9116,7 +9116,7 @@ "agent", "single" ], - "default" : 9282682060, + "default" : 9282683289, "deprecatedIn" : null, "description" : "The size of block cache (in bytes).", "dynamic" : true, @@ -11725,7 +11725,7 @@ "agent", "single" ], - "default" : 12376909414, + "default" : 12376911052, "deprecatedIn" : null, "description" : "The maximum total size of in-memory write buffers (0 = unbounded).", "dynamic" : true, diff --git a/site/data/3.12/allMetrics.yaml b/site/data/3.12/allMetrics.yaml index 85835e16fe..aeba0530d8 100644 --- a/site/data/3.12/allMetrics.yaml +++ b/site/data/3.12/allMetrics.yaml @@ -662,6 +662,27 @@ Execution time histogram for all AQL queries, in seconds. The histogram includes all slow queries. +- name: arangodb_aql_recording_call_time + type: histogram + category: Statistics + help: | + AQL recording runtime histogram. + description: | + Execution time histogram for AQL recording calls in nanoseconds. + + This histogram tracks the time it takes to record AQL calls in the ApiRecordingFeature. + The histogram uses a logarithmic scale with base 2, starting at 0 and going up to 16000.0 nanoseconds, + with 9 buckets. + unit: nanoseconds + introducedIn: "3.12.6" + category: Agency + complexity: high + exposedBy: + - agent + - coordinator + - dbserver + - single + - name: arangodb_aql_slow_query_time introducedIn: "3.6.10" help: | @@ -6325,6 +6346,38 @@ It shows the block cache capacity in bytes. This can be configured with the `--rocksdb.block-cache-size` startup option. +- name: rocksdb_block_cache_charge_per_entry + introducedIn: "3.12.6" + help: | + Average size of entries in RocksDB block cache. + unit: bytes + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + The metric shows the average size of cache entry value in the RocksDB + block cache. + +- name: rocksdb_block_cache_entries + introducedIn: "3.12.6" + help: | + Number of entries in the RocksDB block cache. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric shows the total number of entries present in the RocksDB block + cache. + - name: rocksdb_block_cache_pinned_usage introducedIn: "3.6.1" help: | @@ -7132,6 +7185,41 @@ nasty delays in database operations are incurred. If in doubt, contact ArangoDB support. +- name: rocksdb_live_blob_file_garbage_size + introducedIn: "3.12.6" + help: | + Size of garbage in live RocksDB .blob files. + unit: bytes + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the RocksDB metric `rocksdb-live-blob-file-garbage-size`. + It shows the total amount of garbage (obsolete, unreferenced blobs) in bytes + over in .blob files belonging to the latest LSM tree, summed over all + column families that use blob files. + +- name: rocksdb_live_blob_file_size + introducedIn: "3.12.6" + help: | + Size of live RocksDB .blob files. + unit: bytes + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the RocksDB metric `rocksdb-live-blob-file-size`. + It shows the total size in bytes of all .blob files belonging to the latest + LSM tree, summed over all column families that use blob files. + - name: rocksdb_live_sst_files_size introducedIn: "3.6.1" help: | @@ -7216,6 +7304,23 @@ This metric exhibits the RocksDB metric `rocksdb-min-log-number-to-keep`. It shows the minimum log number of the log files that should be kept. +- name: rocksdb_num_blob_files + introducedIn: "3.12.6" + help: | + Number of live RocksDB .blob files. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the RocksDB metric `rocksdb-num-blob-files`. + It shows the total number of .blob files belonging to the latest + LSM tree, summed over all column families that use blob files. + - name: rocksdb_num_deletes_active_mem_table introducedIn: "3.6.1" help: | diff --git a/site/data/3.12/arangobackup.json b/site/data/3.12/arangobackup.json index 83afbfecd3..2b453ad295 100644 --- a/site/data/3.12/arangobackup.json +++ b/site/data/3.12/arangobackup.json @@ -1006,7 +1006,7 @@ }, "server.authentication" : { "category" : "option", - "default" : false, + "default" : true, "deprecatedIn" : null, "description" : "Require authentication credentials when connecting (does not affect the server-side authentication settings).", "dynamic" : false, @@ -1067,7 +1067,7 @@ "server.endpoint" : { "category" : "option", "default" : [ - "http+tcp://127.0.0.1:8529" + "tcp://127.0.0.1:8529" ], "deprecatedIn" : null, "description" : "The endpoint to connect to. Use 'none' to start without a server. Use http+ssl:// as schema to connect to an SSL-secured server endpoint, otherwise http+tcp:// or unix://", diff --git a/site/data/3.12/arangobench.json b/site/data/3.12/arangobench.json index aabd03a1e7..6b9809ef71 100644 --- a/site/data/3.12/arangobench.json +++ b/site/data/3.12/arangobench.json @@ -1275,7 +1275,7 @@ }, "server.authentication" : { "category" : "option", - "default" : false, + "default" : true, "deprecatedIn" : null, "description" : "Require authentication credentials when connecting (does not affect the server-side authentication settings).", "dynamic" : false, @@ -1336,7 +1336,7 @@ "server.endpoint" : { "category" : "option", "default" : [ - "http+tcp://127.0.0.1:8529" + "tcp://127.0.0.1:8529" ], "deprecatedIn" : null, "description" : "The endpoint to connect to. Use 'none' to start without a server. Use http+ssl:// as schema to connect to an SSL-secured server endpoint, otherwise http+tcp:// or unix://", diff --git a/site/data/3.12/arangod.json b/site/data/3.12/arangod.json index 20f266a6e6..c2a12bba0b 100644 --- a/site/data/3.12/arangod.json +++ b/site/data/3.12/arangod.json @@ -1393,7 +1393,7 @@ "agent", "single" ], - "default" : 7735566336, + "default" : 7735569408, "deprecatedIn" : null, "description" : "The global size limit for all caches (in bytes).", "dynamic" : true, @@ -2255,6 +2255,32 @@ "section" : "database", "type" : "boolean" }, + "database.auto-upgrade-full-compaction" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Perform a full RocksDB compaction after database upgrade.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "If this option is specified together with \n--database.auto-upgrade, the server will perform a full RocksDB compaction \nafter the database upgrade has completed successfully but before shutting down.\n\nThis performs a complete compaction of all column families with both \nchangeLevel and compactBottomMostLevel options enabled, which can help \noptimize the database files after an upgrade.\n\nThe server will exit with an error code if the compaction fails.", + "obsolete" : false, + "os" : [ + "linux" + ], + "required" : false, + "requiresValue" : false, + "section" : "database", + "type" : "boolean" + }, "database.check-version" : { "category" : "command", "component" : [ @@ -2313,7 +2339,7 @@ "agent", "single" ], - "default" : "", + "default" : "/var/lib/arangodb3", "deprecatedIn" : null, "description" : "The path to the database directory.", "dynamic" : false, @@ -2779,7 +2805,7 @@ "dbserver", "single" ], - "default" : 6188453068, + "default" : 6188455526, "deprecatedIn" : null, "description" : "Maximum memory usage (in bytes) to be used by all ongoing dumps.", "dynamic" : true, @@ -3474,7 +3500,7 @@ "coordinator", "single" ], - "default" : "./js/apps", + "default" : "/var/lib/arangodb3-apps", "deprecatedIn" : null, "description" : "The directory for Foxx applications.", "dynamic" : false, @@ -3738,7 +3764,6 @@ "single" ], "default" : [ - "./enterprise/js" ], "deprecatedIn" : null, "description" : "Additional paths containing JavaScript modules.", @@ -3811,7 +3836,7 @@ "coordinator", "single" ], - "default" : "./js", + "default" : "/usr/share/arangodb3/js", "deprecatedIn" : null, "description" : "A path to the directory containing the JavaScript startup scripts.", "dynamic" : false, @@ -4153,13 +4178,13 @@ ], "default" : "true", "deprecatedIn" : null, - "description" : "Whether the log API is enabled (true) or not (false), or only enabled for superuser JWT (jwt).", + "description" : "Whether the log API is enabled (true) or not (false), or only enabled for the superuser (jwt).", "dynamic" : false, "enterpriseOnly" : false, "experimental" : false, "hidden" : false, "introducedIn" : null, - "longDescription" : "Credentials are not written to log files.\nNevertheless, some logged data might be sensitive depending on the context of\nthe deployment. For example, if request logging is switched on, user requests\nand corresponding data might end up in log files. Therefore, a certain care\nwith log files is recommended.\n\nSince the database server offers an API to control logging and query logging\ndata, this API has to be secured properly. By default, the API is accessible\nfor admin users (administrative access to the `_system` database). However,\nyou can lock this down further.\n\nThe possible values for this option are:\n\n - `true`: The `/_admin/log` API is accessible for admin users.\n - `jwt`: The `/_admin/log` API is accessible for the superuser only\n (authentication with JWT token and empty username).\n - `false`: The `/_admin/log` API is not accessible at all.", + "longDescription" : "Credentials are not written to log files.\nNevertheless, some logged data might be sensitive depending on the context of\nthe deployment. For example, if request logging is switched on, user requests\nand corresponding data might end up in log files. Therefore, a certain care\nwith log files is recommended.\n\nSince the database server offers an API to control logging and query logging\ndata, this API has to be secured properly. By default, the API is accessible\nfor admin users (administrative access to the `_system` database).\nHowever, you can restrict it further to the superuser or disable it altogether:\n\n - `true`: The `/_admin/log` API is accessible for admin users.\n - `jwt`: The `/_admin/log` API is accessible for the superuser only\n (authentication with JWT superuser token and empty username).\n - `false`: The `/_admin/log` API is not accessible at all.", "obsolete" : false, "os" : [ "linux" @@ -4257,7 +4282,7 @@ "agent", "single" ], - "default" : "", + "default" : "-", "deprecatedIn" : null, "description" : "Shortcut for `--log.output file://`", "dynamic" : false, @@ -4726,6 +4751,31 @@ "section" : "log", "type" : "boolean" }, + "log.recording-api-enabled" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "true", + "deprecatedIn" : null, + "description" : "Whether the recording API is enabled (true) or not (false), or only enabled for the superuser (jwt).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "The `/_admin/server/api-calls` and\n`/_admin/server/aql-queries` endpoints provide access to recorded API calls\nand AQL queries respectively. They are referred to as the recording API.\n\nSince this data might be sensitive depending on the context of the deployment,\nthese endpoints need to be properly secured. By default, the recording API is\naccessible for admin users (users with administrative access to the `_system`\ndatabase). However, you can restrict it further to the superuser or disable it\naltogether:\n\n- `true`: The recording API is accessible for admin users.\n- `jwt`: The recording API is accessible for the superuser only\n (authentication with JWT superuser token and empty username).\n- `false`: The recording API is not accessible at all.\n\nWhether API calls and AQL queries are recorded is independent of this option.\nIt is controlled by the `--server.api-call-recording` and\n`--server.aql-query-recording` startup options.", + "obsolete" : false, + "os" : [ + "linux" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, "log.request-parameters" : { "category" : "option", "component" : [ @@ -5670,7 +5720,7 @@ "type" : "boolean" }, "query.global-memory-limit" : { - "base" : 33089748992, + "base" : 33089761280, "category" : "option", "component" : [ "coordinator", @@ -5678,7 +5728,7 @@ "agent", "single" ], - "default" : 26802696683, + "default" : 26802706636, "deprecatedIn" : null, "description" : "The memory threshold for all AQL queries combined (in bytes, 0 = no limit).", "dynamic" : true, @@ -6005,7 +6055,7 @@ "type" : "uint64" }, "query.memory-limit" : { - "base" : 33089748992, + "base" : 33089761280, "category" : "option", "component" : [ "coordinator", @@ -6013,7 +6063,7 @@ "agent", "single" ], - "default" : 19853849395, + "default" : 19853856768, "deprecatedIn" : null, "description" : "The memory threshold per AQL query (in bytes, 0 = no limit).", "dynamic" : true, @@ -7061,6 +7111,36 @@ "section" : "rocksdb", "type" : "uint64" }, + "rocksdb.blob-file-starting-level" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : 0, + "deprecatedIn" : null, + "description" : "The level from which on to use blob files in the documents column family. Requires `--rocksdb.enable-blob-files`.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : true, + "hidden" : false, + "introducedIn" : [ + "v3.12.6" + ], + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint32" + }, "rocksdb.blob-garbage-collection-age-cutoff" : { "base" : 1, "category" : "option", @@ -7146,6 +7226,36 @@ "section" : "rocksdb", "type" : "boolean" }, + "rocksdb.block-cache-estimated-entry-charge" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : 0, + "deprecatedIn" : null, + "description" : "The estimated charge of cache entries (in bytes) for the hyper-clock cache.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : true, + "hidden" : false, + "introducedIn" : [ + "v3.12.6" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, "rocksdb.block-cache-jemalloc-allocator" : { "category" : "option", "component" : [ @@ -7210,7 +7320,7 @@ "agent", "single" ], - "default" : 9282679603, + "default" : 9282683289, "deprecatedIn" : null, "description" : "The size of block cache (in bytes).", "dynamic" : true, @@ -7231,6 +7341,33 @@ "section" : "rocksdb", "type" : "uint64" }, + "rocksdb.block-cache-type" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "lru", + "deprecatedIn" : null, + "description" : "The block cache type to use (note: the 'hyper-clock' cache type is experimental).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.12.6" + ], + "obsolete" : false, + "os" : [ + "linux" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "string", + "values" : "Possible values: \"hyper-clock\", \"lru\"" + }, "rocksdb.bloom-filter-bits-per-key" : { "base" : 1, "category" : "option", @@ -7344,7 +7481,7 @@ "agent", "single" ], - "default" : 2097152, + "default" : 8388608, "deprecatedIn" : null, "description" : "If non-zero, bigger reads are performed when doing compaction. If you run RocksDB on spinning disks, you should set this to at least 2 MB. That way, RocksDB's compaction does sequential instead of random reads.", "dynamic" : false, @@ -7517,6 +7654,32 @@ "section" : "rocksdb", "type" : "boolean" }, + "rocksdb.enable-blob-cache" : { + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Enable caching of blobs in the block cache for the documents column family.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : true, + "hidden" : false, + "introducedIn" : [ + "v3.12.6" + ], + "obsolete" : false, + "os" : [ + "linux" + ], + "required" : false, + "requiresValue" : false, + "section" : "rocksdb", + "type" : "boolean" + }, "rocksdb.enable-blob-files" : { "category" : "option", "component" : [ @@ -7888,6 +8051,7 @@ "introducedIn" : [ "v3.10.0" ], + "longDescription" : "Note that format version 6 can only be read by RocksDB versions\n>= 8.6.0. Thus switching to format version 6 will make the database files\nincompatible with ArangoDB versions with a lower RocksDB version in case of\ndowngrading.", "maxInclusive" : true, "maxValue" : 4294967295, "minInclusive" : true, @@ -7899,7 +8063,7 @@ "requiresValue" : true, "section" : "rocksdb", "type" : "uint32", - "values" : "Possible values: 3, 4, 5" + "values" : "Possible values: 3, 4, 5, 6" }, "rocksdb.intermediate-commit-count" : { "base" : 1, @@ -8223,7 +8387,7 @@ "agent", "single" ], - "default" : 2, + "default" : 4, "deprecatedIn" : null, "description" : "The maximum number of concurrent sub-jobs for a background compaction.", "dynamic" : false, @@ -8251,7 +8415,7 @@ "agent", "single" ], - "default" : 83886080, + "default" : 268435456, "deprecatedIn" : null, "description" : "The maximum total size of WAL files that force a flush of stale column families.", "dynamic" : false, @@ -8958,7 +9122,7 @@ "section" : "rocksdb", "type" : "boolean" }, - "rocksdb.partition-files-for-documents" : { + "rocksdb.optimize-filters-for-memory" : { "category" : "option", "component" : [ "dbserver", @@ -8967,6 +9131,32 @@ ], "default" : false, "deprecatedIn" : null, + "description" : "Optimize RocksDB bloom filters to reduce internal memory fragmentation.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.12.6" + ], + "obsolete" : false, + "os" : [ + "linux" + ], + "required" : false, + "requiresValue" : false, + "section" : "rocksdb", + "type" : "boolean" + }, + "rocksdb.partition-files-for-documents" : { + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, "description" : "If enabled, the document data for different collections/shards will end up in different .sst files.", "dynamic" : false, "enterpriseOnly" : false, @@ -9127,7 +9317,7 @@ "agent", "single" ], - "default" : 131072, + "default" : 1073741824, "deprecatedIn" : null, "description" : "The number of pending compaction bytes that triggers a write slowdown.", "dynamic" : false, @@ -9157,7 +9347,7 @@ "agent", "single" ], - "default" : 17179869184, + "default" : 34359738368, "deprecatedIn" : null, "description" : "The number of pending compaction bytes that triggers a full write stop.", "dynamic" : false, @@ -9258,6 +9448,32 @@ "section" : "rocksdb", "type" : "boolean" }, + "rocksdb.prepopulate-blob-cache" : { + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Pre-populate the blob cache on flushes.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : true, + "hidden" : true, + "introducedIn" : [ + "v3.12.6" + ], + "obsolete" : false, + "os" : [ + "linux" + ], + "required" : false, + "requiresValue" : false, + "section" : "rocksdb", + "type" : "boolean" + }, "rocksdb.prepopulate-block-cache" : { "category" : "option", "component" : [ @@ -9740,7 +9956,7 @@ "agent", "single" ], - "default" : 12376906137, + "default" : 12376911052, "deprecatedIn" : null, "description" : "The maximum total size of in-memory write buffers (0 = unbounded).", "dynamic" : true, @@ -10150,15 +10366,16 @@ "type" : "boolean" }, "server.api-call-recording" : { - "category" : "command", + "category" : "option", "component" : [ "coordinator", "dbserver", "agent", "single" ], + "default" : true, "deprecatedIn" : null, - "description" : "Record recent API calls for debugging purposes (default: true).", + "description" : "Whether to record recent API calls for debugging purposes.", "dynamic" : false, "enterpriseOnly" : false, "experimental" : false, @@ -10168,25 +10385,86 @@ "os" : [ "linux" ], + "required" : false, "requiresValue" : false, "section" : "server", "type" : "boolean" }, "server.api-recording-memory-limit" : { - "category" : "command", + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 26214400, + "deprecatedIn" : null, + "description" : "Size limit for the list of API call records.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 274877906944, + "minInclusive" : true, + "minValue" : 262144, + "obsolete" : false, + "os" : [ + "linux" + ], + "requiresValue" : true, + "section" : "server", + "type" : "uint64" + }, + "server.aql-query-recording" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Whether to record recent AQL queries for debugging purposes.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux" + ], + "required" : false, + "requiresValue" : false, + "section" : "server", + "type" : "boolean" + }, + "server.aql-recording-memory-limit" : { + "base" : 1, + "category" : "option", "component" : [ "coordinator", "dbserver", "agent", "single" ], + "default" : 26214400, "deprecatedIn" : null, - "description" : "Memory limit for the list of ApiCallRecords.", + "description" : "Size limit for the list of AQL query records.", "dynamic" : false, "enterpriseOnly" : false, "experimental" : false, "hidden" : true, "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 274877906944, + "minInclusive" : true, + "minValue" : 262144, "obsolete" : false, "os" : [ "linux" @@ -10725,6 +11003,64 @@ "section" : "server", "type" : "uint64" }, + "server.license-disk-usage-grace-period-readonly" : { + "base" : 172800, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 172800, + "deprecatedIn" : null, + "description" : "The warning duration until the server enters read-only mode when exceeding the dataset size limit (in seconds). The maximum is 2 days.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 172800, + "minInclusive" : true, + "minValue" : 1, + "obsolete" : false, + "os" : [ + "linux" + ], + "requiresValue" : true, + "section" : "server", + "type" : "uint64" + }, + "server.license-disk-usage-grace-period-shutdown" : { + "base" : 172800, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 172800, + "deprecatedIn" : null, + "description" : "The read-only duration until the server shuts down when exceeding the dataset size limit (in seconds). The maximum is 2 days.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 172800, + "minInclusive" : true, + "minValue" : 1, + "obsolete" : false, + "os" : [ + "linux" + ], + "requiresValue" : true, + "section" : "server", + "type" : "uint64" + }, "server.license-disk-usage-limit" : { "base" : 107374182400, "category" : "option", diff --git a/site/data/3.12/arangodump.json b/site/data/3.12/arangodump.json index 23a805124c..a80ae94139 100644 --- a/site/data/3.12/arangodump.json +++ b/site/data/3.12/arangodump.json @@ -1345,7 +1345,7 @@ }, "server.authentication" : { "category" : "option", - "default" : false, + "default" : true, "deprecatedIn" : null, "description" : "Require authentication credentials when connecting (does not affect the server-side authentication settings).", "dynamic" : false, @@ -1406,7 +1406,7 @@ "server.endpoint" : { "category" : "option", "default" : [ - "http+tcp://127.0.0.1:8529" + "tcp://127.0.0.1:8529" ], "deprecatedIn" : null, "description" : "The endpoint to connect to. Use 'none' to start without a server. Use http+ssl:// as schema to connect to an SSL-secured server endpoint, otherwise http+tcp:// or unix://", diff --git a/site/data/3.12/arangoexport.json b/site/data/3.12/arangoexport.json index 4b32b776e7..3d6773af5f 100644 --- a/site/data/3.12/arangoexport.json +++ b/site/data/3.12/arangoexport.json @@ -1092,7 +1092,7 @@ }, "server.authentication" : { "category" : "option", - "default" : false, + "default" : true, "deprecatedIn" : null, "description" : "Require authentication credentials when connecting (does not affect the server-side authentication settings).", "dynamic" : false, @@ -1153,7 +1153,7 @@ "server.endpoint" : { "category" : "option", "default" : [ - "http+tcp://127.0.0.1:8529" + "tcp://127.0.0.1:8529" ], "deprecatedIn" : null, "description" : "The endpoint to connect to. Use 'none' to start without a server. Use http+ssl:// as schema to connect to an SSL-secured server endpoint, otherwise http+tcp:// or unix://", diff --git a/site/data/3.12/arangoimport.json b/site/data/3.12/arangoimport.json index 3d48d1ad95..46bb5ed7cd 100644 --- a/site/data/3.12/arangoimport.json +++ b/site/data/3.12/arangoimport.json @@ -389,7 +389,7 @@ "category" : "option", "default" : "", "deprecatedIn" : null, - "description" : "The collection name prefix to prepend to all values in the `_from` attribute.", + "description" : "The collection name prefix to prepend to all values in the `_from` attribute that only specify a document key.", "dynamic" : false, "enterpriseOnly" : false, "experimental" : false, @@ -1165,7 +1165,7 @@ "category" : "option", "default" : false, "deprecatedIn" : null, - "description" : "If the collection name is already prefixed, overwrite the prefix. Only useful in combination with `--from-collection-prefix` / `--to-collection-prefix`.", + "description" : "Force the `--from-collection-prefix` and `--to-collection-prefix`, possibly replacing existing collection name prefixes.", "dynamic" : false, "enterpriseOnly" : false, "experimental" : false, @@ -1281,7 +1281,7 @@ }, "server.authentication" : { "category" : "option", - "default" : false, + "default" : true, "deprecatedIn" : null, "description" : "Require authentication credentials when connecting (does not affect the server-side authentication settings).", "dynamic" : false, @@ -1342,7 +1342,7 @@ "server.endpoint" : { "category" : "option", "default" : [ - "http+tcp://127.0.0.1:8529" + "tcp://127.0.0.1:8529" ], "deprecatedIn" : null, "description" : "The endpoint to connect to. Use 'none' to start without a server. Use http+ssl:// as schema to connect to an SSL-secured server endpoint, otherwise http+tcp:// or unix://", @@ -1553,7 +1553,7 @@ "category" : "option", "default" : "", "deprecatedIn" : null, - "description" : "The collection name prefix to prepend to all values in the `_to` attribute.", + "description" : "The collection name prefix to prepend to all values in the `_to` attribute that only specify a document key.", "dynamic" : false, "enterpriseOnly" : false, "experimental" : false, diff --git a/site/data/3.12/arangoinspect.json b/site/data/3.12/arangoinspect.json index 08b2272477..3d4247bcef 100644 --- a/site/data/3.12/arangoinspect.json +++ b/site/data/3.12/arangoinspect.json @@ -772,7 +772,7 @@ }, "javascript.startup-directory" : { "category" : "option", - "default" : "./js", + "default" : "/usr/share/arangodb3/js", "deprecatedIn" : null, "description" : "The startup paths containing the JavaScript files.", "dynamic" : false, @@ -1628,7 +1628,7 @@ "server.endpoint" : { "category" : "option", "default" : [ - "http+tcp://127.0.0.1:8529" + "tcp://127.0.0.1:8529" ], "deprecatedIn" : null, "description" : "The endpoint to connect to. Use 'none' to start without a server. Use http+ssl:// as schema to connect to an SSL-secured server endpoint, otherwise http+tcp:// or unix://", diff --git a/site/data/3.12/arangorestore.json b/site/data/3.12/arangorestore.json index d3c5fc0ba7..733a848f6b 100644 --- a/site/data/3.12/arangorestore.json +++ b/site/data/3.12/arangorestore.json @@ -1328,7 +1328,7 @@ }, "server.authentication" : { "category" : "option", - "default" : false, + "default" : true, "deprecatedIn" : null, "description" : "Require authentication credentials when connecting (does not affect the server-side authentication settings).", "dynamic" : false, @@ -1389,7 +1389,7 @@ "server.endpoint" : { "category" : "option", "default" : [ - "http+tcp://127.0.0.1:8529" + "tcp://127.0.0.1:8529" ], "deprecatedIn" : null, "description" : "The endpoint to connect to. Use 'none' to start without a server. Use http+ssl:// as schema to connect to an SSL-secured server endpoint, otherwise http+tcp:// or unix://", diff --git a/site/data/3.12/arangosh.json b/site/data/3.12/arangosh.json index 865d8e7a63..8b7f8377e8 100644 --- a/site/data/3.12/arangosh.json +++ b/site/data/3.12/arangosh.json @@ -424,7 +424,7 @@ }, "javascript.allow-external-process-control" : { "category" : "option", - "default" : true, + "default" : false, "deprecatedIn" : null, "description" : "Allow the execution and control of external processes from within JavaScript actions.", "dynamic" : false, @@ -443,7 +443,7 @@ }, "javascript.allow-port-testing" : { "category" : "option", - "default" : true, + "default" : false, "deprecatedIn" : null, "description" : "Allow the testing of ports from within JavaScript actions.", "dynamic" : false, @@ -754,7 +754,6 @@ "javascript.module-directory" : { "category" : "option", "default" : [ - "./enterprise/js" ], "deprecatedIn" : null, "description" : "Additional paths containing JavaScript modules.", @@ -773,7 +772,7 @@ }, "javascript.startup-directory" : { "category" : "option", - "default" : "./js", + "default" : "/usr/share/arangodb3/js", "deprecatedIn" : null, "description" : "The startup paths containing the JavaScript files.", "dynamic" : false, @@ -1568,7 +1567,7 @@ }, "server.authentication" : { "category" : "option", - "default" : false, + "default" : true, "deprecatedIn" : null, "description" : "Require authentication credentials when connecting (does not affect the server-side authentication settings).", "dynamic" : false, @@ -1629,7 +1628,7 @@ "server.endpoint" : { "category" : "option", "default" : [ - "http+tcp://127.0.0.1:8529" + "tcp://127.0.0.1:8529" ], "deprecatedIn" : null, "description" : "The endpoint to connect to. Use 'none' to start without a server. Use http+ssl:// as schema to connect to an SSL-secured server endpoint, otherwise http+tcp:// or unix://.", diff --git a/site/data/3.13/allMetrics.yaml b/site/data/3.13/allMetrics.yaml index 85835e16fe..aeba0530d8 100644 --- a/site/data/3.13/allMetrics.yaml +++ b/site/data/3.13/allMetrics.yaml @@ -662,6 +662,27 @@ Execution time histogram for all AQL queries, in seconds. The histogram includes all slow queries. +- name: arangodb_aql_recording_call_time + type: histogram + category: Statistics + help: | + AQL recording runtime histogram. + description: | + Execution time histogram for AQL recording calls in nanoseconds. + + This histogram tracks the time it takes to record AQL calls in the ApiRecordingFeature. + The histogram uses a logarithmic scale with base 2, starting at 0 and going up to 16000.0 nanoseconds, + with 9 buckets. + unit: nanoseconds + introducedIn: "3.12.6" + category: Agency + complexity: high + exposedBy: + - agent + - coordinator + - dbserver + - single + - name: arangodb_aql_slow_query_time introducedIn: "3.6.10" help: | @@ -6325,6 +6346,38 @@ It shows the block cache capacity in bytes. This can be configured with the `--rocksdb.block-cache-size` startup option. +- name: rocksdb_block_cache_charge_per_entry + introducedIn: "3.12.6" + help: | + Average size of entries in RocksDB block cache. + unit: bytes + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + The metric shows the average size of cache entry value in the RocksDB + block cache. + +- name: rocksdb_block_cache_entries + introducedIn: "3.12.6" + help: | + Number of entries in the RocksDB block cache. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric shows the total number of entries present in the RocksDB block + cache. + - name: rocksdb_block_cache_pinned_usage introducedIn: "3.6.1" help: | @@ -7132,6 +7185,41 @@ nasty delays in database operations are incurred. If in doubt, contact ArangoDB support. +- name: rocksdb_live_blob_file_garbage_size + introducedIn: "3.12.6" + help: | + Size of garbage in live RocksDB .blob files. + unit: bytes + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the RocksDB metric `rocksdb-live-blob-file-garbage-size`. + It shows the total amount of garbage (obsolete, unreferenced blobs) in bytes + over in .blob files belonging to the latest LSM tree, summed over all + column families that use blob files. + +- name: rocksdb_live_blob_file_size + introducedIn: "3.12.6" + help: | + Size of live RocksDB .blob files. + unit: bytes + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the RocksDB metric `rocksdb-live-blob-file-size`. + It shows the total size in bytes of all .blob files belonging to the latest + LSM tree, summed over all column families that use blob files. + - name: rocksdb_live_sst_files_size introducedIn: "3.6.1" help: | @@ -7216,6 +7304,23 @@ This metric exhibits the RocksDB metric `rocksdb-min-log-number-to-keep`. It shows the minimum log number of the log files that should be kept. +- name: rocksdb_num_blob_files + introducedIn: "3.12.6" + help: | + Number of live RocksDB .blob files. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the RocksDB metric `rocksdb-num-blob-files`. + It shows the total number of .blob files belonging to the latest + LSM tree, summed over all column families that use blob files. + - name: rocksdb_num_deletes_active_mem_table introducedIn: "3.6.1" help: | diff --git a/site/data/3.13/arangod.json b/site/data/3.13/arangod.json index 6d36326351..c2a12bba0b 100644 --- a/site/data/3.13/arangod.json +++ b/site/data/3.13/arangod.json @@ -1393,7 +1393,7 @@ "agent", "single" ], - "default" : 7735568384, + "default" : 7735569408, "deprecatedIn" : null, "description" : "The global size limit for all caches (in bytes).", "dynamic" : true, @@ -2255,6 +2255,32 @@ "section" : "database", "type" : "boolean" }, + "database.auto-upgrade-full-compaction" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Perform a full RocksDB compaction after database upgrade.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "If this option is specified together with \n--database.auto-upgrade, the server will perform a full RocksDB compaction \nafter the database upgrade has completed successfully but before shutting down.\n\nThis performs a complete compaction of all column families with both \nchangeLevel and compactBottomMostLevel options enabled, which can help \noptimize the database files after an upgrade.\n\nThe server will exit with an error code if the compaction fails.", + "obsolete" : false, + "os" : [ + "linux" + ], + "required" : false, + "requiresValue" : false, + "section" : "database", + "type" : "boolean" + }, "database.check-version" : { "category" : "command", "component" : [ @@ -2779,7 +2805,7 @@ "dbserver", "single" ], - "default" : 6188454707, + "default" : 6188455526, "deprecatedIn" : null, "description" : "Maximum memory usage (in bytes) to be used by all ongoing dumps.", "dynamic" : true, @@ -4152,13 +4178,13 @@ ], "default" : "true", "deprecatedIn" : null, - "description" : "Whether the log API is enabled (true) or not (false), or only enabled for superuser JWT (jwt).", + "description" : "Whether the log API is enabled (true) or not (false), or only enabled for the superuser (jwt).", "dynamic" : false, "enterpriseOnly" : false, "experimental" : false, "hidden" : false, "introducedIn" : null, - "longDescription" : "Credentials are not written to log files.\nNevertheless, some logged data might be sensitive depending on the context of\nthe deployment. For example, if request logging is switched on, user requests\nand corresponding data might end up in log files. Therefore, a certain care\nwith log files is recommended.\n\nSince the database server offers an API to control logging and query logging\ndata, this API has to be secured properly. By default, the API is accessible\nfor admin users (administrative access to the `_system` database). However,\nyou can lock this down further.\n\nThe possible values for this option are:\n\n - `true`: The `/_admin/log` API is accessible for admin users.\n - `jwt`: The `/_admin/log` API is accessible for the superuser only\n (authentication with JWT token and empty username).\n - `false`: The `/_admin/log` API is not accessible at all.", + "longDescription" : "Credentials are not written to log files.\nNevertheless, some logged data might be sensitive depending on the context of\nthe deployment. For example, if request logging is switched on, user requests\nand corresponding data might end up in log files. Therefore, a certain care\nwith log files is recommended.\n\nSince the database server offers an API to control logging and query logging\ndata, this API has to be secured properly. By default, the API is accessible\nfor admin users (administrative access to the `_system` database).\nHowever, you can restrict it further to the superuser or disable it altogether:\n\n - `true`: The `/_admin/log` API is accessible for admin users.\n - `jwt`: The `/_admin/log` API is accessible for the superuser only\n (authentication with JWT superuser token and empty username).\n - `false`: The `/_admin/log` API is not accessible at all.", "obsolete" : false, "os" : [ "linux" @@ -4725,6 +4751,31 @@ "section" : "log", "type" : "boolean" }, + "log.recording-api-enabled" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "true", + "deprecatedIn" : null, + "description" : "Whether the recording API is enabled (true) or not (false), or only enabled for the superuser (jwt).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "The `/_admin/server/api-calls` and\n`/_admin/server/aql-queries` endpoints provide access to recorded API calls\nand AQL queries respectively. They are referred to as the recording API.\n\nSince this data might be sensitive depending on the context of the deployment,\nthese endpoints need to be properly secured. By default, the recording API is\naccessible for admin users (users with administrative access to the `_system`\ndatabase). However, you can restrict it further to the superuser or disable it\naltogether:\n\n- `true`: The recording API is accessible for admin users.\n- `jwt`: The recording API is accessible for the superuser only\n (authentication with JWT superuser token and empty username).\n- `false`: The recording API is not accessible at all.\n\nWhether API calls and AQL queries are recorded is independent of this option.\nIt is controlled by the `--server.api-call-recording` and\n`--server.aql-query-recording` startup options.", + "obsolete" : false, + "os" : [ + "linux" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, "log.request-parameters" : { "category" : "option", "component" : [ @@ -5669,7 +5720,7 @@ "type" : "boolean" }, "query.global-memory-limit" : { - "base" : 33089757184, + "base" : 33089761280, "category" : "option", "component" : [ "coordinator", @@ -5677,7 +5728,7 @@ "agent", "single" ], - "default" : 26802703319, + "default" : 26802706636, "deprecatedIn" : null, "description" : "The memory threshold for all AQL queries combined (in bytes, 0 = no limit).", "dynamic" : true, @@ -6004,7 +6055,7 @@ "type" : "uint64" }, "query.memory-limit" : { - "base" : 33089757184, + "base" : 33089761280, "category" : "option", "component" : [ "coordinator", @@ -6012,7 +6063,7 @@ "agent", "single" ], - "default" : 19853854311, + "default" : 19853856768, "deprecatedIn" : null, "description" : "The memory threshold per AQL query (in bytes, 0 = no limit).", "dynamic" : true, @@ -7060,6 +7111,36 @@ "section" : "rocksdb", "type" : "uint64" }, + "rocksdb.blob-file-starting-level" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : 0, + "deprecatedIn" : null, + "description" : "The level from which on to use blob files in the documents column family. Requires `--rocksdb.enable-blob-files`.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : true, + "hidden" : false, + "introducedIn" : [ + "v3.12.6" + ], + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint32" + }, "rocksdb.blob-garbage-collection-age-cutoff" : { "base" : 1, "category" : "option", @@ -7145,6 +7226,36 @@ "section" : "rocksdb", "type" : "boolean" }, + "rocksdb.block-cache-estimated-entry-charge" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : 0, + "deprecatedIn" : null, + "description" : "The estimated charge of cache entries (in bytes) for the hyper-clock cache.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : true, + "hidden" : false, + "introducedIn" : [ + "v3.12.6" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, "rocksdb.block-cache-jemalloc-allocator" : { "category" : "option", "component" : [ @@ -7209,7 +7320,7 @@ "agent", "single" ], - "default" : 9282682060, + "default" : 9282683289, "deprecatedIn" : null, "description" : "The size of block cache (in bytes).", "dynamic" : true, @@ -7230,6 +7341,33 @@ "section" : "rocksdb", "type" : "uint64" }, + "rocksdb.block-cache-type" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "lru", + "deprecatedIn" : null, + "description" : "The block cache type to use (note: the 'hyper-clock' cache type is experimental).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.12.6" + ], + "obsolete" : false, + "os" : [ + "linux" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "string", + "values" : "Possible values: \"hyper-clock\", \"lru\"" + }, "rocksdb.bloom-filter-bits-per-key" : { "base" : 1, "category" : "option", @@ -7343,7 +7481,7 @@ "agent", "single" ], - "default" : 2097152, + "default" : 8388608, "deprecatedIn" : null, "description" : "If non-zero, bigger reads are performed when doing compaction. If you run RocksDB on spinning disks, you should set this to at least 2 MB. That way, RocksDB's compaction does sequential instead of random reads.", "dynamic" : false, @@ -7516,6 +7654,32 @@ "section" : "rocksdb", "type" : "boolean" }, + "rocksdb.enable-blob-cache" : { + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Enable caching of blobs in the block cache for the documents column family.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : true, + "hidden" : false, + "introducedIn" : [ + "v3.12.6" + ], + "obsolete" : false, + "os" : [ + "linux" + ], + "required" : false, + "requiresValue" : false, + "section" : "rocksdb", + "type" : "boolean" + }, "rocksdb.enable-blob-files" : { "category" : "option", "component" : [ @@ -7887,6 +8051,7 @@ "introducedIn" : [ "v3.10.0" ], + "longDescription" : "Note that format version 6 can only be read by RocksDB versions\n>= 8.6.0. Thus switching to format version 6 will make the database files\nincompatible with ArangoDB versions with a lower RocksDB version in case of\ndowngrading.", "maxInclusive" : true, "maxValue" : 4294967295, "minInclusive" : true, @@ -7898,7 +8063,7 @@ "requiresValue" : true, "section" : "rocksdb", "type" : "uint32", - "values" : "Possible values: 3, 4, 5" + "values" : "Possible values: 3, 4, 5, 6" }, "rocksdb.intermediate-commit-count" : { "base" : 1, @@ -8222,7 +8387,7 @@ "agent", "single" ], - "default" : 2, + "default" : 4, "deprecatedIn" : null, "description" : "The maximum number of concurrent sub-jobs for a background compaction.", "dynamic" : false, @@ -8250,7 +8415,7 @@ "agent", "single" ], - "default" : 83886080, + "default" : 268435456, "deprecatedIn" : null, "description" : "The maximum total size of WAL files that force a flush of stale column families.", "dynamic" : false, @@ -8957,7 +9122,7 @@ "section" : "rocksdb", "type" : "boolean" }, - "rocksdb.partition-files-for-documents" : { + "rocksdb.optimize-filters-for-memory" : { "category" : "option", "component" : [ "dbserver", @@ -8966,6 +9131,32 @@ ], "default" : false, "deprecatedIn" : null, + "description" : "Optimize RocksDB bloom filters to reduce internal memory fragmentation.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.12.6" + ], + "obsolete" : false, + "os" : [ + "linux" + ], + "required" : false, + "requiresValue" : false, + "section" : "rocksdb", + "type" : "boolean" + }, + "rocksdb.partition-files-for-documents" : { + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, "description" : "If enabled, the document data for different collections/shards will end up in different .sst files.", "dynamic" : false, "enterpriseOnly" : false, @@ -9126,7 +9317,7 @@ "agent", "single" ], - "default" : 131072, + "default" : 1073741824, "deprecatedIn" : null, "description" : "The number of pending compaction bytes that triggers a write slowdown.", "dynamic" : false, @@ -9156,7 +9347,7 @@ "agent", "single" ], - "default" : 17179869184, + "default" : 34359738368, "deprecatedIn" : null, "description" : "The number of pending compaction bytes that triggers a full write stop.", "dynamic" : false, @@ -9257,6 +9448,32 @@ "section" : "rocksdb", "type" : "boolean" }, + "rocksdb.prepopulate-blob-cache" : { + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Pre-populate the blob cache on flushes.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : true, + "hidden" : true, + "introducedIn" : [ + "v3.12.6" + ], + "obsolete" : false, + "os" : [ + "linux" + ], + "required" : false, + "requiresValue" : false, + "section" : "rocksdb", + "type" : "boolean" + }, "rocksdb.prepopulate-block-cache" : { "category" : "option", "component" : [ @@ -9739,7 +9956,7 @@ "agent", "single" ], - "default" : 12376909414, + "default" : 12376911052, "deprecatedIn" : null, "description" : "The maximum total size of in-memory write buffers (0 = unbounded).", "dynamic" : true, @@ -10149,15 +10366,16 @@ "type" : "boolean" }, "server.api-call-recording" : { - "category" : "command", + "category" : "option", "component" : [ "coordinator", "dbserver", "agent", "single" ], + "default" : true, "deprecatedIn" : null, - "description" : "Record recent API calls for debugging purposes (default: true).", + "description" : "Whether to record recent API calls for debugging purposes.", "dynamic" : false, "enterpriseOnly" : false, "experimental" : false, @@ -10167,25 +10385,86 @@ "os" : [ "linux" ], + "required" : false, "requiresValue" : false, "section" : "server", "type" : "boolean" }, "server.api-recording-memory-limit" : { - "category" : "command", + "base" : 1, + "category" : "option", "component" : [ "coordinator", "dbserver", "agent", "single" ], + "default" : 26214400, "deprecatedIn" : null, - "description" : "Memory limit for the list of ApiCallRecords.", + "description" : "Size limit for the list of API call records.", "dynamic" : false, "enterpriseOnly" : false, "experimental" : false, "hidden" : true, "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 274877906944, + "minInclusive" : true, + "minValue" : 262144, + "obsolete" : false, + "os" : [ + "linux" + ], + "requiresValue" : true, + "section" : "server", + "type" : "uint64" + }, + "server.aql-query-recording" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Whether to record recent AQL queries for debugging purposes.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux" + ], + "required" : false, + "requiresValue" : false, + "section" : "server", + "type" : "boolean" + }, + "server.aql-recording-memory-limit" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 26214400, + "deprecatedIn" : null, + "description" : "Size limit for the list of AQL query records.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 274877906944, + "minInclusive" : true, + "minValue" : 262144, "obsolete" : false, "os" : [ "linux" @@ -10724,6 +11003,64 @@ "section" : "server", "type" : "uint64" }, + "server.license-disk-usage-grace-period-readonly" : { + "base" : 172800, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 172800, + "deprecatedIn" : null, + "description" : "The warning duration until the server enters read-only mode when exceeding the dataset size limit (in seconds). The maximum is 2 days.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 172800, + "minInclusive" : true, + "minValue" : 1, + "obsolete" : false, + "os" : [ + "linux" + ], + "requiresValue" : true, + "section" : "server", + "type" : "uint64" + }, + "server.license-disk-usage-grace-period-shutdown" : { + "base" : 172800, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 172800, + "deprecatedIn" : null, + "description" : "The read-only duration until the server shuts down when exceeding the dataset size limit (in seconds). The maximum is 2 days.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 172800, + "minInclusive" : true, + "minValue" : 1, + "obsolete" : false, + "os" : [ + "linux" + ], + "requiresValue" : true, + "section" : "server", + "type" : "uint64" + }, "server.license-disk-usage-limit" : { "base" : 107374182400, "category" : "option", diff --git a/site/data/3.13/arangoimport.json b/site/data/3.13/arangoimport.json index ea0d0f2b33..46bb5ed7cd 100644 --- a/site/data/3.13/arangoimport.json +++ b/site/data/3.13/arangoimport.json @@ -389,7 +389,7 @@ "category" : "option", "default" : "", "deprecatedIn" : null, - "description" : "The collection name prefix to prepend to all values in the `_from` attribute.", + "description" : "The collection name prefix to prepend to all values in the `_from` attribute that only specify a document key.", "dynamic" : false, "enterpriseOnly" : false, "experimental" : false, @@ -1165,7 +1165,7 @@ "category" : "option", "default" : false, "deprecatedIn" : null, - "description" : "If the collection name is already prefixed, overwrite the prefix. Only useful in combination with `--from-collection-prefix` / `--to-collection-prefix`.", + "description" : "Force the `--from-collection-prefix` and `--to-collection-prefix`, possibly replacing existing collection name prefixes.", "dynamic" : false, "enterpriseOnly" : false, "experimental" : false, @@ -1553,7 +1553,7 @@ "category" : "option", "default" : "", "deprecatedIn" : null, - "description" : "The collection name prefix to prepend to all values in the `_to` attribute.", + "description" : "The collection name prefix to prepend to all values in the `_to` attribute that only specify a document key.", "dynamic" : false, "enterpriseOnly" : false, "experimental" : false,