Service Maps

Service maps help organize IT services into a hierarchical structure and provide clear visibility to services and resources (dependent on the services).

Create service maps

Rules need to be defined to interlink a parent node with its child nodes. Service Map automatically tracks service impacts based on the defined rules.

Best practices for creating service maps include:

• Identify the dependencies of a service.
• Assess the topology for high availability or point of failures that determine the health of a service or a critical application.

Creating a service map involves:

1. Creating a service map with a parent node.
2. Adding a child node to the service map.

Step 1: Create a service map with a parent node

To create a service map with a parent node:

1. Log in to OpsRamp.

2. Go to Infrastructure > Service Maps. The Service Maps Landing page is displayed.

3. Click the ADD SERVICE MAP button.

4. Enter a service name in the New Service Name box and click Save.

5. Mouse hover over the service and click the Settings icon.

   

6. Define availability and assign articles to the node.

   • Name: Enter a parent node name.

   • Node Type: By default, the type is SERVICE.

   • Availability Threshold: Availability helps you to define the status of a node. Supported nodes statuses are: Up, Down or Degraded.

     • % of down members: Define the availability on the basis of the percentage of services in a group. For example, if 50% of services in a group are down, the status of a service node is considered to be Down.
     • # of down members: Define the availability on the basis of the number of services in a group. For example, if 10 services in a group are down, then the status of a service node is considered as Down.
       
       

   • Send an alert when this service is down: Select to get an alert notification.

7. Click Save.

Step 2: Add child nodes

1. Click the Add icon on the parent node.
2. Add a child node using one of the following methods:
   • Add resources or services to the node
   • Import a node from another service map
   • Link a node that exists in another service map

Add resources and services

1. Enter a name for the node and click Save.

2. Click the Settings icon to configure the node.

3. Select the required Node Type from the drop-down list.

4. Add resources to the node. From the Resource Selection field, select one of the following options:

   • Select Rule-based to add resources automatically using a filter.
   • Select Manual to add resources manually.
     
     

5. If you select Rule-based, do the following steps:

   1. Choose from All or Any rules to apply as a filter for the resources/services.
   2. You can filter for resources using resource attribute name, a logical expression, and value to filter resources using the logical expression Regex. A list of matching resources is displayed in the Matching Members section.

   

   
   When Rule-based option is selected with Advance Search or Normal Rules, devices are automatically added to the service nodes when new devices are on boarded or existing devices have been updated that match the given rules.
   3. Add resources to the node, using query language specifying your requirements, using the Advanced query box. To enter a query: Type “$” followed by a resource attribute. Once you type “$” the resource attributes are auto-populated.
      Examples of resource attributes: App Type, Operating System, DNS Name, etc.
      Select the attribute followed by a space and key operator value.
      Examples of key operator value: “<”, “>”, “=”, “IS”, “contains”, “IS NOT NULL”, “IN”, etc.
      Give a space after you select/enter the key operator value and enter the Value enclosed in double quotes. You can give multiple queries. Use AND or OR condition between the queries, as needed.
      A green tick after entering a query indicates that the query is valid. A forbidden icon indicates that the query is incomplete or the format is incorrect.
      Click the search icon. The number of resources that match the query is displayed. Click Show Matching Results. The resource list is displayed with Name, IP Address, and Resource Type details.
      Note: When using REGEX and REGEX NOT:

   • Avoid using square brackets with \d or \s

     For example:

     • $name REGEX "a[\s+].*"
       This expression can be written as $name REGEX "a\s+.*"

     • $name REGEX "a[\d+].*"
       This expression can be written as $name REGEX "a\d+.*"
       

   • Avoid using ^ and $ in attribute values.

     For example:

     • $name REGEX "^abc.*"
       This expression can be written as $name REGEX "abc.*"
       

     • $name REGEX ".*abc$"
       This expression can be written as $name REGEX ".*abc"

6. If you select Manual, from the Manually Assign Resources section select the resources from the left box and click > icon. The selected resources are added to the right box.

7. From Service Availability Monitor, select one of the following options to define the node status:

   • Availability: If an availability alert triggers on a resource, the status of a node also is impacted.
   • Any Critical Alert: If any critical alert is triggered by the service group, the status of a node also is impacted. Ensure to define availability rules on the resource/service. Any critical alert triggered on the resource/service raises an availability alert and impacts a node.
   • Critical Alert: If a critical alert is triggered on the selected metrics, the status of a node also is impacted. All selected metrics on the individual resources need to be in a critical alert state for the service node to be marked as down, or unavailable. In the case there is a healed alert, the service node is displayed as available, or in green, because this option requires the alerts to be in a critical state.
     
     

8. Enter the values in Availability Threshold. The status of a node is defined by the Service Availability Monitor and Availability Threshold. In addition to the options in service availability monitor, if a certain number of resources are Down in the availability threshold, the node status is displayed as Down. Define an availability rule on the resource/service. Any critical alert triggered on the resource/service raises an availability alert and impacts a node.

9. Click Save.

   The child node is added to the parent node and is displayed on the Service Maps page.

   

Click Back to navigate to the Service Maps listing page. All the services created are displayed on this page.

Import service map as a node

An existing service map can be imported as a node to the other service map.

An imported service map as a node is local to the service map to which it is imported. A parent-level node or a child-level node can be imported.

As the imported service map as a node acts as a local node in a service map, any update made on the imported service map is applicable only to the current service map and not to the other service maps using the same service map.

To import a node:

1. Click the Import icon on the child node.

2. From Import Node and Sub-hierarchy, enter:

   • From the Service Map drop-down, select the required service map to which the node belongs.
   • From the Node drop-down, select the required node.

3. Click Save.

Link a service map

