Agent Administration UI User Guide

The Agent Administration UI is the central UI to check the status of Simple Diagnostics Agents (SDA), to call actions at the agents and to check the results in the logs. You can search for hosts which are registered in the LMDB and install SDAs on these hosts (if not already done automatically).

For an overview on Agent Administration please refer to the Product Information.

User Interface

 

The Agent Administration UI is divided into three areas:

  • Search Area
    The user can search for a host by host name, by logical host name, or by Technical System name.
  • Result Area
    It shows the user all hosts that fit the search criteria. Selecting one ore more hosts in the result list offers different actions on the hosts.
  • Information and Error Area
    Information about the agent installation and configuration as well as errors are displayed on following tabs of this area:
    • Installation Log Messages
    • Configuration Information
    • Agent Errors
    • Mass Action Logs

Search Area

Result Area Actions

After a search by host, physical host, or technical system, the result area lists all the hosts that match the criteria.

The area has the buttons “Display Host” and “Configure Manually” as well as actions that can be executed on one or more hosts.

Result Area Columns

Availability

This metric measures the availability of a Diagnostics Agent.

Type Description
White The self-monitoring is not yet configured.
Green

The self-monitoring data is received regularly.

Red The self-monitoring is configured, but data is not received.

  • Physical Host
    Name of the physical host
  • Customer ID
    The unique identifier for a customer
  • Logical Hosts
    The name of the logical hosts which are associated with the physical host
  • Technical Systems
    All Technical Systems that operate on the host
  • Host Agent Version
    Version of the SAP Host Agent, which contains a version number, a compile time stamp, and the change list number
  • Diagnostics Agent Version
    The Diagnostics Agent Version contains a number followed by a time stamp (yyyymmddhhmmss)
  • Configuration Status
    The following configuration status values of the agent are possible:

 

Type Description
White The Diagnostics Agent is not yet configured.
Yellow Sending The configuration transfer from the FRUN system to the Diagnostics Agent is currently being processed.
Yellow Pending The configuration transfer from the FRUN system to the Diagnostics Agent is waiting until it can be processed. If this is an ongoing status, check the troubleshooting guide.
Green Up to date A configuration was successfully sent from the FRUN system to the Diagnostics Agent.
Yellow Confirmation outdated A configuration was successfully sent from the FRUN system to the Diagnostics Agent. The Diagnostics Agent is still reporting an older configuration version.
Green Confirmed A configuration was successfully sent from the FRUN system to the Diagnostics Agent. The Diagnostics Agent reports the expected configuration version.
Red Error A configuration could not be done because of internal errors.

  • Actions
    The possible actions depend on the number of selected hosts in the result list. Some actions are single host actions, (Agent Actions) others are multi-selection actions (Mass Actions).
    Furthermore, it depends on the authorization which actions are displayed for the user. For more details see Authorization.

  • Display Host Button
    It is a single selection action. Selecting this button, the LMDB Host Editor is opened. The following information is shown there:
    • General host information like operating system and IP Address
    • Technical systems using the host
    • Installed software
    • Alternative host names
    • Additional attributes
  • Configure Manually Button
    This action opens the Guided Procedure UI for the selected host. It is a single selection action to configure the host manually.
  • Agent Actions
    The agent actions described below can only be executed if a single host is selected.
    • Open Agent Internals
      Open a new window with the Agent Internals application, containing the following information:
      • About the agent, e.g. host name and ID, configuration time …
      • MAI configuration
      • MAI statistics
      • Logs
    • Open File System Browser
      Open a new window with the File System Browser.
    • Open Log Configuration
      Gets the log configuration of the SDA. The logger tree structure and current log levels (fully expanded) are displayed. It is possible to
      • select an entry and to choose a new log level from a drop-down list
      • add a new logger as child to the selected entry or
      • remove a logger.
    • Open SLDR Configuration
      For a selected host, it is checked if this host is registered as an SL Data Router (SLDR). If the agent does not act as an SLDR, then an error dialog is shown: "The selected agent is not an SLDR."
      A configuration dialog is shown with the following functions:
      • show existing destinations
      • modify destinations
      • add a destination
      • delete a destination
      • save or cancel changes
        Information about the successful execution of this action can be found on the Configuration Information tab of the Agent Administration UI. Wait until the configuration was transferred and refresh the UI a few times.
    • Download Log Files
      This action generates a logs.zip file which can be opened or saved. The logs.zip file contains the following agent log files which are relevant for your FRUN system:
      • agent.log
      • applications.log
      • forced-exit.log
      • osgi.log
      • system.log
      • jvm-trace.log
      • dev_jco_rfc.trc
    • Download Configuration
      The configuration files of the agent can be downloaded by this action. The configuration.zip file contains the following directories:
      • default/configuration
      • custom/configuration
        Under these directories there are several application specific configuration files with the configuration related to your FRUN system
    • Restart Agent
      Restarts the selected agent. Don't forget to refresh the Agent Administration UI to see the latest status of the agent restart.
    • Ping Agent
      The details and the reachability of an agent can be checked by the action “Ping Agent”.
    • Get Heap Dump
      The action “Get Heap Dump” collects all heap dump files of the agent and creates a heap_dump.zip file to download.
    • Get Thread Dump
      The action “Get Thread Dump” downloads a stack_dump.zip file of the thread dump of the agent.
    • Enable Debugging
      This action enables the remote debugging at the Diagnostics Agent. The result message displays the port for debugging.

  • Mass Actions
    The Mass Action options accept a multi-selection at the host result table and executes the selected mass action on the selected agents. The results of a mass action are only visible in the Information and Error Area, if just a single agent is selected.
    • Install/Update Agent
      With this action, the selected agents will be installed or updated. The results will be shown in the tab “Installation Log Messages”.
    • Configure Agent
      The configuration of the agent will be triggered by this action. The configuration data and its status will be shown in the tab “Configuration Information”.
    • Outside Discovery
      Here Outside Discovery can be triggered manually for the selected hosts. Errors are displayed in the tab “Installation Log Messages”.
    • Open in New Window
      A new Agent Administration UI will be opened with the selected hosts without the need of search again. The hosts are encoded in the URL. The URL is stable and can also be forwarded to other users.
    • Ping Agent
      This action can be used as a kind of health check for the selected agent. The ping is done in parallel. The results are displayed in the tab “Mass Action Logs”.
    • Restart Agent
      This action provides a restart of a list of agents. The results are visible in the tab “Mass Action Logs”.

 

  • Refresh Time
    The Agent Administration UI supports refreshing the data in periodic intervals. By default, the automatic refresh is “off”. The intervals 15 sec, 30 sec, 1 min, and 2 min can be selected.
    Automatic refresh can be helpful if the Agent Administration UI is used to monitor multiple agents. If the Agent Administration UI is used in the interactive way, it is be better to keep the Refresh Time “off”, because the automatic refresh could interfere with the user actions and thus degrade the user experience.

 

  • Refresh
    The data can also be refreshed manually. The Result Area and the Information and Error Area will be refreshed.

 

  • Load Details
    For performance reasons, not all columns in the Result Area might be filled. Missing data can be loaded by the “Load Details” button.

