Viewing running instances of virtual services

After you start virtual services from the Resources page, you can view the instances of the virtual services that are running from the Instances page in HCL OneTest™ Server. You can view the details, configuration settings, routing rules, usage statistics, or logs of a specific running instance of the virtual service. You can also stop the running instance.

Before you begin

You must have completed the following tasks:
  • Been assigned a Member or Project Creator role in a team space.
  • Been assigned the Viewer, Tester, or Owner role in the project so that you can view the virtual services that are running.
  • Started the virtual service resources as a Tester or Owner from the Resources page.

About this task

After you started the virtual services from the Resources page on HCL OneTest™ Server, you can go to the Instances page and you can perform the following tasks:
  • View all running instances of the virtual services that are contained in the project repositories.
  • View the components in the system model that are associated with the virtual service instances.
  • Search for a specific instance of the virtual service for which you want to view the details.
  • Create or use saved filters for viewing specific running instances of the virtual service.
  • View the details, configuration settings, routing rules, usage statistics, or logs of a specific running instance of the virtual service.
  • Change the behavior or logging level of a running instance of the virtual service before you run tests on the virtual service.
  • Stop a specific running instance of the virtual service.
  • Stop multiple instances or all instances of the virtual service that are running.

Procedure

  1. Log in to HCL OneTest™ Server and open the team space that contains your project.
  2. Open the project that contains the virtual service resources in the test assets by clicking Projects > My Projects > project_name.

    The Overview page is displayed.

  3. Click Virtualization > Instances in the navigation pane.

    The Instances page is displayed.

    Any one of the following views is displayed:
    • No instances of virtual services are displayed if there are no instances that are running or were stopped in the past hour.
    • All running instances of virtual services in your project are displayed.
    • No running instances of virtual services are displayed but the option Show all is enabled. You can click Show all to display the instances that were stopped in the past hour. Instances that were hidden from the display when Hide inactive was clicked are displayed.
      Note: All instances that were stopped are automatically removed from the display after 60 minutes of being stopped. You cannot use the Instances page to view the history of stopped instances. You can hide the stopped instances from the display by clicking Hide inactive, so that you can view only the running instances.
    You can find the following information about the running instances that are displayed on the Instances page.
    • The name and path of the virtual service in the project repository are displayed in the Name column.
    • The tags or labels added to the instance when the run was configured is displayed in the Labels column.
    • The name of the environment associated with the operation in which the virtual service was created in HCL OneTest™ API is displayed in the Environment column.
    • The state of the running instance is displayed as Running in the State column.
    • The activity of the running instance of the virtual service based on the number of requests received in the previous hour is displayed in the Activity column. The activities are classified and displayed as indicated in the following table:
      Activity load Activity displayed as
      Received 0 requests None
      Received 1 - 10 requests Low
      Received 11 - 100 requests Mid
      Received 101 - 1000 requests High
      Received more than 1000 requests Very High
    • The Stop icon Image of the stop run icon. is displayed in the Actions column and stops the running instance of the virtual service, when clicked.
  4. Complete the steps for the task that you want to perform as listed in the following table:
    Task Action

    Searching for a specific instance of the virtual service for which you want to view the details or want to stop the instance.

    		 Enter either the complete text or part of the text in the name or the path of the virtual service that is in the repository in the Search field.

    The instances of the virtual services that match the text searched are displayed.
    Viewing the component associated with the running instance of the virtual service. You can view the name of the associated component that is displayed on the Instances page in the Filter row only if you clicked the icon Image of the icon on the System Model page to view all running instances of the virtual services .
    Creating or using saved filters for viewing specific instances of virtual service resources.
    To create a query, perform the following actions:
    1. Click New filter.
    2. Create a rule with an appropriate operator.
    3. Select criteria such as Name, Path, Labels, Environment, State, or Activity.
    4. Select the condition, and then enter the value for the criteria.
    5. Apply the filter query.

      The virtual services that match the filter criteria are displayed.

    6. Save the filter query for retrieving it from the saved filters list.
    To use a saved filter query, perform the following actions:
    Note: To open the filter query, you must have created and saved a filter query.
    1. Click the Open filters icon Image of the icon..
    2. Select the saved filter.
    3. Apply the filter.

      The virtual services that match the filter criteria are displayed.
    Viewing the details, configuration settings, routing rules, usage statistics, or logs of a specific running instance of the virtual service. After you identify the virtual service instance for which you want to view the details, perform the following actions:
    1. Click the Expand icon Image of the icon. in the row of the identified instance of the virtual service.
      The Details panel of the instance is displayed. You can find the following details about the instance displayed:
      • Name
      • Path
      • Labels
      • API Environment
      • Version
      • Started at
      • Started by
      • Associated components
      • Documentation
    2. Click Behavior to expand the panel and view the behavior that was configured for the virtual service.
    3. Click Routing Rules to expand the panel and view the routing rules that were configured in the virtual service.
    4. Click Statistics to expand the panel and view the graphical representation of the activities performed by the virtual service.
    5. Click Diagnostics to expand the panel and view the logging configuration of the virtual service and the links to the logs.
    Changing the behavior or logging level of a running instance of the virtual service. After you identify the virtual service instance for which you want to view the details, perform the following actions:
    1. Click the Expand icon Image of the icon. in the row of the identified instance of the virtual service.

      The Details panel of the instance is displayed.

    Perform any of the following actions:
    • Click Behavior to expand the panel.
      Perform the following steps to change the behavior configurations:
      1. Click the Edit icon Image of the edit icon..
      2. Select a different operation for the virtual service, if available.
      3. Select a different response time and enter the values for the delay that you want to set.
      4. Click apply.
    • Click Diagnostics to expand the panel.
      Perform the following steps to change the logging level configuration:
      1. Click the Edit icon Image of the edit icon..
      2. Select a different logging level.
      3. Click apply.
    Stopping a specific running instance of the virtual service.
    1. Click the Stop icon Image of the stop run icon. in the row of the virtual service instance.
    2. Click Ok in the Stop virtual service instance dialog box that is displayed.
    The running virtual service instance is stopped.
    Stopping multiple running instances or all the running instances of virtual services.
    1. Perform any of the following actions:
      • Select the checkbox in the row of the virtual service instances that you want to stop, and then click Stop selected.
      • Select the Select all checkbox in the header row, and then click Stop selected.
        Note: All running instances are selected when you click the Select all checkbox.
    2. Click Ok in the Stop all selected virtual service instances dialog box that is displayed.
    The running virtual service instances are stopped.

Results

You have viewed running instances of the virtual services from the Instances page on HCL OneTest™ Server.

What to do next

You can perform the following tasks: