[CircleCI Generated] generate-scheduled-13484

site/data/3.12/allMetrics.yaml

@@ -386,7 +386,6 @@
 
 - name: arangodb_api_recording_call_time
   type: histogram
-  category: Statistics
   help: |
     API recording runtime histogram.
   description: |
@@ -397,7 +396,7 @@
     with 9 buckets.
   unit: nanoseconds
   introducedIn: "3.12.5"
-  category: Agency
+  category: Statistics
   complexity: high
   exposedBy:
     - agent
@@ -662,6 +661,26 @@
     Execution time histogram for all AQL queries, in seconds.
     The histogram includes all slow queries.
 
+- name: arangodb_aql_recording_call_time
+  type: histogram
+  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: Statistics
+  complexity: high
+  exposedBy:
+    - agent
+    - coordinator
+    - dbserver
+    - single
+
 - name: arangodb_aql_slow_query_time
   introducedIn: "3.6.10"
   help: |
@@ -6325,6 +6344,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 +7183,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 +7302,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: |

site/data/3.12/arangobackup.json

@@ -598,13 +598,13 @@
     "default" : [
     ],
     "deprecatedIn" : null,
-    "description" : "Log destination(s), e.g. file:///path/to/file (any occurrence of $PID is replaced with the process ID).",
+    "description" : "Log destination(s), e.g. file:///path/to/file (any literal occurrence of $PID and @PID@ is replaced with the process ID, and @TEMP_BASE_DIR@ with the path of the current temporary directory).",
     "dynamic" : false,
     "enterpriseOnly" : false,
     "experimental" : false,
     "hidden" : false,
     "introducedIn" : null,
