Monitoring a Data Gate on Cloud instance

The dashboard is displayed after the creation of an instance has finished. You can also access the dashboard from the OpenShift® main menu. The dashboard gives you various pieces of information about your Data Gate on Cloud instance, such as the system availability, the table status, the replication latency, and throughput. The dashboard also allows you to add, load, and remove tables or to enable or disable synchronization. The dashboard is refreshed every minute.

Procedure

  • Open the Data Gate on Cloud instance UI (as described in chapter xx)
    Draft comment: kuester@de.ibm.com
    Resolve the reference "as described in chapter xx"
    You see the dashboard of your instance.

Overview tab:

  • Viewing the status of the instance on the Instance: <name> tile:
    The tile contains the following blocks of information:
    Instance name
    The instance name functions as the header of the information box.
    Target
    Under the Data Gate on Cloud instance name, you find the instance name of the selected target database (Db2® or Db2 Warehouse on Cloud)
    Source
    Under the target instance name, you find the Db2 location name followed by the @-sign, the hostname or IP address of the connected data source (Db2 for z/OS® subsystem or data sharing group), and the network port that is used to connect to the source.
    Data Gate on Cloud server
    The readiness and availability of your instance. If it is in working order, you see a green check mark followed by Data Gate server active.
    Synchronization
    The state of the synchronization function. If it is in working order, you see a green check mark followed by the message Synchronization started. You can click the toggle button on the right to start or stop synchronization for your instance.
  • Viewing the status of tables or queries on the Table tile:
    The Table tile contains the following information:

    The pie chart on the left of the tile shows the distribution of table statuses among the tables that were added to the Data Gate on Cloud instance. The bigger a colored segment, the greater is the number of tables in the state that is indicated by the color.

    A text box on the right of the tile starts with the total number of tables managed by the Data Gate on Cloud instance. What follows is the legend of the color scheme used in the pie chart. Next to each colored bullet, you find the number of tables in that particular state:

    Green: Active
    The number of tables that are loaded and take part in the synchronization process.
    Purple: Loaded
    The number of tables that are fully loaded, but do not take part in the synchronization process.
    Blue: Loading
    The number of tables that are currently being loaded.
    Yellow: Load pending
    The number of tables that still need to be loaded.
    Magenta: Error
    The number of tables in Error state.

Monitor tab:

  • The graphs on the Monitor tab show the synchronization latency, synchronization throughput, and a few statistics regarding the source data and the logs. The graphs are synchronized, meaning that they all cover the same time frame on the x-axis. If you click a point on the x-axis of a graph, the selected point in time is displayed under Time range on the right side of the tab window. Underneath, you see the selected value and the corresponding values in the other graphs.

    Using the slider buttons on the left and right sides of the bar at the bottom (under the last graph), you can narrow the focus (time frame) of the display. The left slider button changes the beginning of the time frame on the display. The right slider button changes the end of the time frame. Shorter time intervals allow you to scrutinize individual values more closely. Wider time intervals offer a broader perspective.

  • You can change the time frame that is covered by the graphs on the Monitor tab. The labels on the buttons indicate how far the data that is taken into account reaches back into the past.
    • 1 hour
    • 6 hours
    • 12 hours
    • 24 hours
    • 3 days
    • Custom. This button allows you to specify a time frame of your choice.
  • Export button:
    The Export button allows you to save the collected monitoring data to a file in comma-separated variable (csv) format. You can import this file into other tools, such as a spreadsheet, for reporting purposes or further analysis. The name of the export file downloaded to your local machine is monitor_data_<start_time>_to_<end_time>.csv, where <start_time> and <end_time> denote the beginning and the end of the time frame covered by the export file. The start time and end time of the file match the time frame that you selected on the Monitor tab (see previous bullet).
  • Viewing the synchronization latency:
    The Synchronization latency graph illustrates the development of the synchronization latency over time. At any given moment in time, the replication latency tells you how long it takes to bring your Data Gate on Cloud tables into a state that matches the state of the original Db2 for z/OS tables, that is, a state in which no more updates are necessary. In other words, it is the time that your Data Gate on Cloud tables are lagging behind with regard to synchronization. Ideally, this should only be a few seconds.
  • Viewing the synchronization throughput:
    The Synchronization throughput graph can be seen as a performance curve of the synchronization function. It shows how many updated table rows per second where propagated to your Data Gate on Cloud tables.
  • Viewing source data and log statistics:
    The Source data graph tells you how many operations of a certain type were carried out on the source database during the synchronization process, how many compensated rows exist, and how many log records were written by Db2 for z/OS utilities. By default, compensated rows and log records are deselected, but you can click the corresponding entries on the legend to enable these. The statistics in detail:
    Source inserted rows
    A curve that shows the number of synchronized table rows that were inserted into the source database.
    Source updated rows
    A curve that shows the number of synchronized table rows that were updated in the source database.
    Source deleted rows
    A curve that shows the number of synchronized table rows that were deleted from the source database.
    Source compensated rows
    A curve that shows the number of synchronized table rows (INSERTs, UPDATEs, DELETEs) in the source database that were ignored because the operations were not committed, but rolled back.
    Utility logs
    A curve that shows the number of log records that were generated by Db2 for z/OS utilities.
  • Viewing target data statistics
    The Target data graph shows you the number of operations of a certain type that were carried out on the target database during the synchronization process, and the number of net-effect operations. By default, net-effect operations are deselected, but you can click the corresponding entry on the legend to enable these. The statistics in detail:
    Target inserted rows
    A curve that shows the number of synchronized table rows that were inserted into the target database.
    Target deleted rows
    A curve that shows the number of synchronized table rows that were deleted from the target database.
    Net-effect operations
    A curve that shows the number of net-effect operations on the target database. This is the number of unnecessary operations that the database engine skips to optimize the performance.

