backendstat
backendstat — gather OpenDJ backend debugging information
Options
The backendstat command takes the following options:
-V | --version-
Display Directory Server version information. Default: false
-H | --help-
Display this usage information. Default: false
Subcommands
The backendstat command supports the following subcommands:
backendstat dump-index
backendstat dump-index {options}
Dump records from an index, decoding keys and values. Depending on index size, this subcommand can generate lots of output.
Options
In addition to the global backendstat options, the backendstat dump-index subcommand takes the following options:
-b | --baseDn {baseDN}-
The base DN within the backend.
-i | --indexName {indexName}-
The name of the index.
-k | --minKeyValue {minKeyValue}-
Only show records with keys that should be ordered after the provided value using the comparator for the database container.
-K | --maxKeyValue {maxKeyValue}-
Only show records with keys that should be ordered before the provided value using the comparator for the database container.
-n | --backendId {backendName}-
The backend ID of the backend.
-p | --skipDecode-
Do not try to decode backend data to their appropriate types. Default: false
-q | --statsOnly-
Do not display backend data, just statistics. Default: false
-s | --minDataSize {minDataSize}-
Only show records whose data is no smaller than the provided value. Default: -1
-S | --maxDataSize {maxDataSize}-
Only show records whose data is no larger than the provided value. Default: -1
-x | --minHexKeyValue {minKeyValue}-
Only show records with keys that should be ordered after the provided value using the comparator for the database container.
-X | --maxHexKeyValue {maxKeyValue}-
Only show records with keys that should be ordered before the provided value using the comparator for the database container.
backendstat dump-raw-db
backendstat dump-raw-db {options}
Dump the raw records in hexadecimal format for a low-level database within the pluggable backend’s storage engine. Depending on index size, this subcommand can generate lots of output.
Options
In addition to the global backendstat options, the backendstat dump-raw-db subcommand takes the following options:
-d | --dbName {databaseName}-
The raw database name.
-k | --minKeyValue {minKeyValue}-
Only show records with keys that should be ordered after the provided value using the comparator for the database container.
-K | --maxKeyValue {maxKeyValue}-
Only show records with keys that should be ordered before the provided value using the comparator for the database container.
-l | --singleLine-
Write hexadecimal data on a single line instead of pretty format. Default: false
-n | --backendId {backendName}-
The backend ID of the backend.
-q | --statsOnly-
Do not display backend data, just statistics. Default: false
-s | --minDataSize {minDataSize}-
Only show records whose data is no smaller than the provided value. Default: -1
-S | --maxDataSize {maxDataSize}-
Only show records whose data is no larger than the provided value. Default: -1
-x | --minHexKeyValue {minKeyValue}-
Only show records with keys that should be ordered after the provided value using the comparator for the database container.
-X | --maxHexKeyValue {maxKeyValue}-
Only show records with keys that should be ordered before the provided value using the comparator for the database container.
backendstat list-indexes
backendstat list-indexes {options}
List the indexes associated with a pluggable backend. This subcommand may take a long time to complete depending on the size of the backend.
backendstat list-raw-dbs
backendstat list-raw-dbs {options}
List the low-level databases within a pluggable backend’s storage engine. This subcommand may take a long time to complete depending on the size of the backend.
backendstat show-index-status
backendstat show-index-status {options}
Shows the status of indexes for a backend base DN. This subcommand can take a long time to complete, as it reads all indexes for all backends.
When you run the show-index-status subcommand, the result is a table, followed by a "Total", which is the total number of indexes, followed by a list of indexes with "Over index-entry-limit keys" to show the values for which the number of entries exceeded the index entry limit.
The table has the following columns:
- (No label)
-
If the index needs rebuilding, its row starts with
!. Otherwise, its row starts with a space. - Index Name
-
Name of the index, where the format depends on the index. For example,
givenName.caseIgnoreSubstringsMatch:6:-
Attribute indexes: attr.type . type
-
Big indexes: attr.type .big. type
-
VLV indexes: vlv. type
-
- Secure
-
+means confidentiality is enabled for the index.-means confidentiality is disabled. - Size
-
The size on disk.
- Key Count
-
Number of indexed keys. Use the
backendstat dump-treecommand to see how many entry IDs correspond to each key. - Over
-
Number of keys for which there are too many values to maintain an index, based on the
index-entry-limit. This is recorded as-for VLV indexes. In other words, with the default index entry limit of 4000, if every user in your large directory has an email address ending in@example.com, and a substring index with default substring length of 6 is maintained formail, then the directory server does not maintain indexes for keys corresponding to substrings in@example.com. As a result, an LDAP search with the filter"(mail=*@example.com)"becomes an unindexed search even though a substring index exists for the mail attribute. By default, the directory server does not allow unindexed searches except by privileged users. This is usually exactly the behavior you want in order to prevent client applications from sending searches that return every user in the directory for example. Clients should refine their search filters instead. - Entry Limit
-
The
index-entry-limitsetting that applies to this index. Default:4000 - Mean
-
Average number of values per key for this index.
- Median
-
Median number of values per key for this index.
- 80th, 95th, 99th
-
Percentage of keys having at most the specified number of values. This is a measure of how full the entry ID lists are.