Core DB: Appendix B: Index Inspect

Document created by RSA Information Design and Development on Nov 23, 2016
Version 1Show Document
  • View in full screen mode
  

The Security Analytics Core database index has a built-in debugging feature called inspect that provides detailed information about the composition of its indexes. The index inspect feature is located at /index/inspect in every Core service configuration tree. Services that do not actually have an index, like Broker, do not have the /index/inspect feature.  

Parameters

Options

Type: String
This parameter may be set to the value all-slices to collect inspect information about every slice in the index. If it is not set, information on the current, most recently created slice is returned.

Caution: Collecting information on all slices may take a very long time to complete if there are many index slices.

Response

Inspect returns many rows of key value pairs that represent the state of the index.

Slice Summary

The first row returned for every slice is a summary with the following values.

                   
session1The first session ID indexed in the slice
session2The last session ID indexed in the slice
meta1The first meta ID in the first session indexed in the slice
meta2The last meta ID in the last session indexed in the slice

Per-Index Summary

There will be per-index summary rows returned for each index. Only value-level indexes are reported.

                                                   
keyThe meta key name for the index
pathnameThe path on disk to this index
valuesThe number of unique values stored in this index
summariesThe number of summary entries occupied by this index in the summary.db file
pagesThe number of page entries occupied by this index in the page.db file
sessionsThe number of sessions that had a value that was inserted into this index
sizeThe cumulative "size" meta values for all sessions that inserted a value into this index
packetsThe cumulative count of packets for all sessions that inserted a value into this index
summary1The first summary ID used by this index
summary2The last summary ID used by this index
session1The first session ID referenced by this index
session2The last session ID referenced by this index

Slice Summary Footer

The last row in each inspect report contains cumulative statistics for all the indexes in the slice.

               
totalKeysThe number of indexed meta types
totalValuesThe number of unique values tracked by all indices in this slice
totalMemoryAn approximate total of the memory needed to open this index slice
Previous Topic:Appendix A: Statistics
You are here
Table of Contents > Appendix B: Index Inspect

Attachments

    Outcomes