oi_connector AC Configuration

This article describes how to configure the DX Operational Intelligence Gateway (oi_connector) probe. Using this probe, you can store UIM alarms, metrics (QoS), and UIM groups to DX Operational Intelligence which enables you to monitor this information through the DX Operational Intelligence capabilities.
uimpga-ga
oiconnector_AC
This article describes how to configure the DX Operational Intelligence Gateway (oi_connector) probe. Using this probe, you can store
UIM
alarms, and metrics (QoS) to DX Operational Intelligence which enables you to monitor this information through the DX Operational Intelligence capabilities. The probe performs the tasks like creating different queues for alarms and QoS on the hub, subscribing to those queues. The probe posts the alarms, and QoS to Jarvis (analytics engine).
The following diagram outlines the process to configure the probe.
Configuring 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, the 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 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
    alarms 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.
      Starting from the oi_connector 1.39 version, you can filter the alarms on their severity.
      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).
    • UIM Groups:
      allows you to select groups for sending data (metrics and alarms) of only the selected groups to DX Operational Intelligence. 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 DX Operational Intelligence. 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 the 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 >
    DX Operational Intelligence 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 DX Operational Intelligence. 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
          :
          • If you are using
            OpenShift
            :
            oc get routes -n<your-namespace> | egrep jarvis-es
          • If you are using
            Kubernetes
            :
            kubectl get ingress -n<your-namespace> | egrep jarvis-es
    • For DX Operational Intelligence SaaS environments:
      • For the Default Tenant ID, navigate to DX SaaS -> Settings -> Connection Parameters page
        . Note down the tenant_id which is equal to Cohort ID.
  4. URL:
    specifies the entry point for both services as Nginx Ingestion Endpoint (formerly known as Jarvis Ingestion Endpoint) and NASS URL.
    Specify the URL with the protocol and entry point.
    For Example http(s)://<apmservices-gateway.broadcom.com>/
    • Nginx URL:
      The probe requires this URL to post the alarms data to Nginx.
      • For DX Operational Intelligence On-prem environments:
        • You can obtain the Nginx Ingestion endpoint as follows:
          • If you are using Openshift:
            oc get routes -n<namespace> | grep nginx
            Example, http://apmservices-gateway.domainname.abc.com
          • If you are using Kubernetes:
            kubectl get ingresss -n<namespace> | grep nginx
            Example, https://apmservices-gateway.11.222.33.444.nip.io
      • For DX Operational Intelligence SaaS environments:
        • Use
          https://api.dxi-na1.saas.broadcom.com
          for DX SaaS - USA instance and use
          https://api.dxi-eu1.saas.broadcom.com
          for DX SaaS - EU instance.
    • 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 SaaS environments:
        • Use https://apmgw.dxi-na1.saas.broadcom.com for DX SaaS - USA instance and https://apmgw.dxi-eu1.saas.broadcom.com for DX SaaS - EU instance.
    • Token
      specifies the tenant token.
      • Obtain Tenant token.
        • Generate a Tenant token if you don't have DX APM. You must log in as MASTERADMIN to the Cluster Management for generating tokens.
  5. In the
    oi_connector
    node >
    Proxy Configuration
    section, update the following information that is required to connect to the proxy server.
    • Enable Proxy Settings
      : Allows you to enable or disable the network proxy server settings that are used to connect to the DX Operational Intelligence 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
  6. Select
    Actions > Verify Jarvis
    to verify the availability of JarvisURL.
  7. Select
    Actions > Verify Nass Connection
    to verify the availability of the NASS.
The probe posts the alarm, 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.
Reconciliation Configuration
The Alarm Reconciliation mechanism allows you to get alarms data consistency between UIM and DX Operational Intelligence. You can actualize your DX Operational Intelligence alert information up to three months back. You can start the alarm reconciliation by request or use it as a background process for actualizing your systems with set intervals.
Enable Reconciliation:
Turn on/off Reconciliation between UIM and DX Operational Intelligence.
Time Range:
Choose Reconciliation period boundaries.
Interval between reconciliation (Hours):
Specify the time interval for reconciliation. The first iteration starts in the set time interval.
Enable Multi-tenant Origins
The default probe configuration does not include the option to synchronize the alarms for multiple tenants in DX Operational Intelligence. The probe retrieves the list of origins in your CA UIM environment. You can then map your DX Operational Intelligence tenants to CA UIM origins.
Use the raw configure to disable the data ingestion on the default tenant by turning off all alarms, and subscriptions before proceeding to enable multi-tenancy.
Follow these steps:
  1. Open the probe configuration interface.
  2. In the
    oi_connector
    node >
    OC 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 OC to retrieve CA UIM origin information.
    • OC Host Name
      : specifies the hostname of the system where the CA OC is deployed.
    • Username
      : specifies the CA UIM user that can access the OC. The probe retrieves the list of origins as applicable for the user.
      The CA UIM user must be a Bus user with web services and account administrator permissions.
    • Password
      : specifies the password for the CA UIM user.
    • OC Port
      : specifies the port of your CA OC deployment.
  4. Select
    Actions
    >
    Validate Connection
    to verify the connection to the CA OC deployment.
  5. Save the configuration.
