The DX Gateway package consists of On-Prem Gateway, On-Prem ITSM (CA Service Management), RESTmon, and Log Collector (Logstash). You can install all the components or only the required component by modifying the common configuration file.
- On-Prem Gateway:The On-Prem Gateway is an interfacule which collects alarms fromDX SaaSand sends alarms to the On-Premise third-party products through channels. The On-Prem Gateway acts as a poller which collects alarm data periodically. The On-Prem gateway and the third-party product must be installed on the same system. For more information, see the On-Prem Gateway section.
- On-Prem ITSM:On-Prem ITSM (Incident Manager) integrates with CA Service Management (CA SM) to track and manage alarms raised inDX SaaS. When an alarm occurs inDX SaaS, a ticket is created in the CA Service Management system. For more information, see the Integrate CA Service Management section.
- DX RESTmon:Integrates with third-party products or services over REST APIs and pulls data into DX Operational Intelligence (OI). For more information, see the DX RESTmon section.
- DX Log Collector:The Log Collector collects syslogs from network devices or servers and ingests into OI. The Log Collector also includes Filebeat to collect logs of the DX Operational Intelligence containers and parses them based on the predefined patterns. For more information, see the DX Log Collector section.
This article contains the following sections:
The following diagram shows the solution overview:
Prerequisites for DX Gateway
Review the following prerequisites before deploying DX Gateway.
Deploy DX Gateway on systems with the following minimum resources:
- Memory - 16GB of RAM
- CPU - 4 Cores
- Storage - 100 GB
DX RESTmon runs on Java processes so you can tune the memory allocation pool settings for the JVM to optimize performance based on your environment. The default memory allocation for a Java process is 2GB, we recommend you to increase it to a minimum of 4GB for optimum RESTmon performance.
For example, you can update the Java heap size to 8GB in RESTmon by executing the run.bat or run.sh from
<DX-GATEWAY_Installation_Directory>\Restmon, and add
- Access to DX Operational Intelligence (DX OI).
- Access toDX SaaS. You can download the DX Gateway package only fromDX SaaS,Settingspage.
- Verify that OpenJDK 14 is installed on the system where you want to deploy the DX Gateway. As a prerequisite, ensure that Java is installed and the JAVA_HOME environment variable points to your Java installation directory.
- On-Prem Gateway
- Configure theonprem_gateway.propertiesand thewebhook_gtw.cfgfiles before you deploy the DX Gateway. For more information, see the Prerequisites to Install On-Premise Gateway section.
- On-Prem ITSM
- Review the On-Prem ITSM specific requirements before you deploy the DX Gateway. This includes creating and adding the Channel. For more information, see the Integrate Service Management section.
- DX RESTmon
On-Prem ITSM and DX RESTmon both run on the default 8080 port (HTTP). If you are installing both the components on the same server, ensure you set a different port for DX RESTmon or On-Prem ITSM by modifying theserver.portvalue in the respective <DX-GATEWAY_Installation_Directory>\<component>\config\application.properties file.
- DX RESTmon supports JSON- and XML-formatted payloads. To use XML-formatted payloads, enter xml2json as a value to the xml_ns field in the schema. For JSON-formatted payloads, you do not need to provide any value.
- Log Collector
- The Log Collector installation works only on a Linux Operating System.
- Do not modify the value ("LogstashComponent") for thedxsaas_logcollector_onprem_locationparameter. The Log Collector creates theLogstashComponentfolder and places all the required files in this folder.
- The Log Collector does not require the Tenant ID, Username, and Password fields. The URL in thedxsaas_logcollector_ingestion_api_urlparameter is sufficient for it to collect data.
- The Log Collector also includes Filebeat to collect logs of the DX Operational Intelligence containers and parses them based on the predefined patterns.
Download DX Gateway
Follow these steps:
- Login to.DX SaaS
- ClickDownloads,DX Gatewayto download the package.
Contents of the DX Gateway Package
The DX Gateway package consists of the following files and folders:
- Config: This folder contains thegeneric_config.jsonfile which is required to configure the commonDX SaaSconnection details.
- installer.bat and installer.sh: Use theinstaller.batorinstaller.shto start the installation on a Windows or Linux computer respectively.
- Scripts: This folder contains the scripts to start and stop the installers.
- Onprem: This folder contains the On-Prem Gateway configuration files.
- Onprem-Itsm: This folder contains the Onprem-ITSM configuration files.
- Restmon: This folder contains the DX RESTmon configuration files.
- Logstash: This folder contains the Log Collector syslog configuration files.
Configure and Deploy DX Gateway
The common configuration file in DX Gateway enables you to deploy all the four components (On-Prem Gateway, On-Prem ITSM, RESTmon, and Log Collector) at the same time or individually based on your requirement.
- Ensure that you have downloaded the DX Gateway package.
- Ensure that you have reviewed the DX Gateway Prerequisites section.
- The following procedure lists only the parameters which require user input. All other parameters in thegeneric_config.jsonfile are auto-populated when you run the DX-Gateway installer.
Follow these steps:
- Navigate to the<folder.DX-GATEWAY_Installation_Directory>\Config
- Edit the following parameters in thegeneric_config.jsonfile:
- dxsaas_tenant_id: Enter theDX SaaStenant name. For example,example_tenant.
- dxsaas_username: Enter theDX SaaSusername. For example,
- dxsaas_password: Enter the password for the user.Enter the password as clear text and leave thedxsaas_password_encryptedfield tofalse. The application encrypts the password and sets the encryption field totrue.If the service account user is enabled for your tenant, provide that service account user name and password for integrations. In addition to these parameters, also ensure to update thedxsaas_cohort_idparameter.
- (Optional - Only for a proxy configuration) If the environment is configured to use a proxy, then update the following parameters in thegeneric_config.jsonfile:
- proxy_enabled: Enter true to enable the proxy configuration. Default: false.
- proxy_hostname:Enter the hostname which has proxy configured.
- proxy_port: Enter the port for the proxy hostname. Default:8080.
- proxy_protocol: Enter the protocol to be used, either HTTP or HTTPS.
- Save the changes to thegeneric_config.jsonfile.
- Execute theinstaller.baton Windows orinstaller.shon Linux.
- To begin the installation enterSin the command prompt as the following prompt illustrates:What action do you like to perform Start(S) or Stop(P) Services?
- EnterYfor each of the components, you want to install. The following snapshot shows that RESTMon is not selected, and Incident Manager and On-Prem Gateway are selected for installation.
- Verify the deployment is successful by viewing the<folder. The Logs folder is created once the installation is initialized for each of the components. For more information, see the DX Gateway Logs section.DX-GATEWAY_Installation_Directory>\Logs
You have now successfully configured the components.
For more information on using these components, see the following sections:
DX Gateway Logs
logsfolder is created once the installation is initialized for the components. The logs folder contains all the individual component logs.
Ensure you provide the required
Writepermissions to the folder before you trigger the installation. For example, on Linux:
chmod 755 -R DX-Gateway
The following are the log files created in the logs folder.
- DX Gateway: Logs/dxgateway.log *This logs issues specific to the DX Gateway startup and initialization.
- On-Prem Gateway: Logs/webhook_gtw.log
- On-Prem ITSM: Logs/incident_manager.log
- DX RESTmon: Logs/restmon.log
- DX Log Collector: Logs/logstash.out*Available only on Linux machines.