diff --git a/site/data/3.12/allMetrics.yaml b/site/data/3.12/allMetrics.yaml index 85835e16fe..504384e6a0 100644 --- a/site/data/3.12/allMetrics.yaml +++ b/site/data/3.12/allMetrics.yaml @@ -6325,6 +6325,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 +7164,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 +7283,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..9f536137fd 100644 --- a/site/data/3.12/arangod.json +++ b/site/data/3.12/arangod.json @@ -1393,7 +1393,7 @@ "agent", "single" ], - "default" : 7735566336, + "default" : 7735568384, "deprecatedIn" : null, "description" : "The global size limit for all caches (in bytes).", "dynamic" : true, @@ -2313,7 +2313,7 @@ "agent", "single" ], - "default" : "", + "default" : "/var/lib/arangodb3", "deprecatedIn" : null, "description" : "The path to the database directory.", "dynamic" : false, @@ -2779,7 +2779,7 @@ "dbserver", "single" ], - "default" : 6188453068, + "default" : 6188454707, "deprecatedIn" : null, "description" : "Maximum memory usage (in bytes) to be used by all ongoing dumps.", "dynamic" : true, @@ -3474,7 +3474,7 @@ "coordinator", "single" ], - "default" : "./js/apps", + "default" : "/var/lib/arangodb3-apps", "deprecatedIn" : null, "description" : "The directory for Foxx applications.", "dynamic" : false, @@ -3738,7 +3738,6 @@ "single" ], "default" : [ - "./enterprise/js" ], "deprecatedIn" : null, "description" : "Additional paths containing JavaScript modules.", @@ -3811,7 +3810,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, @@ -4257,7 +4256,7 @@ "agent", "single" ], - "default" : "", + "default" : "-", "deprecatedIn" : null, "description" : "Shortcut for `--log.output file://`", "dynamic" : false, @@ -5670,7 +5669,7 @@ "type" : "boolean" }, "query.global-memory-limit" : { - "base" : 33089748992, + "base" : 33089757184, "category" : "option", "component" : [ "coordinator", @@ -5678,7 +5677,7 @@ "agent", "single" ], - "default" : 26802696683, + "default" : 26802703319, "deprecatedIn" : null, "description" : "The memory threshold for all AQL queries combined (in bytes, 0 = no limit).", "dynamic" : true, @@ -6005,7 +6004,7 @@ "type" : "uint64" }, "query.memory-limit" : { - "base" : 33089748992, + "base" : 33089757184, "category" : "option", "component" : [ "coordinator", @@ -6013,7 +6012,7 @@ "agent", "single" ], - "default" : 19853849395, + "default" : 19853854311, "deprecatedIn" : null, "description" : "The memory threshold per AQL query (in bytes, 0 = no limit).", "dynamic" : true, @@ -7061,6 +7060,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 +7175,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 +7269,7 @@ "agent", "single" ], - "default" : 9282679603, + "default" : 9282682060, "deprecatedIn" : null, "description" : "The size of block cache (in bytes).", "dynamic" : true, @@ -7231,6 +7290,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 +7430,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 +7603,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 +8000,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 +8012,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 +8336,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 +8364,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 +9071,7 @@ "section" : "rocksdb", "type" : "boolean" }, - "rocksdb.partition-files-for-documents" : { + "rocksdb.optimize-filters-for-memory" : { "category" : "option", "component" : [ "dbserver", @@ -8967,6 +9080,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 +9266,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 +9296,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 +9397,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 +9905,7 @@ "agent", "single" ], - "default" : 12376906137, + "default" : 12376909414, "deprecatedIn" : null, "description" : "The maximum total size of in-memory write buffers (0 = unbounded).", "dynamic" : true, 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..504384e6a0 100644 --- a/site/data/3.13/allMetrics.yaml +++ b/site/data/3.13/allMetrics.yaml @@ -6325,6 +6325,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 +7164,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 +7283,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..9f536137fd 100644 --- a/site/data/3.13/arangod.json +++ b/site/data/3.13/arangod.json @@ -7060,6 +7060,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 +7175,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" : [ @@ -7230,6 +7290,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 +7430,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 +7603,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 +8000,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 +8012,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 +8336,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 +8364,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 +9071,7 @@ "section" : "rocksdb", "type" : "boolean" }, - "rocksdb.partition-files-for-documents" : { + "rocksdb.optimize-filters-for-memory" : { "category" : "option", "component" : [ "dbserver", @@ -8966,6 +9080,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 +9266,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 +9296,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 +9397,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" : [ 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,