Configuration

EUP configuration and Azure Log Analytics integration

First, the configuration of the End-User Performance Simulation instances is described. Then, a description is given on how to enable the Azure Log Analytics integration.
Azure Log Analytics is formaly known as Operations Management Suite (OMS).

EUP Configuration file

Here the configuration of the End-User Performance Simulation instances is described. The Backbone End-User Performance Management Pack uses the EUP Configuration file to define the configuration of the End-User Performance Simulation instances. The discovery workflow reads the EUP Configuration file and creates targets for the simulation instances and steps based on the file content.

Details of the EUP Configuration file are:

Name Type Location Default location
Config.xml XML EUP Collector Path %PROGRAMFILES%\The Backbone\The Backbone End-User Performance MP\

The EUP Configuration file has the following syntax:

<?xml version="1.0" encoding="UTF-8"?>
<config>
  <instance id="" name="" frequency="" consecutivesampletime="1" consecutivesamplestate="1" uploadtooms="">
    <watchers>
      <watcher location=""></watcher>
      ...
    </watchers>
    <steps>
      <step id="" name="" order="" consecutivesampletime="1" consecutivesamplestate="1"/>
      ...
    </steps>
  </instance>
  ...
</config>

Simulation instance

The file starts with the root element <config>. The element <config> can contain one or more <instance> elements. The element <instance> describes the simulation instance that is monitored and is used to process and order the received End-User Performance Simulation data that is stored in the EUP Collector Path. The element <instance> has no element value. The table below shows the attributes of the element <instance>.

Attribute Type Mandatory Explanation
id String Yes The identifier of the simulation instance. The id can be a name, a number or a combination of both. The id should correspond with the simulation instance id that is used in the End-User Performance Simulation data files, which are written in the EUP Collector Path. Every simulation instance should have a unique id within the EUP Collector processing the simulation instance.
name String Yes User-friendly name of the simulation instance used for the display name of the corresponding target in SCOM. The use of a descriptive but short name increases the readability of information in SCOM.
frequency Integer Yes The interval in seconds in which SCOM should expect a new End-User Performance Simulation data file. SCOM uses this value to detect missing simulation data files.
consecutivesampletime Integer No Number of consecutive samples a simulation instance or a step exceeds the configured time threshold, before the state of the object in SCOM changes to unhealthy.
consecutivesamplestate Integer No Number of consecutive samples a simulation instance or a step failes before the state of the object in SCOM changes state to unhealthy.
uploadtooms String No Azure Log Analytics workspace id’s, comma-separated, to which data chould be uploaded. Id’s are described in the <oms> element.

The element <instance> has no value or attributes and contains the following two child elements:

  1. <watchers>
  2. <steps>

Watchers

The element <watchers> has no value or attributes and contains one or more elements named <watcher>. The element <watcher> specifies the FQDN or Hostname of the Watcher Node. The table below describes the attribute of the element <watcher>.

Attribute Type Mandatory Explanation
location String No User-friendly location name of the Watcher Node used for the display name of the Watcher Node’s location in SCOM. The use of a descriptive but short name increases the readability of information in SCOM.

Steps

The element <steps> has no value or attributes and contains one or more elements named <step>. The element <step> has three attributes that specify the name and the order of the step. The element <step> does not have a value. The table below describes the attribute of the element <step>.

Attribute Type Mandatory Explanation
id String Yes The identifier of the step. The id can be a name, a number or a combination of both. The id should correspond with the simulation instance id that is used in the End-User Performance Simulation data files, which are written in the EUP Collector Path. Every step in a simulation instance should have a unique id.
name String Yes User-friendly location name of the step used for the display name of the step in SCOM. The use of a descriptive but short name increases the readability of information in SCOM.
order Integer Yes Order of step occurrence within the simulation instance. This information is used to sort targets in reports in a logical order.
consecutivesampletime Integer No Number of consecutive samples a step exceeds the configured time threshold, before the state of the object in SCOM changes to unhealthy.
consecutivesamplestate Integer No Number of consecutive samples a step can fail before the state of the object in SCOM changes state to unhealthy.

The element <step> does not contain any child elements.

Example EUP Configuration file

The code block below is an example EUP Configuration file used to specify one instance with two Watcher Nodes and two steps. When the measured time of the simulation instance exceeds the threshold 3 times or the simulation fails 2 times, the health state of object in SCOM changes. If the step exceeds the threshold more than 2 times or the step fails 3 times, the health state will change in SCOM. The file should be located in the EUP Collector Path.

<?xml version="1.0" encoding="UTF-8"?>
<config>
    <instance id="1" name="EUP1" frequency="300" consecutivesampletime="3" consecutivesamplestate="2">
        <watchers>
            <watcher>watcher1</watcher>
            <watcher location="Netherlands">watcher2</watcher>
        </watchers>
        <steps>
            <step id="1" name="step1" order="1" consecutivesampletime="2" consecutivesamplestate="3"></step>
            <step id="2" name="step2" order="2" consecutivesampletime="2" consecutivesamplestate="3"></step>
        </steps>
    </instance>
</config>

Enabling Azure Log Analytics integration

Introduction

Azure Log Analytics contains Log Analytics, a complementary functionality of Microsoft System Center Operations Manager (SCOM) to analyze data. Starting from version 1.2.0.0, The Backbone End-User Performance Management Pack can be configured to upload data to multiple Azure Log Analytics workspaces. Within Azure Log Analytics this data can be searched, analyzed and visualized according to your own needs.

How it works

The End-User Performance (EUP) Collector initiates data upload to Azure Log Analytics and uses the public Data Ingestion API to achieve this.

enabling azure log analytics integration

The image above visualizes the different components and data flow responsible for the Azure Log Analytics functionality. Each component and it’s main task is described below:

  1. The Watcher Node writes End-User Performance Simulation data to the Collector
  2. The EUP Collector processes the information and sends the information to SCOM
  3. If configured, the SCOM data item is transformed to a JSON package
  4. The JSON package is uploaded to the Azure Log Analytics Workspace
  5. The stakeholder can use Azure Log Analytics to visualize the information according to his needs

Prerequisites

The prerequisites below must be met to be able to use Azure Log Analytics integration:

  1. A descriptive name for the workspace
  2. Configure the Workspace ID and shared key
  3. Enable Azure Log Analytics data upload on instances
    Add the XML snippet below to the EUP Configuration file after the last tag and before the tag.
<oms id="">
  <workspaceid>...</workspaceid>
  <sharedkey>...</sharedkey>
</oms>

The workspace id and primary key have to be changed to the unique values of your workspace. These values can be found within the Azure Log Analytics Workspace under ‘Agent management -> Windows Servers’ as shown below:

enabling azure log analytics integration

Now the EUP Collector knows where to send the EUP simulation data. Next you need to tell for which instances it should upload the data and to which workspace. Enabling the Azure Log Analytics data upload feature for an instance is done by adding a tag to the instance definition as shown in the XML snippet below:

<instance id="instance_1" name="Simulation 1" frequency="300" uploadtooms="workspace1,workspace2">
...
<instance id="instance_2" name="Simulation 2" frequency="300" uploadtooms="workspace1">
...
<oms id="workspace1">
  <workspaceid>...</workspaceid>
  <sharedkey>...</sharedkey>
</oms>
<oms id="workspace2">
  <workspaceid>...</workspaceid>
  <sharedkey>...</sharedkey>
</oms>

Meer weten?

Neem vrijblijvend contact op en vraag naar de mogelijkheden.

Copyright © TheBackbone | Part of INVINITIV