The probe configuration interface displays the list of all tenants at DX Operational Intelligence in the
DX Operational Intelligence-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 origin. 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.
    • Tenant Name:
      Tenant ID. Each DX Operational Intelligence user can be identified by the Tenant ID.
    • Tenant Token:
      Tenant token for authorization.
    • 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.
    You must refresh your browser, after clicking any of the above options from the
    Actions
    dropdown to get an updated list.
  4. Save the configuration.
    The probe posts data on the DX Operational Intelligence server according to the origin-tenant mapping.
DX Operational Intelligence SaaS Deployment
The oi_connector probe sends probe metric, and alarms data from CA UIM to DX Operational Intelligence SaaS. While sending the CA UIM data to DX Operational Intelligence SaaS, consider the following points:
  • The Multi-tenancy configuration is not supported (unless you are using multiple SaaS tenants).
  • Use the
    dxiTenancy
    key to enable the tenant-specific data ingestion of all UIM data (alarms, and QoS) to UIM SaaS through the raw configuration interface. If you enable this key, then a multi-tenancy configuration is not required.
Compatibility of Deployment on Secondary Hubs and Robots Connected to Primary Hub
The Security certificate must be configured on the robot where the probe is deployed.
The certificate (certificate.pem) is stored on Primary Hub in
“../nimsoft/security”
folder. You must copy the certificate to the robot where the probe is deployed and add the path of the certificate pointing to the target robot's controller configuration file “../opt/nimsoft/robot/robot.cfg.”
For example, you may take a look at the Primary Hub's controller configuration file.
Example: cryptkey = /opt/nimsoft/security/certificate.pem
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 to the probe
Raw Configuration interface
->
Setup
section to improve the probe performance.
  • process_open_uim_alarms:
    You can set the value of this key to synchronize the UIM open alarms that are not available in DX Operational Intelligence to DX Operational Intelligence 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 DX Operational Intelligence 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 the tenant-specific data ingestion of all UIM data (alarms and QoS) to UIM SaaS through the raw configuration interface. If you enable this key, then a  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 DX Operational Intelligence depending on the bulk size value that is specified for this key. Default: 500
  • task_count
    : The probe retrieves alarms, 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_hours
    : You can set the value of this key to schedule the synchronization of UIM inventory information to DX Operational Intelligence. For example, if you specify the
    schedule_time_hours
    value as 4, the probe sends this information to DX Operational Intelligence after every four hours.
    Default: 5 (Minimum time configurable is 1 hour)
  • enableServiceAnalytics:
    You can set the value for this key as True to enable the probe to populate services_impacted in the 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 the retention period for all the queue messages. If DX Operational Intelligence 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 the severity of the alarm that is generated by the oi_connector probe. For example,
    “UIM QoS queue 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 generat
  • 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 DX Operational Intelligence (DX Operational Intelligence or tenant) is not available. Default value
    True
    . If the value is set as
    False
    , the probe does not generate any DX Operational Intelligence down alarm
  • connect_to_primary_hub:
    The probe connects to queues and services on Primary Hub.
    Default: true
  • primary_hub_address:
    You can set a Primary Hub by UIM address (Example: /<domain>/<hub>/<robot>/hub).
  • hub_verification_interval:
    the interval between verification callbacks to Primary Hub.
    Default: 7000 (milliseconds)
  • alerts_endpoint_maximum_size:
    API Endpoint limitation.
    Default: 10000 (items)
  • alerts_receiving_batch_size:
    Batch size of receiving DX Operational Intelligence alerts.
    Default: 5000 (items)
  • alerts_sending_batch_size:
    Batch size of alarms that will be posted to DX Operational Intelligence.
    Default: 5000 (items)
  • uim_version:
    The probe adds the UIM version to the payload fetched from the Nimsoft directory on Primary Hub by default. This key provides the ability to overwrite the version if the version cannot be fetched.
  • updatealarm_host_to_original:
    When set to
    true,
    sends the hostname from the Alarm PDS or whatever is available in the NAS_ALARMS table instead of the CS_NAME of the target device.
    Example: updatealarm_host_to_original=true
  • updatealarm_host_to_original_probe:
    specifies a list of probes for this behavior to be applied. The parameter accepts the RegEx pattern similar to other filters.
    Example: updatealarm_host_to_original_probes=url_response
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, O
penStack, and
Docker
probes to DX Operational Intelligence.
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 is enclosed within the 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 the target string.