Monitoring with the xscmd utility

With the xscmd utility, you can display textual information about the data grids that are running on your appliance.

Before you begin

  • See Administering with the xscmd utility for more information about starting the xscmd utility.

About this task

You can use the xscmd utility to view the current layout and specific state of the data grid, such as map content. In this example, the layout of the data grid in this task consists of a single ObjectGridA data grid with one MapA map that belongs to the MapSetA map set. This example demonstrates how you can display all active containers within a data grid and print out filtered metrics regarding the map size of the MapA map. To see all possible command options, run the xscmd utility without any arguments or with the -help option.

Procedure

Monitor the environment with the xscmd utility.
  • To enable statistics for all of the servers, run the following command:
    • [Unix] ./xscmd.sh -c setStatsSpec -spec ALL=enabled -g ObjectGridA
    • [Windows] xscmd.bat -c setStatsSpec -spec ALL=enabled -g ObjectGridA
  • To display all online container servers for a data grid, run the following command:
    • [Unix] ./xscmd.sh -c showPlacement -g ObjectGridA -ms MapSetA
    • [Windows] xscmd.bat -c showPlacement -g ObjectGridA -ms MapSetA

    All container information is displayed.

    Attention: To obtain this information when Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled, you must start the catalog and container servers with the JMX service port set. To set the JMX service port, you can either use the -JMXServicePort option on the startOgServer script or you can call the setJMXServicePort method on the ServerProperties interface.
  • To display information about the maps for the ObjectGridA data grid, run the following command:
    • [Unix] ./xscmd.sh -c showMapSizes -g ObjectGridA -ms MapSetA
    • [Windows] xscmd.bat -c showMapSizes -g ObjectGridA -ms MapSetA
  • To connect to the catalog service and display information about the MapA map for the entire catalog service domain, run the following command:
    • [Unix] ./xscmd.sh -c showMapSizes -g ObjectGridA -ms MapSetA -m MapA -cep CatalogMachine:6645
    • [Windows] xscmd.bat -c showMapSizes -g ObjectGridA -ms MapSetA -m MapA -cep CatalogMachine:6645
  • To display the configured and runtime placement of your configuration, run one of the following commands:
    • xscmd -c placementServiceStatus
    • xscmd -c placementServiceStatus -g ObjectGridA -ms MapSetA
    • xscmd -c placementServiceStatus -ms MapSetA
    • xscmd -c placementServiceStatus -g ObjectGridA
    You can scope the command to display placement information for the entire configuration, a single data grid, a single map set, or a combination of a data grid and map set.
Parent topic: Monitoring
Related tasks:
Configuring Transport Layer Security (TLS)