Arangoinspect Options
Usage: arangoinspect [<options>]
Global
Name | Type | Description |
---|
check-configuration | boolean | Check the configuration and exitThis is a command, no value needs to be specified. The process terminates after executing the command.Default: false |
config | string | The configuration file or ‘none’Default: "" |
configuration | string | The configuration file or ‘none’Default: "" |
default-language | string | Iso-639 language codeDefault: "" |
define | string… | Define key=value for a @key@ entry in config fileDefault: [] |
dump-dependencies | boolean | Dump dependency graphThis is a command, no value needs to be specified. The process terminates after executing the command.Default: false |
dump-options | boolean | Dump configuration options in json formatThis is a command, no value needs to be specified. The process terminates after executing the command.Default: true |
jslint | string… | Do not start as shell, run jslint insteadDefault: [] |
log | string… | The global or topic-specific log levelDefault: ["info"] Deprecated in: v3.5.0 |
quiet | boolean | Silent startupThis option can be specified without value to enable it.Default: false |
version | boolean | Reports the version and exitsThis is a command, no value needs to be specified. The process terminates after executing the command.Default: false |
Console
Name | Type | Description |
---|
console.audit-file | string | Audit log file to save commands and resultsDefault: "" |
console.auto-complete | boolean | Enable auto completionThis option can be specified without value to enable it.Default: true |
console.colors | boolean | Enable color supportThis option can be specified without value to enable it.Default: false |
console.history | boolean | Whether or not to load and persist command-line historyThis option can be specified without value to enable it.Default: true Introduced in: v3.4.5, v3.5.0 |
console.pager | boolean | Enable pagingThis option can be specified without value to enable it.Default: false |
console.pager-command | string | Pager commandDefault: "less -X -R -F -L" |
console.pretty-print | boolean | Enable pretty printingThis option can be specified without value to enable it.Default: true |
console.prompt | string | Prompt used in repl. prompt components are: ‘%t’: current time as timestamp, ‘%p’: duration of last command in seconds, ‘%d’: name of current database, ‘%e’: current endpoint, ‘%e’: current endpoint without protocol, ‘%u’: current userDefault: "%E@%d> " |
Encryption
Name | Type | Description |
---|
encryption.key-generator | string | _Enterprise Edition only_Program providing the encryption key on stdout. if set, encryption will be enabled.Default: "" |
encryption.keyfile | string | _Enterprise Edition only_File containing the encryption key. if set, encryption will be enabled.Default: "" |
Javascript
Name | Type | Description |
---|
javascript.allow-external-process-control | boolean | Allow execution and control of external processes from within javascript actionsThis option can be specified without value to enable it.Default: false Introduced in: v3.5.0 |
javascript.allow-port-testing | boolean | Allow testing of ports from within javascript actionsThis option can be specified without value to enable it.Default: false Introduced in: v3.5.0 |
javascript.check-syntax | string… | Syntax check code javascript code from fileDefault: [] |
javascript.client-module | string | Client module to use at startupDefault: "inspector.js" |
javascript.copy-directory | string | Target directory to copy files from ‘javascript.startup-directory’ into (only used when —javascript.copy-installation is enabled)Default: "" |
javascript.copy-installation | boolean | Copy contents of ‘javascript.startup-directory’This option can be specified without value to enable it.Default: false |
javascript.current-module-directory | boolean | Add current directory to module pathThis option can be specified without value to enable it.Default: true |
javascript.endpoints-blacklist | string… | Endpoints that cannot be connected to via @arangodb/request module in javascript actions if not whitelistedDefault: [] Introduced in: v3.5.0 |
javascript.endpoints-whitelist | string… | Endpoints that can be connected to via @arangodb/request module in javascript actionsDefault: [] Introduced in: v3.5.0 |
javascript.environment-variables-blacklist | string… | Environment variables that will be inaccessible in javascript if not whitelistedDefault: [] Introduced in: v3.5.0 |
javascript.environment-variables-whitelist | string… | Environment variables that will be accessible in javascriptDefault: [] Introduced in: v3.5.0 |
javascript.execute | string… | Execute javascript code from fileDefault: [] |
javascript.execute-string | string… | Execute javascript code from stringDefault: [] |
javascript.files-whitelist | string… | Filesystem paths that will be accessible from within javascript actionsDefault: [] Introduced in: v3.5.0 |
javascript.gc-interval | uint64 | Request-based garbage collection interval (each n.th command)Default: 50 |
javascript.harden | boolean | Disables access to javascript functions in the internal module: getpid() and loglevel()This option can be specified without value to enable it.Default: false Introduced in: v3.5.0 |
javascript.module-directory | string… | Additional paths containing javascript modulesDefault: [] |
javascript.startup-directory | string | Startup paths containing the javascript filesDefault: "./js" |
javascript.startup-options-blacklist | string… | Startup options whose names match this regular expression will not be exposed (if not whitelisted) to javascript actionsDefault: [] Introduced in: v3.5.0 |
javascript.startup-options-whitelist | string… | Startup options whose names match this regular expression will be whitelisted and exposed to javascriptDefault: [] Introduced in: v3.5.0 |
javascript.unit-test-filter | string | Filter testcases in suiteDefault: "" |
javascript.unit-tests | string… | Do not start as shell, run unit tests insteadDefault: [] |
javascript.v8-max-heap | uint64 | Maximal heap size (in mb)Default: 3072 |
javascript.v8-options | string… | Options to pass to v8Default: [] |
Log
Name | Type | Description |
---|
log.color | boolean | Use colors for tty loggingThis option can be specified without value to enable it.Default: true |
log.escape | boolean | Escape characters when loggingThis option can be specified without value to enable it.Default: true |
log.file | string | Shortcut for ‘—log.output file://'Default: "-" |
log.file-group | string | Group to use for new log file, user must be a member of this groupDefault: "" Introduced in: v3.4.5, v3.5.0 |
log.file-mode | string | Mode to use for new log file, umask will be applied as wellDefault: "" Introduced in: v3.4.5, v3.5.0 |
log.force-direct | boolean | Do not start a seperate thread for loggingThis option can be specified without value to enable it.Default: false |
log.foreground-tty | boolean | Also log to tty if backgroundedThis option can be specified without value to enable it.Default: false |
log.ids | boolean | Log unique message idsThis option can be specified without value to enable it.Default: true Introduced in: v3.5.0 |
log.keep-logrotate | boolean | Keep the old log file after receiving a sighupThis option can be specified without value to enable it.Default: false |
log.level | string… | The global or topic-specific log levelDefault: ["info"] |
log.line-number | boolean | Append line number and file nameThis option can be specified without value to enable it.Default: false |
log.output | string… | Log destination(s)Default: [] |
log.performance | boolean | Shortcut for ‘—log.level performance=trace’This option can be specified without value to enable it.Default: false Deprecated in: v3.5.0 |
log.prefix | string | Prefix log message with this stringDefault: "" |
log.request-parameters | boolean | Include full urls and http request parameters in trace logsThis option can be specified without value to enable it.Default: true |
log.role | boolean | Log server roleThis option can be specified without value to enable it.Default: false |
log.shorten-filenames | boolean | Shorten filenames in log output (use with —log.line-number)This option can be specified without value to enable it.Default: true |
log.thread | boolean | Show thread identifier in log messageThis option can be specified without value to enable it.Default: false |
log.thread-name | boolean | Show thread name in log messageThis option can be specified without value to enable it.Default: false |
log.time-format | string | Time format to use in logsDefault: "utc-datestring" Possible values: “local-datestring”, “timestamp”, “timestamp-micros”, “timestamp-millis”, “uptime”, “uptime-micros”, “uptime-millis”, “utc-datestring”, “utc-datestring-millis”Introduced in: v3.5.0 |
log.use-local-time | boolean | Use local timezone instead of utcThis option can be specified without value to enable it.Default: false Deprecated in: v3.5.0 |
log.use-microtime | boolean | Use microtime insteadThis option can be specified without value to enable it.Default: false Deprecated in: v3.5.0 |
Random
Name | Type | Description |
---|
random.generator | uint32 | Random number generator to use (1 = mersenne, 2 = random, 3 = urandom, 4 = combined (not for windows), 5 = wincrypt (windows only)Default: 1 Possible values: 1, 2, 3, 4 |
Server
Name | Type | Description |
---|
server.ask-jwt-secret | boolean | If this option is specified, the user will be prompted for a jwt secret. this option is not compatible with —server.username or —server.password. if specified, it will be used for all connections - even when a new connection to another server is createdThis option can be specified without value to enable it.Default: true |
server.authentication | boolean | Require authentication credentials when connecting (does not affect the server-side authentication settings)This option can be specified without value to enable it.Default: false |
server.connection-timeout | double | Connection timeout in secondsDefault: 5 |
server.database | string | Database name to use when connectingDefault: "_system" |
server.endpoint | string | Endpoint to connect to. use ‘none’ to start without a server. use http+ssl:// or vst+ssl:// as schema to connect to an ssl-secured server endpoint, otherwise http+tcp://, vst+tcp:// or unix://Default: "http+tcp://127.0.0.1:8529" |
server.jwt-secret-keyfile | string | If this option is specified, the jwt secret will be loaded from the given file. this option is not compatible with —server.ask-jwt-secret, —server.username or —server.password. if specified, it will be used for all connections - even when a new connection to another server is createdDefault: "" |
server.max-packet-size | uint64 | Maximum packet size (in bytes) for client/server communicationDefault: 1073741824 |
server.password | string | Password to use when connecting. if not specified and authentication is required, the user will be prompted for a passwordDefault: "" |
server.request-timeout | double | Request timeout in secondsDefault: 1200 |
server.username | string | Username to use when connectingDefault: "root" |
Ssl
Name | Type | Description |
---|
ssl.protocol | uint64 | Ssl protocol (1 = sslv2 (unsupported), 2 = sslv2 or sslv3 (negotiated), 3 = sslv3, 4 = tlsv1, 5 = tlsv1.2)Default: 5 Possible values: 1, 2, 3, 4, 5 |
Temp
Name | Type | Description |
---|
temp.path | string | Path for temporary filesDefault: "" |