Authorization

  • Authorization for Agent Administration UI Actions
    The authorization object SR_SDA_AUT only has the field ACTVT, which defines general access authorizations of the user for the agent administration.
    • (03) Display: Read-only view.
    • (16) Execute: Allows user to execute actions.
    • (70) Administer:
      Allows user to use expert tools, e.g. to manually modify automatic configurations, upload binaries, perform agent mass update.
    • (W1) Debug: Allows user to debug the agent or do memory analyses. The user might see passwords.
      Users that have Execute permission also have Display permission.
      Users that have Administer permission also have Display and Execute permissions.
      Users that have Debug permission also have Display and Execute permissions.
      Due to security reasons the permission Debug should be given in rare cases.

      Available action sorted by permission:
    • Display
      • Display in LMDB, LMDB authorizations apply
      • Show Configuration Steps, opens the GP in display mode, Simple System Integration authorizations apply
      • Open agent internals
      • Ping agent
      • Open in new window
    • Execute
      • All display actions
      • Restart
      • Download log files
      • Download configuration
      • Install/update agent
    • Administer
      • All display actions
      • All execute actions
      • SLDR configuration
      • Update all agents
      • Upload SDA/JRE binaries
    • Debug
      • All display actions
      • All execute actions
      • Enable debugging
      • Disable debugging
      • Download heap dump
      • Download stack trace

Agent Internals

Information and Error Area

  • Installation Log Messages
    This tab displays the log messages of the Simple System Integration at host level.
  • Configuration Information
    The Configuration Information tab traces all configurations sent to the agent.
    Here the send status can be checked, as well as the content of the latest configurations.
  • Agent Errors
    The tab displays error metrics messages. A link at the Exception opens a pop-up window to the trace file snippet, listing trace messages from -5 to +1 seconds around the error time.
  • Mass Action Logs
    This tab contains the logs of mass actions, grouped by action.