|
5 | 5 | //Check Mark |
6 | 6 | :check-mark: icon:check[] |
7 | 7 |
|
8 | | -You can use the `neo4j-admin server report` command to collect information about a Neo4j installation and save it to an archive. |
| 8 | +The `neo4j-admin server report` command collects information about the Neo4j deployment and saves it to an archive (ZIP/TAR) for remote assessments. |
9 | 9 |
|
10 | 10 | == Syntax |
11 | 11 |
|
12 | 12 | The `neo4j-admin server report` command has the following syntax: |
13 | 13 |
|
| 14 | +[source,role=noheader] |
14 | 15 | ---- |
15 | 16 | neo4j-admin server report [-h] |
16 | | - [--expand-commands] |
17 | | - [--list] |
18 | | - [--verbose] |
| 17 | + [--expand-commands] [--list] [--verbose] |
19 | 18 | [--ignore-disk-space-check[=true|false]] |
20 | | - [--additional-config=<file>] |
21 | | - [--to-path=<path>] |
22 | | - [<classifier>...] |
| 19 | + [--additional-config=<file>] [--to-path=<path>] |
| 20 | + [<classifier>...] [COMMAND] |
23 | 21 | ---- |
24 | 22 |
|
25 | | -The intended usage of the report tool is to simplify the support process by collecting the relevant information in a standard way. |
| 23 | +=== Description |
| 24 | + |
| 25 | +The command collects information about the system and packages everything in an archive. |
| 26 | +If you specify `all`, everything is included. |
| 27 | +You can also finetune the selection by passing classifiers to the tool, e.g `logs tx threads`. |
| 28 | + |
26 | 29 | This tool does not send any information automatically. |
27 | 30 | To share this information with the Neo4j Support organization, you have to send it manually. |
28 | 31 |
|
29 | | -== Options and classifiers |
30 | | - |
31 | | -The `neo4j-admin server report` command has the following options and classifiers: |
| 32 | +=== Parameters |
32 | 33 |
|
33 | | -.Options |
34 | | -[options="header", cols="<2m,^1a,<4a"] |
| 34 | +.`neo4j-admin server report` parameters |
| 35 | +[options="header", cols="1m,3m"] |
35 | 36 | |=== |
36 | | -| Option |
37 | | -| Possible values |
38 | | -| Description |
39 | | - |
40 | | -| -h, --help |
41 | | -| |
42 | | -| Show this help message and exit. |
43 | | - |
44 | | -| `--expand-commands` |
45 | | -| |
46 | | -| Allow command expansion in config value evaluation. |
47 | | - |
48 | | -| --list |
49 | | -| |
50 | | -| List all available classifiers. |
51 | | - |
52 | | -| --verbose |
53 | | -| |
54 | | -| Enable verbose output. |
| 37 | +| Parameter |
| 38 | +| Default |
55 | 39 |
|
56 | | -| --ignore-disk-space-check |
57 | | -| `true` or `false` (Default: `false`) |
58 | | -| Ignore disk full warning. |
59 | | - |
60 | | -| --to-path |
61 | | -| `<path>` (Default: _/tmp_) |
62 | | -| Destination directory for reports. |
| 40 | +|[<classifier>...] |
| 41 | +|[config, logs, metrics, plugins, ps, sysprop, threads, tree, version] |
63 | 42 | |=== |
64 | 43 |
|
65 | | -By default, the tool tries to estimate the final size of the report and uses that to assert that there is enough disk space available for it. |
66 | | -If there is not enough available space, the tool aborts. |
67 | | -However, this estimation is pessimistic and does not consider the compression. |
68 | | -Therefore, if you are confident that you do have enough disk space, you can disable this check with the option `--ignore-disk-space-check`. |
69 | | - |
70 | 44 | [[classifiers]] |
71 | 45 | .Classifiers |
72 | 46 | [options="header", cols="<1m,^1a,<4a"] |
@@ -137,6 +111,52 @@ However, the heap, the raft logs, and the transaction logs may contain data. |
137 | 111 | Additionally, even though the standard _neo4j.conf_ file does not contain password information, for specific configurations, it may have this type of information. |
138 | 112 | Therefore, be aware of your organization's data security rules before using the classifiers `heap`, `tx`, `raft`, and `config`. |
139 | 113 |
|
| 114 | +=== Options |
| 115 | + |
| 116 | +The `neo4j-admin server report` command has the following options: |
| 117 | + |
| 118 | +.`neo4j-admin server report` options |
| 119 | +[options="header", cols="5m,6a,2m"] |
| 120 | +|=== |
| 121 | +| Option |
| 122 | +| Description |
| 123 | +| Default |
| 124 | + |
| 125 | +|--additional-config=<file> |
| 126 | +|Configuration file with additional configuration. |
| 127 | +| |
| 128 | + |
| 129 | +|--expand-commands |
| 130 | +|Allow command expansion in config value evaluation. |
| 131 | +| |
| 132 | + |
| 133 | +|-h, --help |
| 134 | +|Show this help message and exit. |
| 135 | +| |
| 136 | + |
| 137 | +|--ignore-disk-space-check[=true\|false] |
| 138 | +|Ignore disk full warning. |
| 139 | +|false |
| 140 | + |
| 141 | + |
| 142 | +|--list |
| 143 | +|List all available classifiers. |
| 144 | +| |
| 145 | + |
| 146 | +|--to-path=<path> |
| 147 | +|Destination directory for reports. Defaults to a system tmp directory. |
| 148 | +| |
| 149 | + |
| 150 | +|--verbose |
| 151 | +|Enable verbose output. |
| 152 | +| |
| 153 | +|=== |
| 154 | + |
| 155 | +By default, the tool tries to estimate the final size of the report and uses that to assert that there is enough disk space available for it. |
| 156 | +If there is not enough available space, the tool aborts. |
| 157 | +However, this estimation is pessimistic and does not consider compression. |
| 158 | +Therefore, if you are confident that you do have enough disk space, you can disable this check with the option `--ignore-disk-space-check`. |
| 159 | + |
140 | 160 | == Examples |
141 | 161 |
|
142 | 162 | [NOTE] |
|
0 commit comments