IBM Db2 Event Store utilities setup and usage

Before you begin

• Verify that Db2 Event Store is completely installed and running.
• The eventstore-tools container must be in a running state.

Procedure

1. Setup the environment variables.
   Note: If you are in a Red Hat OpenShift 4.X (RHOS 4.X) environment, you will need to be logged in to your OpenShift account on the infrastructure node of the cluster before you can run any of the commands.
   1. The environment variables need to be declared for the eventstore-tools pod.
   2. Declare a function that will run as a macro where commands can be passed to the tools container.
   3. Select the deployment that applies to you and run the following commands in command line:
      • Standalone/IBM Watson™ Studio deployment:

        TOOLS_CONTAINER=$(kubectl get pods -n dsx | grep eventstore-tenant-tools | awk {'print $1'}) && ORIGIN_IP=`hostname -i | awk '{print $1}'` 
        eventstoreUtils() { kubectl -n dsx exec -it "${TOOLS_CONTAINER}" -- bash -c 'export ORIGIN_IP="${1}" && eventstore-utils "${@:2}"' bash "${ORIGIN_IP}" "${@}"; }

      • IBM Cloud Pak for Data deployment:
        • For this deployment, refer to Identifying the deployment ID of Db2 Event Store in a IBM Cloud Pak for Data deployment first to find the DEPLOYMENT_ID before running the following commands. Also note that you must be logged on to RedHat OpenShift through oc login and select the current project of the desired deployment through oc project.
        • The NAMESPACE is the Kubernetes namespace that the deployment belongs to.

        DEPLOYMENT_ID="<Enter deployment ID here>"
        TOOLS_CONTAINER=$(oc get pods |grep $DEPLOYMENT_ID | grep -E "(eventstore)(.*)(tenant-tools)" | awk {'print $1'}) && ORIGIN_IP=`hostname -i | awk '{print $1}'`
        eventstoreUtils() { oc -it exec "${TOOLS_CONTAINER}" -- bash -c 'export ORIGIN_IP="${1}" && eventstore-utils "${@:2}"' bash "${ORIGIN_IP}" "${@}"; }

2. Run the Db2 Event Store utilities.
   After subset up the environment variables, you now have access to different Db2 Event Store tooling. You can test if everything has been set up correctly by running the following command:

   eventstoreUtils --help

   When running the command, you should see the following response:

   Usage: /usr/bin/eventstore-utils [OPTIONS] [arg]
   OPTIONS:
   =======
           --tool         The db2 tool you wish to run within the specified target. Ex stop, start, db2set, db2, db2pd. Default: db2
           --command      The command you wish to run for the tool you provided. Surround in quotations For example "list database directory" for the tool db2.
           --connect      Pass this option to run a 'db2 connect to db' before the provided command.
           --interactive  Pass this option to run in interactive mode. 
           --help         print usage
   
   TARGET:
   =======
           --all-engines  Pass this option to run the provided command on all eventstore engine pods.
           --catalog      Pass this option to run the provided command only on the eventstore catalog.
           --member <N>   Pass this option to run the provided command only on the eventstore member number provided.

   If you do not see the previous message, refer back to the beginning of the setup.

3. Run the Db2 Event Store tooling.

   With the Db2 Event Store utilities macro set up, you can now access the Db2 Event Store tooling.

   This tooling can be run in the following format:

   eventstoreUtils <command> [options] [<subcommand>] [options]

IBM Db2 Event Store utilities commands and tools

eventstoreUtils --tool <TOOL_NAME> [-command "<commands>"]

Additional options

$ eventstoreUtils [--<additional_options>] [--<command> <options> [--<subcommand>] ["options"]]

• --connect

  Runs db2 connect to db before the provided command.

• --help

  Prints the usage of the command or tool.

• --interactive
  Runs the interactive mode, for example:

  # eventstoreUtils --tool db2 --interactive
  (c) Copyright IBM Corporation 1993,2007
  Command Line Processor for DB2 Client 11.1.9.0
  
  You can issue database manager commands and SQL statements from the command
  prompt. For example:
      db2 => connect to sample
      db2 => bind sample.bnd
  
  For general help, type: ?.
  For command help, type: ? command, where command can be
  the first few keywords of a database manager command. For example:
   ? CATALOG DATABASE for help on the CATALOG DATABASE command
   ? CATALOG          for help on all of the CATALOG commands.
  
  To exit db2 interactive mode, type QUIT at the command prompt. Outside
  interactive mode, all commands must be prefixed with 'db2'.
  To list the current command option settings, type LIST COMMAND OPTIONS.
  
  For more detailed help, refer to the Online Reference Manual.
  
  db2 =>

• --member <N>
  This allows users to invoke the command on a specific member, such as using the Db2 problem determination tool to show the applications running on a specific member. For example:

  # eventstoreUtils --tool db2pd --member 2 --command '-applications -db EVENTDB'
  
  Database Member 2 -- Database EVENTDB -- Active -- Up 1 days 17:50:32 -- Date 2020-01-10-20.12.31.850619
  
  Applications:
  Address            AppHandl [nod-index] NumAgents  CoorEDUID  Status                  C-AnchID C-StmtUID  L-AnchID L-StmtUID  Appid                                                            WorkloadID  WorkloadOccID CollectActData          CollectActPartition     CollectSectionActuals
  0x000000020DCB0080 65470592 [999-00128] 0          0          Decoupled               0        0          0        0          *N999.DB2200109022225                                            0           0             n/a                     n/a                     n/a
  0x000000020F4EECA0 131217   [002-00145] 1          219        ConnectCompleted        0        0          0        0          *N2.DB2.200109022313                                             0           0             N                       C                       N
  ...
  

  For more information on using the Db2 problem determination tool, refer to Monitoring and troubleshooting using db2pd command.