oi_connector AC Configuration

This article describes how to configure the DX Operational Intelligence Gateway (oi_connector) probe. Using this probe, you can import UIM alarms, groups, and QoS to DX Operational Intelligence which enables you to monitor this information through the DX Operational Intelligence dashboards.
uimpga-ga
oiconnector_AC
This article describes how to configure the DX Operational Intelligence Gateway (oi_connector) probe. Using this probe, you can import
UIM
alarms, groups, and QoS to DX Operational Intelligence which enables you to monitor this information through the DX Operational Intelligence dashboards.
The following diagram outlines the process to configure the probe.
Configuing oi_connector on AC
Configuing oi_connector on AC
Contents
2
Verify Prerequisites
Verify that the required hardware and software are available and installation considerations are understood before you configure the probe. For more information, see oi_connector (DX Operational Intelligence Gateway) Release Notes.
(Optional) Configure Logging Properties
You can change the default configuration of your probe if these settings do not meet your requirements.
Follow these steps:
  1. Select the
    oi_connector
    node.
    The
    Probe Information
    section provides information about the probe name, probe version, start time of the probe, and the probe vendor.
  2. In the
    oi_connector
    node >
    General Configuration
    section, specify from the following level of details that are written to the log file in the
    Log Level
    field:
    • 0 - Logs only severe information (default)
    • 1 - Logs error information
    • 2 - Logs warning information
    • 3 - Logs general information
    • 4 - Logs debugging information
    • 5 - Logs tracing/low-level debugging information