This option allows linking or sharing of an existing service map with other service maps as nodes. Any change performed on the linked service map reflects on the parent service as well. A user cannot edit a shared service in a parent service map.

To link a node:

1. On the child node, click the Link icon.
2. Select the required service map from the drop-down list.
3. Click Save. The service map is linked to the child node and a link icon is displayed on the node.

A user can only link or share a parent level node. If a parent node is shared, then the child nodes are also shared.

Unlink linked nodes

To unlink the linked node from the service map:

1. Open the service maps, click the Edit icon, mouse hover to the linked service node and click the Delete icon.
2. On the confirmation message, click Unlink.
3. Click OK.

Search

From the Service Maps page, in the Find a Service box, enter the required service name. The service map node is displayed.

Node summary

The node summary provides entity information that is impacting a service group.

To view a node summary:

1. From the Service Maps page, click the required service map.

2. Click the required node to view the summary and resource details.

   • The Summary of the node is displayed on the right pane displaying the following details:

     • Down Since: Date and time when the node is Down.
     • Services: Number of nodes/services that are impacted due to the selected node.
     • Alerts: Number of alerts triggered on the node.
     • Tickets: Number of Incidents created on the node
     • Service Impacting Resources: List of resources/services available in the node.

   • The Resources tab includes the resources in the node including their status. A user can further filter for resources based on the resource state. For example, to view resources which are Up, select the status Up from the drop-down list.

Filters

The filter option filters service maps based on the following criterion:

• Service Map Type
• Service Map Availability

The service maps are further categorized based on the following criterion:

Service Map Type

• Standalone: Service maps that are individual and are not linked with another service map.

• Linked: Service maps that are linked to other service maps. A link icon appears next to a linked service map as highlighted in the illustration.

  

Service Map Availability

• Up: Service maps that are in Up status are filtered and displayed. A green colored bar is also displayed next to the map to indicate the same. If the resources in the node have healed alerts (OK) or no critical alerts on availability metric, then it will be in the UP status.
• Down: Service maps that are in Down status are displayed. A red colored bar is also displayed next to the map to indicate the same. If the resources in the node have critical alerts on availability metric, then it will be in down status.
• Degraded: Service maps that are in Degraded status are displayed. An orange colored bar is also displayed to indicate the same. If a service map has 2 nodes and the Availability Threshold number is greater than or equal to 2, if one of the nodes goes down, the service goes into the degraded status and sends a warning alert.
  

See Create service maps to learn about availability thresholds.

To filter, from the Service Maps page, click the Filters drop-down menu.

Manage service maps

You can do various actions on the service map. For example, you can view the horizontal or vertical layout of the service map.

Service Maps listing page

All the configured services appear on the Service Maps page. You can search, change the view, import, and export a service, remove a service, and also refresh a services list.

To view the Service Maps listing page:

1. Go to Infrastructure > Service Maps. The Service Maps page is displayed with the list of all services.

The Service Maps listing page has the following information:

Search for a service

To search for a service:

1. Go to Infrastructure > Service Maps. The Service Maps page is displayed with the list of all service maps.

2. Click the Search icon and enter the search string in the search box.

3. The search result is displayed.

View Alerts, Incidents, and Resources

You can view the summary of impacted alerts, incidents, and impacted resources in a slide-out screen from the Service Maps page.
To view:

1. Go to Infrastructure > Service Maps. The Service Maps page is displayed with the list of all service maps.
   

2. Choose the required service map and click anywhere in the row.
   

   • The slide-out screen with the details of Alerts, Incidents, and Resources is expanded.
   • The name of the service map appears as the heading in the slide-out.
   • Click the > icon to collapse the slide-out screen.

   The slide-out provides the following information for each category:
   

   Alerts
   You can perform the following actions:

   • View a list of Alerts and Alert Updated Time. Click on an alert Id to view more information on the alert browser.
   • Search for an alert using the search_with_name field. Enter the full alert id.
     
     

   Incidents
   You can perform the following actions:

   • View a list of Incidents and Status. Click an incident to view more information on the service desk page.
   • Search for an incident using the search box with the incident id. Enter the full incident id.
     
     

   Resources
   You can perform the following actions:

   • View a list of Resources. Click a resource to view more information on the Resource Overview page.
   • Use the resource name to search for the resources. The list of names is displayed as you start typing.
     
     

Change view

To change a service view:

1. Go to Infrastructure > Service Maps. The Service Maps page is displayed with the list of all service maps.

2. Click on the grid view icon to change from the list view to the grid view. Likewise, click on the list view icon to change from the grid view to the list view.

Import and Export a service map

To import a service map:

1. Go to Infrastructure > Service Maps. The Service Maps page is displayed with the list of all service maps.

2. Click the import icon and then click Upload JSON File on the IMPORT SERVICE popup.

Note: Only one service map can be imported at a time.

To export a service map:

1. Go to Infrastructure > Service Maps. The Service Maps page is displayed with the list of all service maps.

2. Search for the service map and hover mouse on a row.

3. Click the action menu at the end of the row and then click Export.

4. The service map is exported as a JSON file.

Remove a service map

To remove a service map:

1. Go to Infrastructure > Service Maps. The Service Maps page is displayed with the list of all service maps.

2. Search for the service map and hover mouse on a row.

3. Click the action menu at the end of the row and then click Remove.

4. Click REMOVE on the confirmation popup. The following message appears: Are you sure you want to remove the service map?
   Click REMOVE to delete and the service map is removed. click CANCEL to go back.

Refresh the service maps

To refresh the service maps:

1. Go to Infrastructure > Service Maps. The Service Maps page is displayed with the list of all service maps.

2. Click the refresh icon. The list is refreshed.