< Previous

Getting started tutorial lesson 4: Monitor your environment

You can use the xscmd utility and web console tools to monitor your data grid environment.

Monitoring with the web console

With the web console, you can chart current and historical statistics. This console provides some preconfigured charts for high-level overviews, and has a custom reports page that you can use to build charts from the available statistics. You can use the charting capabilities in the monitoring console of WebSphere eXtreme Scale to view the overall performance of the data grids in your environment.

Install the web console as an optional feature when you run the installation wizard.
  1. Start the console server. The startConsoleServer.bat|sh script for starting the console server is in the wxs_install_root/ObjectGrid/bin directory of your installation.
  2. Log on to the console.
    1. From your web browser, go to https://your.console.host:7443, replacing your.console.host with the host name of the server onto which you installed the console.
    2. Log on to the console.
      • User ID: admin
      • Password: admin
      The console welcome page is displayed.
  3. Edit the console configuration. Click Settings > Configuration to review the console configuration. The console configuration includes information such as:
    • Trace string for the WebSphere eXtreme Scale client, such as *=all=disabled
    • The Administrator name and password
    • The Administrator e-mail address
  4. Establish and maintain connections to catalog servers that you want to monitor. Repeat the following steps to add each catalog server to the configuration.
    1. Click Settings > eXtreme Scale Catalog Servers.
    2. Add a new catalog server.
      1. Click the add icon (plus sign) to register an existing catalog server.
      2. Provide information, such as the host name and listener port. See Planning for network ports for more information about port configuration and defaults.
      3. Click OK.
      4. Verify that the catalog server has been added to the navigation tree.
  5. Group the catalog servers that you created into a catalog service domain. You must create a catalog service domain when security is enabled in your catalog servers because security settings are configured in the catalog service domain.
    1. Click Settings > eXtreme Scale Domains page.
    2. Add a new catalog service domain.
      1. Click the add icon (plus sign) to register a catalog service domain. Enter a name for the catalog service domain.
      2. After you create the catalog service domain, you can edit the properties. The catalog service domain properties follow:
        Name
        Indicates the host name of the domain, as assigned by the administrator.
        Catalog servers
        Lists one or more catalog servers that belong to the selected domain. You can add the catalog servers that you created in the previous step.
        Generator class
        Specifies the name of the class that implements the CredentialGenerator interface. This class is used to get credentials for clients. If you specify a value in this field, the value overrides the crendentialGeneratorClass property in the client.properties file.
        Generator properties
        Specifies the properties for the CredentialGenerator implementation class. The properties are set to the object with the setProperties(String) method. The credentialGeneratorprops value is used only if the value of the credentialGeneratorClass property is not null. If you specify a value in this field, the value overrides the credentialGeneratorProps property in the client.properties file.
        eXtreme Scale client properties path
        Specifies the path to the client properties file that you edited to include security properties in a previous step. For example, you might indicate the c:\ObjectGridProperties\sampleclient.properties file. If you want to stop the console from trying to use secure connections, you can delete the value in this field. After you set the path, the console uses an unsecured connection.
      3. Click OK.
      4. Verify that the domain has been added to the navigation tree.
    To view information about an existing catalog service domain, click the name of the catalog service domain in the navigation tree on the Settings > eXtreme Scale Domains page.
  6. View the connection status. The Current domain field indicates the name of the catalog service domain that is currently being used to display information in the web console. The connection status displays next to the name of the catalog service domain.
  7. View statistics for the data grids and servers, or create a custom report.

Monitoring with the xscmd utility

  1. Optional: If client authentication is enabled: Open a command-line window. On the command line, set appropriate environment variables.
  2. Go to the wxs_home/bin directory.

    cd wxs_home/bin

  3. Run various commands to display information about your environment.
    • Show all the online container servers for the Grid data grid and the mapSet map set:
      xscmd -c showPlacement -g Grid -ms mapSet
    • Display the routing information for the data grid.
      xscmd -c routetable -g Grid
    • Display the number of map entries in the data grid.
      xscmd -c showMapSizes -g Grid -ms mapSet

Stopping the servers

After you are done using the client application and monitoring the getting started sample environment, you can stop the servers.

Lesson checkpoint

In this lesson, you learned:
  • How to start the web console and connect it to the catalog server.
  • How to monitor data grid and server statistics.
  • How to stop the servers.
< Previous