Command Line Interfaces for Retrieving Statistic and Event Data

The sstore list and sstore info commands show information about statistics and events. The sstore capture and sstore export commands record and display statistic values. The sstore info command shows metadata. The sstore export command shows data. See the sstore(1) man page for syntax and arguments.

Display identifiers

Use the sstore list command to list the currently available identifiers (SSIDs) that match the specified pattern. These SSIDs can then be used with other sstore subcommands.

You can specify a time to list identifiers that are not currently available but were available in the past. If you specify a time, then the output shows the time ranges when the identifier was available for capture. One use of time specification is to determine when resources were available on the system in the past.

Display metadata

Use the sstore info command to display metadata information about the specified identifier such as description and data type. As with the sstore list command, you can specify a time range to display metadata that was available in the past.

Record and display values

Use the sstore capture command to record and display the statistics and event information for the specified identifiers. Specify an interval and count to display values every interval seconds for count iterations. If you do not specify a count, values are displayed until you enter Ctrl-C or otherwise terminate the process. The default interval is one second. To specify a count, you must also specify an interval.

Values are displayed from now. Values continue to be recorded and stored in the statistics store for five minutes after the most recent request (sstore capture) for those values, even though the values might not be displayed. Use the sstore export command to retrieve those values.

Display values at a specified time

Use the sstore export command to display the statistic and event information for the specified identifiers from any time that information for those identifiers is available in the statistics store. If you do not specify a time range or a start time and a number of data points, all data in the statistics store for the given identifiers is displayed. Because system configuration changes, the identifiers for which you want information might not exist now. Use the sstore list command with a time range to find identifiers for resources that existed in the past, and then use sstore export with that same time range to retrieve the data for those resources.

The examples shown in the remainder of this section demonstrate these commands. Depending on your environment, you might need to escape some characters in an SSID, such as / or (.