: Log as little as possible during normal operation to minimize disk consumption, and increase the amount of detail when debugging.
Enable Alarm, Groups, and QoS
Use the following procedure to setup your configuration.
Follow these steps:
  1. In the
    oi_connector
    node >
    UIM Configuration
    section, update the following information to enable the
    UIM
    alarm and inventory subscription by the oi_connector probe:
    • Subscribe to UIM Alarm
      : enables the subscription of UIM alarms based on the severity. If disabled, alarms are not indexed.
      By default, all the severity types for the alarms are selected, you can unselect the severity types that are not required. If the "Selected" field is blank, no alarms are sent to DX Operational Intelligence (DOI).
    • Subscribe to UIM Groups:
      enables the subscription of UIM groups and publishes group information such as addition, update, or deletion of a group from UIM to DOI (DX Operational Intelligence). For more information, see Manage Groups.
    • UIM Groups:
      allows you to select groups for sending data (list of devices, metrics, alarms, and CI) of only the selected groups to DOI. The group names appear in the
      Group Name – Parent Group Name
      format. This is an optional field. By default, no groups are selected and all UIM groups data is forwarded to DOI. The following screenshot illustrates the selected UIM groups:
      oi_connector.jpg
    • Subscribe to UIM QoS
      : enables the subscription of UIM QoS. If disabled, QoS data is not indexed.
      The
      Selected QoS Origins
      ,
      Selected QoS Hosts, and
      Selected Qos Probes
      fields are enabled only when the
      Subscribe to UIM QoS option
      is selected. You can also use regular expressions in these fields. For more information, see
      Use Regular Expressions
      .
    • Selected QoS Origins
      : specifies the origins for which the oi_connector probe enables forwarding of QoS messages to Jarvis. Each origin signifies a hub within the UIM domain. You can also use regular expressions to specify multiple origins. If this field is left blank (.*), the probe enables the forwarding of QoS messages from all the origins to Jarvis.
      Default: Blank
    • Selected QoS Hosts
      : specifies the hosts for which the oi_connector probe enables forwarding of QoS messages to Jarvis. You can also use regular expressions to specify multiple hosts. If this field is left blank (.*), the probe enables the forwarding of QoS messages from all the hosts to Jarvis.
      Default: Blank 
    • Selected QoS Probes
      : specifies a single probe or a list of probes. The probe enables forwarding of QoS messages from the specified probes to Jarvis. You can also use regular expressions to specify multiple probes. If this field is left blank, the probe enables the forwarding of QoS messages from all the probes to Jarvis.
      Default: cdm|aws|openstack|docker|azure|nutanix|vmware|logmon|processes|iis
  2. Synchronize the following data:
    • Select
      Actions > Fetch UIM Groups
      to fetch the UIM groups information to the probe configuration.
  3. In the
    oi_connector
    node >
    DOI Configuration
    section, update the following information that is required to get or post data from the DX Operational Intelligence server.
    • Default Tenant ID
      : specifies the Default Tenant ID at DOI. Each DX Operational Intelligence user can be identified by the Tenant ID.
      • For DX Operational Intelligence On-prem environments:
        • Obtain and enter the
          Tenant ID
          :
          • You need to the Tenants IDs from:
            http://<elasticsearch-endpoint>/ao_tenants_1_1/_search?size=200&pretty
            Please note that the
            size
            value can be increased as per your requirement by updating the value in the above query. For more information on the default settings in elastic, see Elastic Search
      • For DX Operational Intelligence SaaS environments:
        • Obtain the
          Default Tenant ID
          Contact the
          Broadcom SaaS Operations
          team (
          ) for the Tenant ID.
          Example Default Tenant ID,
          E9DED389-06D3-42BC-B0F5-A3E611373ABC
    • Nginx Ingestion Endpoint
      (formerly known as Jarvis Ingestion Endpoint)
      : specifies the NginxURL. The probe requires this URL to post alarm, inventory, and metrics data to Nginx.
      • For DX Operational Intelligence On-prem environments:
        • Obtain and enter the
          Nginx Ingestion Endpoint
          (formerly known as Jarvis Ingestion Endpoint):
          For example,
          http(s)://<Nginx endpoint>/ingestion
          • You can obtain the Nginx Ingestion endpoint as follows:
            • If you are using
              Openshift
              :
              oc get routes -n<namespace> | grep nginx
              For example, http://apmservices-gateway.munq001500.abc.com
            • If you are using
              Kubernetes
              :
              kubectl get ingresss -n<namespace> | grep nginx
              For example, apmservices-gateway.10.109.32.162.nip.io
        • For DX Operational Intelligence SaaS environments:
          • Obtain and enter the
            Nginx Ingestion Endpoint
            (formerly known as Jarvis Ingestion Endpoint):
            https://api.dxi-na1.saas.broadcom.com/ingestion
    • Jarvis Elasticsearch URL
      : specifies the Elasticsearch URL. The probe requires this URL to get the alarm, inventory, and metrics data from Elasticsearch.
      The probe uses http protocol to communicate with DOI and Elasticsearch. For SaaS environments, the probe uses https protocol with DOI and you need not specify the Elasticsearch URL.
  4. In the
    oi_connector
    node >
    Proxy Configuration
    section, update the following information that is required to connect to the proxy server. if required.
    • Enable Proxy Settings
      : allows you to enable or disable the network proxy server settings that are used to connect to the DOI platform.
      Use this option only if proxy information is required to create the connection through a firewall in the network.
    • Proxy Server Name
      : defines the name of the proxy server.
    • Proxy Server Port
      : defines the port to access the proxy server.
    • Proxy Username
      : defines the user name to access the proxy server.
    • Proxy Password
      : defines the password for the specified username.
  5. Select
    Actions > Verify Elasticsearch
    to verify the availability of Elasticsearch URL.
  6. Select
    Actions > Verify Jarvis
    to verify the availability of JarvisURL.
  7. Select
    Actions > Verify Tenant ID
    to verify the availability of the tenant.
  8. Select
    Save
    .
  9. In the
    oi_connector
    node >
    NASS Configuration
    section, update the following information that is required to get or post data from the NASS server.
    • NASS Url
      specifies the NASS URL. The probe requires this URL to post UIM metrics metadata, metrics values to NASS.
      • For DX Operational Intelligence On-prem environments:
        • Obtain and enter the NASS URL (apmservices-gateway endpoint)
          • You can obtain the NASS URL as follows:
            • If you are using
              Openshift
              :
              oc get routes -n<namespace> | egrep apmservices-gateway
            • If you are using
              Kubernetes
              :
              kubectl get ingress -n<namespace> | grep apmservices-gateway
      • For DX Operational Intelligence On-prem environments:
        • Enter the NASS URL:
          https://apmgw.dxi-na1.saas.broadcom.com
    • NASS Tenant Token
      specifies the NASS tenant token. Each NASS user can be identified by the tenant token.
      • Obtain Agent/Tenant token
        .
    The probe posts the alarm, inventory, and metric data on the DOI at the time interval specified in the probe raw configuration interface.