Table tab:

  • Viewing the tables of the instance:
    The Table tab gives you detailed information about the tables you selected for the instance:
    Table Schema Table size Sync
    Table name Name of the schema a table belongs to Table size in MB, GB, or TB Whether synchronization is enabled or disabled for a table
    Sync started Status Acceleration
    Timestamp showing when the synchronization process was started for a table The status of a table (for a legend, see the Tables section in the instance status box above) Whether the query acceleration feature is enabled or disabled for a table
  • Searching for particular schemas or tables:
    To display just the schemas and tables whose names contain a particular search string, type a search string in the Find field.
  • Setting a filter:
    To display just the tables in a particular state or to limit the number of tables in the list, click Filter icon

    Click Apply filters when finished. To remove the filter, click the icon again and click Reset filters

  • Downloading the tables list:
    To download the tables list in csv format, click Download icon.
  • Refreshing the tables list:
    To refresh the information in the tables list, click Refresh icon.
  • Adding tables:
    To add tables to the instance, click the Add table button on the header of the tables list. For more information, see Adding tables to Data Gate on Cloud.
  • Enabling or disabling synchronization:
    To enable or disable table synchronization, select one or more tables (check boxes in front of table names) and click one of the following on the header of the tables list:
    • Enable
    • Disable
    For more information, see Enabling or disabling synchronization for Data Gate on Cloud.
  • Loading tables:
    To load tables, select one or more tables (check boxes in front of table names) and click the Load button on the header of the tables list. For more information, see Loading tables in Data Gate on Cloud.
  • Removing tables:
    To remove tables from the instance, select one or more tables (check boxes in front of table names) and click the Delete button on the header of the tables list. For more information, see Removing tables from Data Gate on Cloud.
  • Reducing or increasing the number of items per page:
    To reduce or increase the number of table rows displayed per page, click Items per page. You can select between 8 (default), 20, or 50 table rows per page.
  • Selecting a start page:
    To select a particular start page for the tables list, click the drop-down icon next to the page number at the bottom of the tables list and select a different page number from the selection list that opens. For example, to show page 100 as the start page of the tables list, click the drop-down icon and select 100.
  • Navigating between the pages of the tables list:
    To change back and forth between the previous or next page of the tables list, click the < or > button at the bottom of the list.

The Event tab:

The Event tab lists synchronization event messages. The tab lists recent messages and offers filters that you can use to narrow the number of messages on the display.

  • Viewing synchronization event messages:
    The table on the Event tab lists the available messages.
    Severity Message Event ID Originator Time
    The severity classification of a message, that is, one of the following:
    • Information
    • Warning
    • Error
    		 The message number and the message text. A number used for the classification of an event. The name of the program component that caused an event. A timestamp that shows when an event occurred.

    For a complete list and descriptions of all messages that might be displayed, see:

    DSNX881I Messages (ID 20) Returned by IBM Integrated Synchronization

    The synchronization function of Data Gate on Cloud returns exactly the same messages.

  • You can change the time frame that is covered by the events table. The labels on the buttons indicate how far the data that is taken into account reaches back into the past.
    • 1 hour
    • 24 hours
    • 7 days
    • 30 days
    • Custom. This button allows you to specify a time frame of your choice.
  • You can filter the synchronization messages by their severity. From the Event severity drop-down list, select one or more severity classifications:
    • Information
    • Warning
    • Error

    Selecting one or more of these classification types lists the messages classified in that way. If, for example, you select Warning, you will see warning messages only.

  • You can export and download the list of messages on display in comma-separated value (csv) format. To this end, click Button to download export the list in csv format and specify a file location on your local computer.