-    "longDescription" : "This option allows you to direct the global or\nper-topic log messages to different outputs. The output definition can be one\nof the following:\n\n- `-` for stdout\n- `+` for stderr\n- `syslog://<syslog-facility>`\n- `syslog://<syslog-facility>/<application-name>`\n- `file://<relative-or-absolute-path>`\n\nTo set up a per-topic output configuration, use\n`--log.output <topic>=<definition>`:\n\n`--log.output queries=file://queries.log`\n\nThe above example logs query-related messages to the file `queries.log`.\n\nYou can specify the option multiple times in order to configure the output\nfor different log topics:\n\n`--log.level queries=trace --log.output queries=file:///queries.log\n--log.level requests=info --log.output requests=file:///requests.log`\n\nThe above example logs all query-related messages to the file `queries.log`\nand HTTP requests with a level of `info` or higher to the file `requests.log`.\n\nAny occurrence of `$PID` in the log output value is replaced at runtime with\nthe actual process ID. This enables logging to process-specific files:\n\n`--log.output 'file://arangod.log.$PID'`\n\nNote that dollar sign may need extra escaping when specified on a\ncommand-line such as Bash.\n\nIf you specify `--log.file-mode <octalvalue>`, then any newly created log\nfile uses `octalvalue` as file mode. Please note that the `umask` value is\napplied as well.\n\nIf you specify `--log.file-group <name>`, then any newly created log file tries\nto use `<name>` as the group name. Note that you have to be a member of that\ngroup. Otherwise, the group ownership is not changed.\n\nThe old `--log.file` option is still available for convenience. It is a\nshortcut for the more general option `--log.output file://filename`.\n\nThe old `--log.requests-file` option is still available. It is a shortcut for\nthe more general option `--log.output requests=file://...`.\n\nTo change the log levels for the specified output you can add a comma separated\nlist of topics with their respective level after the output definition, separated\nby a semicolon:\n`--log.output file:///path/to/file;queries=trace,requests=info`\n`--log.output -;all=error`",
+    "longDescription" : "This option allows you to direct the global or\nper-topic log messages to different outputs. The output definition can be one\nof the following:\n\n- `-` for stdout\n- `+` for stderr\n- `syslog://<syslog-facility>`\n- `syslog://<syslog-facility>/<application-name>`\n- `file://<relative-or-absolute-path>`\n\nTo set up a per-topic output configuration, use\n`--log.output <topic>=<definition>`:\n\n`--log.output queries=file://queries.log`\n\nThe above example logs query-related messages to the file `queries.log`.\n\nYou can specify the option multiple times in order to configure the output\nfor different log topics:\n\n`--log.level queries=trace --log.output queries=file:///queries.log\n--log.level requests=info --log.output requests=file:///requests.log`\n\nThe above example logs all query-related messages to the file `queries.log`\nand HTTP requests with a level of `info` or higher to the file `requests.log`.\n\nFor file-based logging, the folders of the destination path need to exist\nalready. They are not created implicitly.\n\nAny occurrence of `$PID` and `@PID` in the log output value is replaced at\nruntime with the actual process ID. This enables logging to process-specific\nfiles:\n\n`--log.output 'file://arangod.log.$PID'`\n\nNote that the dollar sign may need extra escaping when specified on a\ncommand-line such as Bash. You can typically wrap the entire value in single\nquote marks to prevent variable substitution.\n\nAny occurrence of `@TEMP_BASE_DIR@` in the log output value is replaced at\nruntime with the current temporary directory, e.g. `/tmp/arangodb_i37Xxh`\n(automatically created on startup with a randomly generated suffix).\n\nKeep in mind that `@NAME@` is also the syntax for using the value of an\nenvironment variable `NAME`. If there is a environment variable called `PID` or\n`TEMP_BASE_DIR`, then `@PID@` and `@TEMP_BASE_DIR@` are substituted with the\nvalue of the respective environment variable.\n\nIf you specify `--log.file-mode <octalvalue>`, then any newly created log\nfile uses `octalvalue` as file mode. Please note that the `umask` value is\napplied as well.\n\nIf you specify `--log.file-group <name>`, then any newly created log file tries\nto use `<name>` as the group name. Note that you have to be a member of that\ngroup. Otherwise, the group ownership is not changed.\n\nThe old `--log.file` option is still available for convenience. It is a\nshortcut for the more general option `--log.output file://filename`.\n\nThe old `--log.requests-file` option is still available. It is a shortcut for\nthe more general option `--log.output requests=file://...`.\n\nTo change the log levels for the specified output you can add a comma separated\nlist of topics with their respective level after the output definition, separated\nby a semicolon:\n`--log.output file:///path/to/file;queries=trace,requests=info`\n`--log.output -;all=error`",
     "obsolete" : false,
     "os" : [
       "linux"
@@ -1111,7 +1111,7 @@
     "category" : "option",
     "default" : "",
     "deprecatedIn" : null,
-    "description" : "The password to use when connecting. If not specified and authentication is required, you are prompted for a password.\nIn startup options, you can wrap the names of environment variables in at signs to use their value, like @ARANGO_PASSWORD@. This helps to expose the password less, like to the process list. Literal @ need to be escaped as @@.",
+    "description" : "The password or access token to use when connecting. If not specified and authentication is required, you are prompted for a password.\nIn startup options, you can wrap the names of environment variables in at signs to use their value, like @ARANGO_PASSWORD@. This helps to expose the password less, like to the process list. Literal @ need to be escaped as @@.",
     "dynamic" : false,
     "enterpriseOnly" : false,
     "experimental" : false,
@@ -1152,7 +1152,7 @@
     "category" : "option",
     "default" : "root",
     "deprecatedIn" : null,
-    "description" : "The username to use when connecting.",
+    "description" : "The username to use when connecting.\nIf you want to specify an access token as the password, set the user name as encoded in the token.",
     "dynamic" : false,
     "enterpriseOnly" : false,
     "experimental" : false,

site/data/3.12/arangobench.json

@@ -838,13 +838,13 @@
     "default" : [
     ],
     "deprecatedIn" : null,
-    "description" : "Log destination(s), e.g. file:///path/to/file (any occurrence of $PID is replaced with the process ID).",
+    "description" : "Log destination(s), e.g. file:///path/to/file (any literal occurrence of $PID and @PID@ is replaced with the process ID, and @TEMP_BASE_DIR@ with the path of the current temporary directory).",
     "dynamic" : false,
     "enterpriseOnly" : false,
     "experimental" : false,
     "hidden" : false,
     "introducedIn" : null,
-    "longDescription" : "This option allows you to direct the global or\nper-topic log messages to different outputs. The output definition can be one\nof the following:\n\n- `-` for stdout\n- `+` for stderr\n- `syslog://<syslog-facility>`\n- `syslog://<syslog-facility>/<application-name>`\n- `file://<relative-or-absolute-path>`\n\nTo set up a per-topic output configuration, use\n`--log.output <topic>=<definition>`:\n\n`--log.output queries=file://queries.log`\n\nThe above example logs query-related messages to the file `queries.log`.\n\nYou can specify the option multiple times in order to configure the output\nfor different log topics:\n\n`--log.level queries=trace --log.output queries=file:///queries.log\n--log.level requests=info --log.output requests=file:///requests.log`\n\nThe above example logs all query-related messages to the file `queries.log`\nand HTTP requests with a level of `info` or higher to the file `requests.log`.\n\nAny occurrence of `$PID` in the log output value is replaced at runtime with\nthe actual process ID. This enables logging to process-specific files:\n\n`--log.output 'file://arangod.log.$PID'`\n\nNote that dollar sign may need extra escaping when specified on a\ncommand-line such as Bash.\n\nIf you specify `--log.file-mode <octalvalue>`, then any newly created log\nfile uses `octalvalue` as file mode. Please note that the `umask` value is\napplied as well.\n\nIf you specify `--log.file-group <name>`, then any newly created log file tries\nto use `<name>` as the group name. Note that you have to be a member of that\ngroup. Otherwise, the group ownership is not changed.\n\nThe old `--log.file` option is still available for convenience. It is a\nshortcut for the more general option `--log.output file://filename`.\n\nThe old `--log.requests-file` option is still available. It is a shortcut for\nthe more general option `--log.output requests=file://...`.\n\nTo change the log levels for the specified output you can add a comma separated\nlist of topics with their respective level after the output definition, separated\nby a semicolon:\n`--log.output file:///path/to/file;queries=trace,requests=info`\n`--log.output -;all=error`",
+    "longDescription" : "This option allows you to direct the global or\nper-topic log messages to different outputs. The output definition can be one\nof the following:\n\n- `-` for stdout\n- `+` for stderr\n- `syslog://<syslog-facility>`\n- `syslog://<syslog-facility>/<application-name>`\n- `file://<relative-or-absolute-path>`\n\nTo set up a per-topic output configuration, use\n`--log.output <topic>=<definition>`:\n\n`--log.output queries=file://queries.log`\n\nThe above example logs query-related messages to the file `queries.log`.\n\nYou can specify the option multiple times in order to configure the output\nfor different log topics:\n\n`--log.level queries=trace --log.output queries=file:///queries.log\n--log.level requests=info --log.output requests=file:///requests.log`\n\nThe above example logs all query-related messages to the file `queries.log`\nand HTTP requests with a level of `info` or higher to the file `requests.log`.\n\nFor file-based logging, the folders of the destination path need to exist\nalready. They are not created implicitly.\n\nAny occurrence of `$PID` and `@PID` in the log output value is replaced at\nruntime with the actual process ID. This enables logging to process-specific\nfiles:\n\n`--log.output 'file://arangod.log.$PID'`\n\nNote that the dollar sign may need extra escaping when specified on a\ncommand-line such as Bash. You can typically wrap the entire value in single\nquote marks to prevent variable substitution.\n\nAny occurrence of `@TEMP_BASE_DIR@` in the log output value is replaced at\nruntime with the current temporary directory, e.g. `/tmp/arangodb_i37Xxh`\n(automatically created on startup with a randomly generated suffix).\n\nKeep in mind that `@NAME@` is also the syntax for using the value of an\nenvironment variable `NAME`. If there is a environment variable called `PID` or\n`TEMP_BASE_DIR`, then `@PID@` and `@TEMP_BASE_DIR@` are substituted with the\nvalue of the respective environment variable.\n\nIf you specify `--log.file-mode <octalvalue>`, then any newly created log\nfile uses `octalvalue` as file mode. Please note that the `umask` value is\napplied as well.\n\nIf you specify `--log.file-group <name>`, then any newly created log file tries\nto use `<name>` as the group name. Note that you have to be a member of that\ngroup. Otherwise, the group ownership is not changed.\n\nThe old `--log.file` option is still available for convenience. It is a\nshortcut for the more general option `--log.output file://filename`.\n\nThe old `--log.requests-file` option is still available. It is a shortcut for\nthe more general option `--log.output requests=file://...`.\n\nTo change the log levels for the specified output you can add a comma separated\nlist of topics with their respective level after the output definition, separated\nby a semicolon:\n`--log.output file:///path/to/file;queries=trace,requests=info`\n`--log.output -;all=error`",
     "obsolete" : false,
     "os" : [
       "linux"
@@ -1380,7 +1380,7 @@
     "category" : "option",
     "default" : "",
     "deprecatedIn" : null,
-    "description" : "The password to use when connecting. If not specified and authentication is required, you are prompted for a password.\nIn startup options, you can wrap the names of environment variables in at signs to use their value, like @ARANGO_PASSWORD@. This helps to expose the password less, like to the process list. Literal @ need to be escaped as @@.",
+    "description" : "The password or access token to use when connecting. If not specified and authentication is required, you are prompted for a password.\nIn startup options, you can wrap the names of environment variables in at signs to use their value, like @ARANGO_PASSWORD@. This helps to expose the password less, like to the process list. Literal @ need to be escaped as @@.",
     "dynamic" : false,
     "enterpriseOnly" : false,
     "experimental" : false,
@@ -1421,7 +1421,7 @@
     "category" : "option",
     "default" : "root",
     "deprecatedIn" : null,
-    "description" : "The username to use when connecting.",
+    "description" : "The username to use when connecting.\nIf you want to specify an access token as the password, set the user name as encoded in the token.",
     "dynamic" : false,
     "enterpriseOnly" : false,
     "experimental" : false,