Skip to content

Commit 7f1f494

Browse files
authored
Merge branch 'main' into DOC-790
2 parents cb48714 + d1ba2c3 commit 7f1f494

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+1580
-735
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
node_modules/
66
*.pyc
77
/.vs
8+
*.log
89

910
/site/data/*/api-docs.json
1011
/site/public/

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,18 @@ If it succeeds, then you can view the preview hosted on Netlify by following
2929
the link.
3030

3131
Note that the automatic previews run [plain builds](#plain-build), which means
32-
that [generated content](#generated-content) is not updated. The ArangoDB
32+
that [generated content](#generated-content) is not updated. The Arango
3333
documentation team takes of regenerating this content if necessary.
3434

3535
### Contributor License Agreement
3636

3737
To accept external contributions, we need you to fill out and sign our
38-
Contributor License Agreement (CLA). We use an Apache 2 CLA for ArangoDB,
39-
which can be found here: <https://www.arangodb.com/documents/cla.pdf>
40-
You can scan and email the CLA PDF file to <[email protected]> or send it via
38+
Contributor License Agreement (CLA):
39+
40+
- [Individual Contributor License Agreement](https://arango.ai/contributor-license)
41+
- [Corporate Contributor License Agreement](https://arango.ai/corporate-cla)
42+
43+
You can scan and email the CLA PDF file to <[email protected]> or send it via
4144
fax to +49-221-2722999-88.
4245

4346
## Build the documentation
@@ -276,7 +279,7 @@ requiring to manually apply changes to different versions as necessary.
276279
- `public/` - Default output directory for the generated site (not committed)
277280
- `resources/` - Holds the various cached resources that are generated by Hugo
278281
when using `hugo serve`
279-
- `themes/` - Folder for Hugo themes, containing the customized ArangoDB docs theme
282+
- `themes/` - Folder for Hugo themes, containing the customized Arango docs theme
280283
- `toolchain/` - Folder for the docs toolchain tools and scripts
281284
- `arangoproxy/` - Source code of the arangoproxy web server
282285
- `docker/` - The Docker container and compose files, with two sets of

site/data/3.11/arangod.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1400,7 +1400,7 @@
14001400
"agent",
14011401
"single"
14021402
],
1403-
"default" : 7735568384,
1403+
"default" : 7735569408,
14041404
"deprecatedIn" : null,
14051405
"description" : "The global size limit for all caches (in bytes).",
14061406
"dynamic" : true,
@@ -7575,15 +7575,15 @@
75757575
"type" : "boolean"
75767576
},
75777577
"query.global-memory-limit" : {
7578-
"base" : 33089757184,
7578+
"base" : 33089761280,
75797579
"category" : "option",
75807580
"component" : [
75817581
"coordinator",
75827582
"dbserver",
75837583
"agent",
75847584
"single"
75857585
],
7586-
"default" : 26802703319,
7586+
"default" : 26802706636,
75877587
"deprecatedIn" : null,
75887588
"description" : "The memory threshold for all AQL queries combined (in bytes, 0 = no limit).",
75897589
"dynamic" : true,
@@ -7873,15 +7873,15 @@
78737873
"type" : "double"
78747874
},
78757875
"query.memory-limit" : {
7876-
"base" : 33089757184,
7876+
"base" : 33089761280,
78777877
"category" : "option",
78787878
"component" : [
78797879
"coordinator",
78807880
"dbserver",
78817881
"agent",
78827882
"single"
78837883
],
7884-
"default" : 19853854311,
7884+
"default" : 19853856768,
78857885
"deprecatedIn" : null,
78867886
"description" : "The memory threshold per AQL query (in bytes, 0 = no limit).",
78877887
"dynamic" : true,
@@ -9116,7 +9116,7 @@
91169116
"agent",
91179117
"single"
91189118
],
9119-
"default" : 9282682060,
9119+
"default" : 9282683289,
91209120
"deprecatedIn" : null,
91219121
"description" : "The size of block cache (in bytes).",
91229122
"dynamic" : true,
@@ -11725,7 +11725,7 @@
1172511725
"agent",
1172611726
"single"
1172711727
],
11728-
"default" : 12376909414,
11728+
"default" : 12376911052,
1172911729
"deprecatedIn" : null,
1173011730
"description" : "The maximum total size of in-memory write buffers (0 = unbounded).",
1173111731
"dynamic" : true,

site/data/3.12/allMetrics.yaml

Lines changed: 105 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -386,7 +386,6 @@
386386
387387
- name: arangodb_api_recording_call_time
388388
type: histogram
389-
category: Statistics
390389
help: |
391390
API recording runtime histogram.
392391
description: |
@@ -397,7 +396,7 @@
397396
with 9 buckets.
398397
unit: nanoseconds
399398
introducedIn: "3.12.5"
400-
category: Agency
399+
category: Statistics
401400
complexity: high
402401
exposedBy:
403402
- agent
@@ -662,6 +661,26 @@
662661
Execution time histogram for all AQL queries, in seconds.
663662
The histogram includes all slow queries.
664663
664+
- name: arangodb_aql_recording_call_time
665+
type: histogram
666+
help: |
667+
AQL recording runtime histogram.
668+
description: |
669+
Execution time histogram for AQL recording calls in nanoseconds.
670+
671+
This histogram tracks the time it takes to record AQL calls in the ApiRecordingFeature.
672+
The histogram uses a logarithmic scale with base 2, starting at 0 and going up to 16000.0 nanoseconds,
673+
with 9 buckets.
674+
unit: nanoseconds
675+
introducedIn: "3.12.6"
676+
category: Statistics
677+
complexity: high
678+
exposedBy:
679+
- agent
680+
- coordinator
681+
- dbserver
682+
- single
683+
665684
- name: arangodb_aql_slow_query_time
666685
introducedIn: "3.6.10"
667686
help: |
@@ -6325,6 +6344,38 @@
63256344
It shows the block cache capacity in bytes. This can be configured with
63266345
the `--rocksdb.block-cache-size` startup option.
63276346
6347+
- name: rocksdb_block_cache_charge_per_entry
6348+
introducedIn: "3.12.6"
6349+
help: |
6350+
Average size of entries in RocksDB block cache.
6351+
unit: bytes
6352+
type: gauge
6353+
category: RocksDB
6354+
complexity: advanced
6355+
exposedBy:
6356+
- dbserver
6357+
- agent
6358+
- single
6359+
description: |
6360+
The metric shows the average size of cache entry value in the RocksDB
6361+
block cache.
6362+
6363+
- name: rocksdb_block_cache_entries
6364+
introducedIn: "3.12.6"
6365+
help: |
6366+
Number of entries in the RocksDB block cache.
6367+
unit: number
6368+
type: gauge
6369+
category: RocksDB
6370+
complexity: advanced
6371+
exposedBy:
6372+
- dbserver
6373+
- agent
6374+
- single
6375+
description: |
6376+
This metric shows the total number of entries present in the RocksDB block
6377+
cache.
6378+
63286379
- name: rocksdb_block_cache_pinned_usage
63296380
introducedIn: "3.6.1"
63306381
help: |
@@ -7132,6 +7183,41 @@
71327183
nasty delays in database operations are incurred. If in doubt,
71337184
contact ArangoDB support.
71347185
7186+
- name: rocksdb_live_blob_file_garbage_size
7187+
introducedIn: "3.12.6"
7188+
help: |
7189+
Size of garbage in live RocksDB .blob files.
7190+
unit: bytes
7191+
type: gauge
7192+
category: RocksDB
7193+
complexity: advanced
7194+
exposedBy:
7195+
- dbserver
7196+
- agent
7197+
- single
7198+
description: |
7199+
This metric exhibits the RocksDB metric `rocksdb-live-blob-file-garbage-size`.
7200+
It shows the total amount of garbage (obsolete, unreferenced blobs) in bytes
7201+
over in .blob files belonging to the latest LSM tree, summed over all
7202+
column families that use blob files.
7203+
7204+
- name: rocksdb_live_blob_file_size
7205+
introducedIn: "3.12.6"
7206+
help: |
7207+
Size of live RocksDB .blob files.
7208+
unit: bytes
7209+
type: gauge
7210+
category: RocksDB
7211+
complexity: advanced
7212+
exposedBy:
7213+
- dbserver
7214+
- agent
7215+
- single
7216+
description: |
7217+
This metric exhibits the RocksDB metric `rocksdb-live-blob-file-size`.
7218+
It shows the total size in bytes of all .blob files belonging to the latest
7219+
LSM tree, summed over all column families that use blob files.
7220+
71357221
- name: rocksdb_live_sst_files_size
71367222
introducedIn: "3.6.1"
71377223
help: |
@@ -7216,6 +7302,23 @@
72167302
This metric exhibits the RocksDB metric `rocksdb-min-log-number-to-keep`.
72177303
It shows the minimum log number of the log files that should be kept.
72187304
7305+
- name: rocksdb_num_blob_files
7306+
introducedIn: "3.12.6"
7307+
help: |
7308+
Number of live RocksDB .blob files.
7309+
unit: number
7310+
type: gauge
7311+
category: RocksDB
7312+
complexity: advanced
7313+
exposedBy:
7314+
- dbserver
7315+
- agent
7316+
- single
7317+
description: |
7318+
This metric exhibits the RocksDB metric `rocksdb-num-blob-files`.
7319+
It shows the total number of .blob files belonging to the latest
7320+
LSM tree, summed over all column families that use blob files.
7321+
72197322
- name: rocksdb_num_deletes_active_mem_table
72207323
introducedIn: "3.6.1"
72217324
help: |

site/data/3.12/arangobackup.json

Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -598,13 +598,13 @@
598598
"default" : [
599599
],
600600
"deprecatedIn" : null,
601-
"description" : "Log destination(s), e.g. file:///path/to/file (any occurrence of $PID is replaced with the process ID).",
601+
"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).",
602602
"dynamic" : false,
603603
"enterpriseOnly" : false,
604604
"experimental" : false,
605605
"hidden" : false,
606606
"introducedIn" : null,
607-
"longDescription" : "This option allows you to direct the global or\nper-topic log messages to different outputs. The output definition can be one\nof the following:\n\n- `-` for stdout\n- `+` for stderr\n- `syslog://<syslog-facility>`\n- `syslog://<syslog-facility>/<application-name>`\n- `file://<relative-or-absolute-path>`\n\nTo set up a per-topic output configuration, use\n`--log.output <topic>=<definition>`:\n\n`--log.output queries=file://queries.log`\n\nThe above example logs query-related messages to the file `queries.log`.\n\nYou can specify the option multiple times in order to configure the output\nfor different log topics:\n\n`--log.level queries=trace --log.output queries=file:///queries.log\n--log.level requests=info --log.output requests=file:///requests.log`\n\nThe above example logs all query-related messages to the file `queries.log`\nand HTTP requests with a level of `info` or higher to the file `requests.log`.\n\nAny occurrence of `$PID` in the log output value is replaced at runtime with\nthe actual process ID. This enables logging to process-specific files:\n\n`--log.output 'file://arangod.log.$PID'`\n\nNote that dollar sign may need extra escaping when specified on a\ncommand-line such as Bash.\n\nIf you specify `--log.file-mode <octalvalue>`, then any newly created log\nfile uses `octalvalue` as file mode. Please note that the `umask` value is\napplied as well.\n\nIf you specify `--log.file-group <name>`, then any newly created log file tries\nto use `<name>` as the group name. Note that you have to be a member of that\ngroup. Otherwise, the group ownership is not changed.\n\nThe old `--log.file` option is still available for convenience. It is a\nshortcut for the more general option `--log.output file://filename`.\n\nThe old `--log.requests-file` option is still available. It is a shortcut for\nthe more general option `--log.output requests=file://...`.\n\nTo change the log levels for the specified output you can add a comma separated\nlist of topics with their respective level after the output definition, separated\nby a semicolon:\n`--log.output file:///path/to/file;queries=trace,requests=info`\n`--log.output -;all=error`",
607+
"longDescription" : "This option allows you to direct the global or\nper-topic log messages to different outputs. The output definition can be one\nof the following:\n\n- `-` for stdout\n- `+` for stderr\n- `syslog://<syslog-facility>`\n- `syslog://<syslog-facility>/<application-name>`\n- `file://<relative-or-absolute-path>`\n\nTo set up a per-topic output configuration, use\n`--log.output <topic>=<definition>`:\n\n`--log.output queries=file://queries.log`\n\nThe above example logs query-related messages to the file `queries.log`.\n\nYou can specify the option multiple times in order to configure the output\nfor different log topics:\n\n`--log.level queries=trace --log.output queries=file:///queries.log\n--log.level requests=info --log.output requests=file:///requests.log`\n\nThe above example logs all query-related messages to the file `queries.log`\nand HTTP requests with a level of `info` or higher to the file `requests.log`.\n\nFor file-based logging, the folders of the destination path need to exist\nalready. They are not created implicitly.\n\nAny occurrence of `$PID` and `@PID` in the log output value is replaced at\nruntime with the actual process ID. This enables logging to process-specific\nfiles:\n\n`--log.output 'file://arangod.log.$PID'`\n\nNote that the dollar sign may need extra escaping when specified on a\ncommand-line such as Bash. You can typically wrap the entire value in single\nquote marks to prevent variable substitution.\n\nAny occurrence of `@TEMP_BASE_DIR@` in the log output value is replaced at\nruntime with the current temporary directory, e.g. `/tmp/arangodb_i37Xxh`\n(automatically created on startup with a randomly generated suffix).\n\nKeep in mind that `@NAME@` is also the syntax for using the value of an\nenvironment variable `NAME`. If there is an environment variable called `PID` or\n`TEMP_BASE_DIR`, then `@PID@` or `@TEMP_BASE_DIR@` is substituted with the\nvalue of the respective environment variable.\n\nIf you specify `--log.file-mode <octalvalue>`, then any newly created log\nfile uses `octalvalue` as file mode. Please note that the `umask` value is\napplied as well.\n\nIf you specify `--log.file-group <name>`, then any newly created log file tries\nto use `<name>` as the group name. Note that you have to be a member of that\ngroup. Otherwise, the group ownership is not changed.\n\nThe old `--log.file` option is still available for convenience. It is a\nshortcut for the more general option `--log.output file://filename`.\n\nThe old `--log.requests-file` option is still available. It is a shortcut for\nthe more general option `--log.output requests=file://...`.\n\nTo change the log levels for the specified output you can add a comma separated\nlist of topics with their respective level after the output definition, separated\nby a semicolon:\n`--log.output file:///path/to/file;queries=trace,requests=info`\n`--log.output -;all=error`",
608608
"obsolete" : false,
609609
"os" : [
610610
"linux"
@@ -1006,7 +1006,7 @@
10061006
},
10071007
"server.authentication" : {
10081008
"category" : "option",
1009-
"default" : true,
1009+
"default" : false,
10101010
"deprecatedIn" : null,
10111011
"description" : "Require authentication credentials when connecting (does not affect the server-side authentication settings).",
10121012
"dynamic" : false,
@@ -1067,7 +1067,7 @@
10671067
"server.endpoint" : {
10681068
"category" : "option",
10691069
"default" : [
1070-
"tcp://127.0.0.1:8529"
1070+
"http+tcp://127.0.0.1:8529"
10711071
],
10721072
"deprecatedIn" : null,
10731073
"description" : "The endpoint to connect to. Use 'none' to start without a server. Use http+ssl:// as schema to connect to an SSL-secured server endpoint, otherwise http+tcp:// or unix://",
@@ -1084,6 +1084,29 @@
10841084
"section" : "server",
10851085
"type" : "string..."
10861086
},
1087+
"server.jwt-renewal-threshold" : {
1088+
"base" : 1,
1089+
"category" : "option",
1090+
"default" : 300,
1091+
"deprecatedIn" : null,
1092+
"description" : "The time (in seconds) before JWT token expiry to trigger automatic renewal. Default is 300 seconds (5 minutes).",
1093+
"dynamic" : false,
1094+
"enterpriseOnly" : false,
1095+
"experimental" : false,
1096+
"hidden" : true,
1097+
"introducedIn" : null,
1098+
"maxInclusive" : true,
1099+
"maxValue" : 1.7976931348623157e+308,
1100+
"minInclusive" : true,
1101+
"minValue" : 2.2250738585072014e-308,
1102+
"obsolete" : false,
1103+
"os" : [
1104+
"linux"
1105+
],
1106+
"requiresValue" : true,
1107+
"section" : "server",
1108+
"type" : "double"
1109+
},
10871110
"server.max-packet-size" : {
10881111
"base" : 1,
10891112
"category" : "option",
@@ -1111,7 +1134,7 @@
11111134
"category" : "option",
11121135
"default" : "",
11131136
"deprecatedIn" : null,
1114-
"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 @@.",
1137+
"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 @@.",
11151138
"dynamic" : false,
11161139
"enterpriseOnly" : false,
11171140
"experimental" : false,
@@ -1152,7 +1175,7 @@
11521175
"category" : "option",
11531176
"default" : "root",
11541177
"deprecatedIn" : null,
1155-
"description" : "The username to use when connecting.",
1178+
"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.",
11561179
"dynamic" : false,
11571180
"enterpriseOnly" : false,
11581181
"experimental" : false,

0 commit comments

Comments
 (0)