The probe requires some time to restart on making any changes through the raw configuration interface. We recommend you to restart the probe manually, after waiting for 2-3 minutes.
Enable Multi-tenant Origins
The default probe configuration does not include the option to synchronize your inventory and alarms to multiple tenants in DOI. The probe retrieves the list of origins in your CA UIM environment. You can then map your DOI tenants to CA UIM origins.
Use the raw configure to disable the data ingestion on the default tenant by turning off all alarms, inventory, and subscription before proceeding to enable multi-tenancy.
Follow these steps:
  1. Open the probe configuration interface.
  2. In the
    oi_connector
    node >
    UMP Connection Details
    section, select
    Configure Multitenancy
    to enable the probe to connect to multiple CA UIM tenants.
  3. Update the following information to configure identification details of the UMP to retrieve CA UIM origin information.
    • UMP Host Name
      : specifies the hostname of the system where the CA UMP is deployed.
    • Username
      : specifies the CA UIM user that can access the UMP. The probe retrieves the list of origins as applicable for the user.
      The CA UIM user must be a Bus user with webservices and account administrator permissions.
    • Password
      : specifies the password for the CA UIM user.
    • UMP Port
      : specifies the port of your CA UMP deployment.
  4. Select
    Actions
    >
    Validate Connection
    to verify the connection to the CA UMP deployment.
  5. Save the configuration.
The probe configuration interface displays the list of all tenants at DOI in the
DOI-Multitenancy Configuration
node.
Map Tenants to CA UIM Origins
The probe automatically maps information from your tenants to the primary hub of your CA UIM environment. You can map each tenant to more than one CA UIM origins. However, a CA UIM origin can be mapped only to a single tenant.
If the tenant-origin mapping is available, the probe will not send any data to the default tenant ID and this data is discarded. The UIM group information will always be forwarded to the default tenant ID.
Follow these steps:
  1. Navigate to the
    DOI-Multitenancy Configuration
    node >
    DOI-Multitenancy Configuration
    section.
  2. Set or modify the following fields, as required:
    • Tenant Id:
      allows you to select a tenant from the list of tenants. The probe lists tenants that are populated from the DOI server.
    • Origins:
      lets you select the origin from the
      Available
      list to the
      Selected
      list. The probe maps the selected tenant with the origins that are displayed in the
      Selected
      list.
  3. Select
    Actions
    >
    Fetch Origin List
    to retrieve a list of all CA UIM origins.
  4. Select
    Actions
    >
    Fetch Tenant List
    to retrieve a list of all tenants.
    You must refresh your browser, after clicking any of the above options from the
    Actions
    dropdown to get an updated list.
  5. Save the configuration.
    The probe posts data on the DOI server according to the origin-tenant mapping.
DOI SaaS Deployment
The oi_connector probe sends probe metric, alarm, inventory, and group data from CA UIM to DX Operational Intelligence (DOI) SaaS. While sending the CA UIM data to DOI SaaS, consider the following points:
  • The DOI Elasticsearch URL field is not mandatory and can be left blank.
  • The Verify Tenant ID action does not work.
  • The Multi-tenancy configuration is not supported (unless you are using multiple SaaS tenants).
  • Use the
    dxiTenancy
    key to enable tenant specific data ingestion of all UIM data (alarms, QoS, devices, and CIs) to UIM SaaS through the raw configuration interface. If you enable this key, then multi-tenancy configuration is not required.
