Starting, stopping, and checking the status of server components

Use the commands for checking the status or for starting, stopping, and recycling the Cloud APM server components when necessary for maintenance and troubleshooting tasks.

As the root user, complete any of these steps:

• To list the available commands and see the syntax, enter the following command:

  apm --help

• To start all, stop all, or recycle all server components, enter one of the following commands:

  apm start_all

  apm stop_all

  apm restart_all

  Short commands: sta, spa, and rta
• To check whether all Cloud APM components or a particular component is running or stopped, enter one of the following commands:

  apm status

  for all components.

  apm status component_name

  where component_name is one of the following components.

  Option	Description
  apmui	Cloud APM console component that handles incoming user interface requests.
  biagent	Component for Cloud APM data collectors, which is enabled by default.
  db2	Db2® server that is used to persist monitoring data and applications that are displayed in the Performance Management console. This component is only used if you install a local Db2 server when you install the Cloud APM server.
  dqe	Component for Cloud APM data collectors, which is enabled by default.
  kafka	Message bus component for internal communication between components.
  ksy	Summarization and Pruning Agent for maintaining database partitions and pruning monitoring data in the Db2 server.
  min	Monitoring Infrastructure Node component that maintains the list of connected agents, advanced configuration data, and threshold events. The min component is also the agent interface component that includes the agent REST interface and central configuration services HTTP server. The REST interface is used by agents to send monitoring data that is persisted in the Db2 server and threshold events. The central configuration service HTTP server handles requests from agents for their configuration files, for example, threshold definitions.
  mongodb	(Not available with Cloud APM, Base Private) MongoDB NoSQL open-source database that stores data for threshold events and for the transaction tracking functionality. This component is only used if you install a local MongoDB database when you install the Cloud APM server.
  oidc	OpenID Connect (OIDC) is a simple identity protocol over OAuth 2.0. The OIDC provider in Liberty Profile is implemented as an OAuth 2.0 extension.
  oslc	Open Services for Lifecycle Collaboration service provider that registers the computer system, software server, and application resources that are monitored by agents in the service component registry.
  scr	Service Component Registry that persists application definitions and their relationships to agent resources in the Db2 server.
  server1	Cloud APM console backend component that retrieves monitoring data and applications from the Db2 server and persists threshold definitions, resource group definitions, and role-based access control definitions. Be aware that if you restart server1, you must also restart the apmui component after restarting the server1 component.
  soagent	(Not available with Cloud APM, Base Private) Agent that aggregates transaction data from multiple playback agents and generates events according to threshold definitions. Be aware that if you stop this component, the agent cannot generate events.
  spark	(Not available with Cloud APM, Base Private) Component that controls the spark infrastructure and the applications such as the AAR Aggregator and Instance Analyzer that run on it. If you stop this service, you will lose functionality.
  txagent	(Not available with Cloud APM, Base Private) Transactions Event agent, which sets the thresholds that are used to classify middleware transactions. If you stop this component, you will lose functionality.
  uview	Universal View service for defining dashboard pages in the Custom Views tab of the Application Performance Dashboard.

  Short command: ss
• If you were directed by IBM® Support or an IBM Knowledge Center topic to start, stop, or restart a particular component, enter the command using the following syntax:

  apm command component_name

  where command is one of the following apm commands:

  Option	Description
  start	Start the specified component_name. Short command: st.
  stop	Stop the specified component_name. To do a force stop, insert -f or --force between apm and stop. For example, apm -f stop apmui, stops the Cloud APM console immediately. Short command: sp
  restart	Restart the running component_name. Be aware that after restarting the server1 component, you must also restart the apmui component. Short command: rt

  and component_name is one of the components that are listed in the previous step (apmui, biagent, db2, dqe, kafka, ksy, min, mongodb, oidc, oslc, scr, server1, soagent, spark, or txagent).

  Note: If the following message is displayed after you are start or stop a component:

  This process currently executes start/stop operations of component
  component_name: process_ID. Wait for it to complete then retry the
  operation.

  It means that the specific service is already being started or stopped by the apm command that is running under the process ID displayed. To check the status of this service, run the

  apm status service_name

  command. If the service is still running from the other apm command, wait a few minutes for it to complete, and retry the operation again.

  Note: If a service does not stop when you use the apm stop service_name, apm stop_all, or apm restart_all commands, do not use the Linux kill command to stop the process. Instead, use the -f or --force option with the apm stop service_name command to stop the process. The -f or --force option must be used only when you cannot stop the process without forcing it to stop.