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 2b453ad295..9719db0ae5 100644 --- a/site/data/3.12/arangobackup.json +++ b/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://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\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 `, 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 `, then any newly created log file tries\nto use `` 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://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\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 `, 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 `, then any newly created log file tries\nto use `` 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, diff --git a/site/data/3.12/arangobench.json b/site/data/3.12/arangobench.json index 6b9809ef71..2272c74580 100644 --- a/site/data/3.12/arangobench.json +++ b/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://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\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 `, 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 `, then any newly created log file tries\nto use `` 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://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\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 `, 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 `, then any newly created log file tries\nto use `` 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, diff --git a/site/data/3.12/arangod.json b/site/data/3.12/arangod.json index cc15f1a2bf..d6ed3f24d4 100644 --- a/site/data/3.12/arangod.json +++ b/site/data/3.12/arangod.json @@ -1610,7 +1610,7 @@ "experimental" : false, "hidden" : false, "introducedIn" : null, - "longDescription" : "If set to `true`, forces the cluster into creating\nall future collections with only a single shard and using the same DB-Server as\nas these collections' shards leader. All collections created this way are\neligible for specific AQL query optimizations that can improve query performance\nand provide advanced transactional guarantees.\n\n**Warning**: Use the same value on all Coordinators and all DBServers!", + "longDescription" : "If set to `true`, forces the cluster into creating\nall future collections with only a single shard and using the same DB-Server\nas these collections' shards leader. All collections created this way are\neligible for specific AQL query optimizations that can improve query performance\nand provide advanced transactional guarantees.\n\n**Warning**: Use the same value on all Coordinators and all DBServers!", "obsolete" : false, "os" : [ "linux" @@ -2911,18 +2911,21 @@ "experimental-vector-index" : { "category" : "option", "component" : [ + "coordinator", + "dbserver", + "single" ], "default" : false, "deprecatedIn" : null, - "description" : "Turn on experimental vector index feature.", + "description" : "Enable the experimental vector index feature.Once in use, this option cannot be turned off again.", "dynamic" : false, "enterpriseOnly" : false, - "experimental" : false, + "experimental" : true, "hidden" : false, "introducedIn" : [ "v3.12.4" ], - "longDescription" : "Turn on experimental vector index features. If this is enabled\ndowngrading from this version will no longer be possible.", + "longDescription" : "This startup option should not be enabled for\nAgents in a cluster as it has no effect on them other than that you need to\nleave the option enabled.", "obsolete" : false, "os" : [ "linux" @@ -4178,13 +4181,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" @@ -4657,13 +4660,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://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\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 `, 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 `, then any newly created log file tries\nto use `` 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://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\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 `, 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 `, then any newly created log file tries\nto use `` 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" @@ -4751,6 +4754,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" : [ @@ -7086,6 +7114,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", @@ -7171,6 +7229,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" : [ @@ -7256,6 +7344,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", @@ -7542,6 +7657,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" : [ @@ -7913,6 +8054,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, @@ -7924,7 +8066,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, @@ -8983,7 +9125,7 @@ "section" : "rocksdb", "type" : "boolean" }, - "rocksdb.partition-files-for-documents" : { + "rocksdb.optimize-filters-for-memory" : { "category" : "option", "component" : [ "dbserver", @@ -8992,6 +9134,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, @@ -9152,7 +9320,7 @@ "agent", "single" ], - "default" : 131072, + "default" : 1073741824, "deprecatedIn" : null, "description" : "The number of pending compaction bytes that triggers a write slowdown.", "dynamic" : false, @@ -9182,7 +9350,7 @@ "agent", "single" ], - "default" : 17179869184, + "default" : 34359738368, "deprecatedIn" : null, "description" : "The number of pending compaction bytes that triggers a full write stop.", "dynamic" : false, @@ -9283,6 +9451,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" : [ @@ -9826,8 +10020,10 @@ "single" ], "default" : 1000, - "deprecatedIn" : null, - "description" : "If positive, specifies the wait timeout in milliseconds when a transaction attempts to lock a document. A negative value is not recommended as it can lead to deadlocks (0 = no waiting, < 0 no timeout)", + "deprecatedIn" : [ + "v3.12.6" + ], + "description" : "If positive, specifies the wait timeout in milliseconds when a transaction attempts to lock a document. A negative value is not recommended as it can lead to deadlocks (0 = no waiting, < 0 no timeout). This is deprecated since we internally control the lock timeout for different cases.", "dynamic" : false, "enterpriseOnly" : false, "experimental" : false, @@ -10175,15 +10371,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, @@ -10193,25 +10390,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" @@ -10750,6 +11008,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 a80ae94139..6b692b4626 100644 --- a/site/data/3.12/arangodump.json +++ b/site/data/3.12/arangodump.json @@ -922,13 +922,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://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\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 `, 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 `, then any newly created log file tries\nto use `` 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://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\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 `, 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 `, then any newly created log file tries\nto use `` 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" @@ -1468,7 +1468,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, @@ -1509,7 +1509,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, diff --git a/site/data/3.12/arangoexport.json b/site/data/3.12/arangoexport.json index 3d6773af5f..45b6f8862d 100644 --- a/site/data/3.12/arangoexport.json +++ b/site/data/3.12/arangoexport.json @@ -729,13 +729,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://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\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 `, 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 `, then any newly created log file tries\nto use `` 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://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\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 `, 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 `, then any newly created log file tries\nto use `` 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" @@ -1197,7 +1197,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, @@ -1238,7 +1238,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, diff --git a/site/data/3.12/arangoimport.json b/site/data/3.12/arangoimport.json index ea0d0f2b33..32555dea53 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, @@ -796,13 +796,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://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\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 `, 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 `, then any newly created log file tries\nto use `` 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://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\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 `, 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 `, then any newly created log file tries\nto use `` 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" @@ -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, @@ -1386,7 +1386,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, @@ -1427,7 +1427,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, @@ -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 3d4247bcef..91a47c7717 100644 --- a/site/data/3.12/arangoinspect.json +++ b/site/data/3.12/arangoinspect.json @@ -1222,13 +1222,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://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\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 `, 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 `, then any newly created log file tries\nto use `` 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://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\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 `, 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 `, then any newly created log file tries\nto use `` 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" @@ -1690,7 +1690,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, @@ -1731,7 +1731,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, diff --git a/site/data/3.12/arangorestore.json b/site/data/3.12/arangorestore.json index 733a848f6b..1ca756513f 100644 --- a/site/data/3.12/arangorestore.json +++ b/site/data/3.12/arangorestore.json @@ -900,13 +900,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://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\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 `, 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 `, then any newly created log file tries\nto use `` 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://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\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 `, 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 `, then any newly created log file tries\nto use `` 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" @@ -1451,7 +1451,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, @@ -1492,7 +1492,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, diff --git a/site/data/3.12/arangosh.json b/site/data/3.12/arangosh.json index 8b7f8377e8..bffafba747 100644 --- a/site/data/3.12/arangosh.json +++ b/site/data/3.12/arangosh.json @@ -1222,13 +1222,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://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\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 `, 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 `, then any newly created log file tries\nto use `` 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://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\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 `, 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 `, then any newly created log file tries\nto use `` 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" @@ -1710,7 +1710,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, @@ -1751,7 +1751,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, diff --git a/site/data/3.12/arangovpack.json b/site/data/3.12/arangovpack.json index 35df295f1a..09b5fd870a 100644 --- a/site/data/3.12/arangovpack.json +++ b/site/data/3.12/arangovpack.json @@ -500,13 +500,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://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\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 `, 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 `, then any newly created log file tries\nto use `` 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://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\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 `, 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 `, then any newly created log file tries\nto use `` 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" diff --git a/site/data/3.12/optimizer-rules.json b/site/data/3.12/optimizer-rules.json index ad4d0ec7a7..416dcc1307 100644 --- a/site/data/3.12/optimizer-rules.json +++ b/site/data/3.12/optimizer-rules.json @@ -37,7 +37,7 @@ }, { "name": "replace-entries-with-object-iteration", - "description": "Replace FOR ... ENTRIES(obj) enumeration with proper object iteration.", + "description": "Replace FOR ... ENTRIES(obj) enumeration with proper object iteration\nto avoid copying a lot of key/value pairs and storing intermediate results.", "flags": { "hidden": false, "clusterOnly": false, @@ -289,7 +289,7 @@ }, { "name": "geo-index-optimizer", - "description": "Utilize geo-spatial indexes.", + "description": "Utilize geo-spatial indexes to remove `FILTER DISTANCE(...)`\nand SORT DISTANCE(...)`.", "flags": { "hidden": false, "clusterOnly": false, @@ -337,7 +337,7 @@ }, { "name": "use-vector-index", - "description": "Apply vector index.", + "description": "Utilize a vector index to accelerate the comparison of\nvector embeddings with vector similarity AQL functions.", "flags": { "hidden": false, "clusterOnly": false, @@ -397,7 +397,7 @@ }, { "name": "optimize-enumerate-path-filters", - "description": "Move `FILTER` conditions on the path output variable into the path search", + "description": "Move `FILTER` conditions on the path output variable into the path search.", "flags": { "hidden": false, "clusterOnly": false, @@ -733,7 +733,7 @@ }, { "name": "reduce-extraction-to-projection", - "description": "Modify `EnumerationCollectionNode` and `IndexNode` that would have\nextracted entire documents to only return a projection of each document.\n\nProjections are limited to at most 5 different document attributes by default.\nThe maximum number of projected attributes can optionally be adjusted by\nsetting the `maxProjections` hint for an AQL `FOR` operation since\nArangoDB 3.9.1.", + "description": "Modify `EnumerationCollectionNode` and `IndexNode` that would have\nextracted entire documents to only return a projection of each document.\n\nProjections are limited to at most 5 different document attributes by default.\nThe maximum number of projected attributes can optionally be adjusted by\nsetting the `maxProjections` hint for an AQL `FOR` operation.", "flags": { "hidden": false, "clusterOnly": false, @@ -829,7 +829,7 @@ }, { "name": "push-limit-into-index", - "description": "Push limit into index node.", + "description": "Reduce results early for a combination of `FILTER`, `SORT`,\nand `LIMIT` where the filter condition uses the `IN` comparison operator and\nthe condition and sort attributes are covered by a persistent index, so that\nthe limit can already be applied when reading from the index. Additional\nrequirements are that there is no outer loop and no post-filtering, and the\nattributes to sort by must all be in the same direction.", "flags": { "hidden": false, "clusterOnly": false, @@ -841,7 +841,7 @@ }, { "name": "batch-materialize-documents", - "description": "Batch document lookup from indexes.", + "description": "Batch document lookups from indexes for efficiency.", "flags": { "hidden": false, "clusterOnly": false, @@ -865,7 +865,7 @@ }, { "name": "join-index-nodes", - "description": "Join adjacent index nodes and replace them with a join node\nin case the indexes qualify for it.", + "description": "Join adjacent index nodes and replace them with a join node\nin case the indexes qualify for it.\n\nIf two or more collections are joined using nested `FOR` loops and the\nattributes to join on are indexed by primary indexes or persistent indexes,\nthen a merge join can be performed because they are sorted. Returning\ndocument attributes from the outer loop is limited to attributes covered by\nthe index.", "flags": { "hidden": false, "clusterOnly": false, @@ -877,7 +877,7 @@ }, { "name": "use-index-for-collect", - "description": "Use indexes for a collect statement if appropriate.", + "description": "Use indexes for a `COLLECT` operation if possible.\nPersistent indexes can speed up the scanning for distinct values up to orders\nof magnitude if the selectivity is low, i.e. if there are few different\nvalues. Furthermore, they can be used to cover eligible\n`COLLECT ... AGGREGATE` operations.", "flags": { "hidden": false, "clusterOnly": false, @@ -889,7 +889,7 @@ }, { "name": "push-down-late-materialization", - "description": "Push down late materialization.", + "description": "Defer loading documents when attributes accessed in `FILTER`\nand `SORT` operations are covered by an index. The rule can also push the\nmaterialization past `FOR` loops in case they are optimized to a merge join.", "flags": { "hidden": false, "clusterOnly": false, @@ -901,7 +901,7 @@ }, { "name": "materialize-into-separate-variable", - "description": "Introduce a separate variable for late materialization.", + "description": "Introduce separate internal variables for projected\nattributes. This enables late materialization that avoids the creation of\ntemporary objects and having to look up attributes by key in these objects.", "flags": { "hidden": false, "clusterOnly": false, @@ -949,7 +949,7 @@ }, { "name": "immutable-search-condition", - "description": "Optimize immutable search condition for nested loops, we don't need to make real search many times, if we can cache results in bitset", + "description": "Optimize immutable search condition for nested loops. There is no need\nto perform a real search repeatedly if the results can be cached in a bitset.", "flags": { "hidden": false, "clusterOnly": false, diff --git a/site/data/3.13/arangobackup.json b/site/data/3.13/arangobackup.json index 2b453ad295..9719db0ae5 100644 --- a/site/data/3.13/arangobackup.json +++ b/site/data/3.13/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://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\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 `, 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 `, then any newly created log file tries\nto use `` 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://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\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 `, 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 `, then any newly created log file tries\nto use `` 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, diff --git a/site/data/3.13/arangobench.json b/site/data/3.13/arangobench.json index 6b9809ef71..2272c74580 100644 --- a/site/data/3.13/arangobench.json +++ b/site/data/3.13/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://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\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 `, 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 `, then any newly created log file tries\nto use `` 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://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\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 `, 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 `, then any newly created log file tries\nto use `` 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, diff --git a/site/data/3.13/arangod.json b/site/data/3.13/arangod.json index 416d56b357..d6ed3f24d4 100644 --- a/site/data/3.13/arangod.json +++ b/site/data/3.13/arangod.json @@ -2911,18 +2911,21 @@ "experimental-vector-index" : { "category" : "option", "component" : [ + "coordinator", + "dbserver", + "single" ], "default" : false, "deprecatedIn" : null, - "description" : "Turn on experimental vector index feature.", + "description" : "Enable the experimental vector index feature.Once in use, this option cannot be turned off again.", "dynamic" : false, "enterpriseOnly" : false, - "experimental" : false, + "experimental" : true, "hidden" : false, "introducedIn" : [ "v3.12.4" ], - "longDescription" : "Turn on experimental vector index features. If this is enabled\ndowngrading from this version will no longer be possible.", + "longDescription" : "This startup option should not be enabled for\nAgents in a cluster as it has no effect on them other than that you need to\nleave the option enabled.", "obsolete" : false, "os" : [ "linux" @@ -4657,13 +4660,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://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\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 `, 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 `, then any newly created log file tries\nto use `` 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://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\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 `, 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 `, then any newly created log file tries\nto use `` 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" @@ -7481,7 +7484,7 @@ "agent", "single" ], - "default" : 8388608, + "default" : 2097152, "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, @@ -8387,7 +8390,7 @@ "agent", "single" ], - "default" : 4, + "default" : 2, "deprecatedIn" : null, "description" : "The maximum number of concurrent sub-jobs for a background compaction.", "dynamic" : false, @@ -8415,7 +8418,7 @@ "agent", "single" ], - "default" : 268435456, + "default" : 83886080, "deprecatedIn" : null, "description" : "The maximum total size of WAL files that force a flush of stale column families.", "dynamic" : false, diff --git a/site/data/3.13/arangodump.json b/site/data/3.13/arangodump.json index a80ae94139..6b692b4626 100644 --- a/site/data/3.13/arangodump.json +++ b/site/data/3.13/arangodump.json @@ -922,13 +922,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://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\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 `, 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 `, then any newly created log file tries\nto use `` 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://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\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 `, 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 `, then any newly created log file tries\nto use `` 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" @@ -1468,7 +1468,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, @@ -1509,7 +1509,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, diff --git a/site/data/3.13/arangoexport.json b/site/data/3.13/arangoexport.json index 3d6773af5f..45b6f8862d 100644 --- a/site/data/3.13/arangoexport.json +++ b/site/data/3.13/arangoexport.json @@ -729,13 +729,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://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\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 `, 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 `, then any newly created log file tries\nto use `` 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://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\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 `, 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 `, then any newly created log file tries\nto use `` 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" @@ -1197,7 +1197,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, @@ -1238,7 +1238,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, diff --git a/site/data/3.13/arangoimport.json b/site/data/3.13/arangoimport.json index 46bb5ed7cd..32555dea53 100644 --- a/site/data/3.13/arangoimport.json +++ b/site/data/3.13/arangoimport.json @@ -796,13 +796,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://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\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 `, 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 `, then any newly created log file tries\nto use `` 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://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\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 `, 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 `, then any newly created log file tries\nto use `` 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" @@ -1386,7 +1386,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, @@ -1427,7 +1427,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, diff --git a/site/data/3.13/arangoinspect.json b/site/data/3.13/arangoinspect.json index 3d4247bcef..91a47c7717 100644 --- a/site/data/3.13/arangoinspect.json +++ b/site/data/3.13/arangoinspect.json @@ -1222,13 +1222,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://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\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 `, 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 `, then any newly created log file tries\nto use `` 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://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\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 `, 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 `, then any newly created log file tries\nto use `` 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" @@ -1690,7 +1690,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, @@ -1731,7 +1731,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, diff --git a/site/data/3.13/arangorestore.json b/site/data/3.13/arangorestore.json index 733a848f6b..1ca756513f 100644 --- a/site/data/3.13/arangorestore.json +++ b/site/data/3.13/arangorestore.json @@ -900,13 +900,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://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\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 `, 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 `, then any newly created log file tries\nto use `` 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://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\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 `, 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 `, then any newly created log file tries\nto use `` 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" @@ -1451,7 +1451,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, @@ -1492,7 +1492,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, diff --git a/site/data/3.13/arangosh.json b/site/data/3.13/arangosh.json index 8b7f8377e8..bffafba747 100644 --- a/site/data/3.13/arangosh.json +++ b/site/data/3.13/arangosh.json @@ -1222,13 +1222,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://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\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 `, 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 `, then any newly created log file tries\nto use `` 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://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\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 `, 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 `, then any newly created log file tries\nto use `` 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" @@ -1710,7 +1710,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, @@ -1751,7 +1751,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, diff --git a/site/data/3.13/arangovpack.json b/site/data/3.13/arangovpack.json index 35df295f1a..09b5fd870a 100644 --- a/site/data/3.13/arangovpack.json +++ b/site/data/3.13/arangovpack.json @@ -500,13 +500,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://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\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 `, 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 `, then any newly created log file tries\nto use `` 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://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\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 `, 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 `, then any newly created log file tries\nto use `` 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"