Configure Advanced Properties
This section describes advanced configuration settings for the oi_connector probe. These settings let you configure the probe properties using the
Raw Configure
option, which is not possible through standard probe GUI. The following keys are added in the probe
Raw Configuration interface
->
Setup
section to improve the probe performance.
  • uim_device_inventory_sync_interval_in_mins:
    You can set the value of this key to synchronize the UIM device inventory incremental information to DOI. For example, if you specify the
    uim_device_inventory_sync_
    interval_in_mins
    value as
    60
    , the probe synchronizes only last 60 mins device
    inventory information (New / Updated) to DOI every hour.
    Default: 30 (minutes)
  • uim_device_inventory_alive_
    time_months
    : You can set the value of this key to synchronize the UIM device inventory information for the last n months to DOI during the startup. For example, if you specify the
    uim_device_inventory_alive_
    time_months
    value
    as
    12
    , the probe synchronizes only last 12 months device inventory information to
    DOI.Default: 6 (months)
  • process_open_uim_alarms:
    You can set the value of this key to synchronize the UIM open alarms that are not available in DOI to DOI during the startup. For example, if you specify the
    process_open_uim_alarms
    value as
    true
    , the Default: true
    After the synchronization is complete, this flag is disabled to prevent repeated open alarm synchronizations with every start or restart.
  • get_ci_attributes
    : The probe displays the configuration item attributes (docker_id) in the CA UIM Configuration Items Inventory.
    Default: false
  • bulk_size
    : The probe retrieves alarms and inventory information from the queues present on the hub and sends this information to DOI depending on the bulk size value that is specified for this key. For example, if you specify the
    bulk_size
    value as 1000, the probe retrieves a list of 1000 alarms and inventory in one iteration from the hub queue.
    Default: 500
  • dxiTenancy:
    (UIM SaaS only) Use the
    dxiTenancy
    key to enable tenant specific data ingestion of all UIM data (alarms, QoS, devices, and CIs) to UIM SaaS through the raw configuration interface. If you enable this key, then multi-tenancy configuration is not required.
  • payload_bulk_size
    : The probe sub-divides the alarms and inventory information that is received in a bulk into smaller chunks based on the payload bulk size value that is specified for this key. For example, if the
    bulk_size
    value is specified as 1000, and the
    payload bulk_size
    value is specified as 500, then the probe retrieves alarms and inventory information in two chunks (of 500 each) from the hub queue and sends this information to DOI.
    Default: 500
  • qos_payload_bulk_size
    : The probe sub-divides the QoS information that is received in a bulk into smaller chunks based on the payload bulk size value that is specified for this key.Default: 500
  • qos_bulk_size
    : The probe retrieves QoS information from the queues present on the hub and sends this information to DOI depending on the bulk size value that is specified for this key.Default: 500
  • task_count
    : The probe retrieves alarms, inventory, and QoS information from the queues present on the hub by task count. For example, if you specify the
    task_count
    value as 50, the probe retrieves a maximum of 50 entries from the hub queue at a time.
    Default: 100
  • schedule_time_minutes
    :  The probe retrieves the Group Cache Data for UIM alarms and inventory according to the value set through this key. For example, if you specify the
    schedule_time_minutes
    value as 10, the probe retrieves the Group ID and Group Name data for UIM alarms and inventory and updates the cache for the same in every ten minutes.
    Default: 30
  • schedule_time_hours
    : You can set the value of this key to schedule the synchronization of UIM inventory information to DOI. For example, if you specify the
    schedule_time_hours
    value as 4, the probe sends this information to DOI after every four hours.
    Default: 5 (Minimum time configurable is 1 hour)
  • group_using_account:
    You can set the value for this key as True to enable the probe to filter UIM device groups based on the account.
    Default: False
  • enableServiceAnalytics:
    You can set the value for this key as True to enable the probe to populate services_impacted in UIM alarm index.
    Default: False.
  • uimTroubleTicketField:
    The
    Probe retrieves the
    troubleTicket
    value for UIM alarms from this field. You can set a value ranging from custom_1 to custom_5 for this field.
    Default: custom_1
  • retention_period:
    You can set the value for this key to define retention period for all the queue messages. If DOI ingestion remains down for the defined period, the probe starts discarding the messages from the queue.
    Default: 120 minutes
  • axagateway_alarm_severity
    : You can set the value of this key to define severity of the alarm that is generated by the oi_connector probe. For example,
    “UIM QoS que is down”
    . The default severity is 5 (critical).
    Default: 5
  • generate
    _
    uim_queue_down_alarm:
    You can set the value of this key to enable or disable the alarm that is generated by the probe when a queue is down. The default is
    True
    .
    If the value is set as
    False
    , no queue down alarm is generated.
  • generate
    _
    doi_monioring _down_alarm:
    You can set the value of this key to enable or disable the alarm that is generated by the probe when DOI (DOI, Elasticsearch, or tenant) is not available. Default value
    True
    . If the value is set as
    False
    , the probe does not generate any DOI down alarm
Use Regular Expressions
The oi_connector probe uses regular expressions several times during probe configuration. For example, specifying the regular expression cdm|aws|openstack|docker in
UIM Configuration >  Selected QoS Probes
field enables the forwarding of QoS messages from the
cdm
,
aws
,
openstack, and
docker
probes to DOI.
You can also filter data based on the metric_type, using the following key:
metric_regex = .*
You can customize the key value from the Raw Configure page. For example, if you customize the value as
metric_regex
= 1.6:2|1.6:5|1.6:7|1.6:9|1.5:1|1.5:36|1.1:3|1.1:14 then only the defined metrics are posted to Jarvis based on the metric_type.
A regular expression (RegEx for short) is a special text string for describing a search pattern. Constructing regular expression and pattern matching requires meta characters. The probe supports Java Regular Expression, which are enclosed within forward slash
(/)
.
You can also use simple text with some wildcard operators for matching the target string. For example,
*test*
expression matches the text
test
in target string.