Some of the Monitoring Station’s features require integration with other elements that make up your infrastructure. In some cases configuration is mandatory (for example, an SMTP server will need to have been set at the time of installation), while in others it is required only when particular up.time features are used (for example, using the Web Application Transaction monitor requires you to provide up.time with your proxy server settings). The following sections outline how to configure up.time to communicate with servers and databases.
Monitoring Station Web Server
Monitoring Stations include a Web server component that drives the user interface. Any Monitoring Station that is accessed by users or administrators requires a URL. The Web address used to access the Monitoring Station is configured through the following uptime.conf
parameter:
httpContext=http://<hostname>:<port>
<hostname>
is the host name of the server on which up.time is running (for example,localhost
)<port>
is the port on which the up.time Web server is listening for requests (for example,9999
); you can optionally omit the port number
If the up.time interface is being accessed via SSL, the value for this parameter should be stated as https
instead of http
.
SMTP Server
up.time uses a mail server to send alerts and reports to its users. After installing up.time for the first time, the administrator was asked to enter SMTP server information. These initial values can be modified in the Mail Servers configuration panel.
Modifying the SMTP Server Used by up.time
To configure up.time’s mail server, do the following:
- On the up.time tool bar, click Config.
- In the left panel, click Mail Servers.
- In the sub panel, click Edit Configuration.
- Type the name of the mail server in the SMTP Server field.
This value was set the first time the up.time administrator logged in after installation; the default value is the name of the host on which the Monitoring Station was installed at that time.
The name of the server could follow thesmtp.<domain_name>
convention, or could be its host name or IP address. - Optionally, enter the port used by the mail server in the SMTP Port field.
- In the SMTP Sender field, enter the email address that up.time uses to send alert notifications and reports.
This value was set the first time the up.time administrator logged in after installation, and should be set to your domain (for example,[email protected]
).
A sender’s name can be encapsulated with double quotes, in which case, the email address is encapsulated with angled brackets:“uptime administrator” <[email protected]>
- In the SMTP HELO String field, enter the string that identifies the domain from which a message is being sent (for example,
uptimesoftware.com
). - In the SMTP User field, enter the user name that is used to authenticate connections with the SMTP server.
- In the SMTP Password field, enter the password that is used to authenticate connections.
- Click Save.
The edit window closes, and you are returned to the Mail Server Configuration panel. - To test the mail server configuration, click the Test Configuration button.
The Monitoring Station will try to send an email message containing the configuration information to the email address of the up.time administrator. If an error message appears in the subpanel, edit and then re-test the configuration.
Database Settings
The database settings are used to determine how up.time communicates with the DataStore, and how it will perform a database health check. The following are the database-related parameters in the uptime.conf
file.
Connection | |
dbType | The type of database that is being used to store data from up.time. The default value is By default, up.time uses a JDBC (Java Database Connectivity) driver, and the driver used to connect to the DataStore corresponds to the database selected:
|
dbHostname | The name of the system on which the database is running. The default is localhost . |
dbPort | The port on which the database is listening. The default is 3308 . |
dbName | The name of the database. The default is uptime . |
dbUsername | The name of the default database user. The default is uptime . |
dbPassword | The password for the default database user. The default is uptime . |
dbJdbcProperty | Optional property-and-value pairs to append to the JDBC database URL. Note that only MySQL and Microsoft SQL Server supports URL properties, so this setting will do nothing if you are using Oracle. The value of the dbJdbcProperty parameter in
|
Health | |
datastoreHealthCheck.checkInterval | When this parameter is enabled with a non-zero value, up.time performs a database health check. The value provided is the frequency of the check, in seconds. The default is 5 . |
datastoreHealthCheck.timeLimit | When the health check time limit has been reached (the value unit is seconds, and the default is 300 ), up.time considers the database down. The Data Collector service is stopped, and administrators that are members of the SysAdmin user group are sent an email. |
Performance | |
connectionPoolMaximum | The maximum number of connections that are allowed to the DataStore. Setting this option to a lower number will help increase the performance of up.time. |
connectionPoolMaxIdleTime | (c3p0 library) Sets the amount of time a connection can be idle before it is closed. This parameter should only be modified with the assistance of up.time Customer Support. |
connectionPoolNumHelperThreads | (c3p0 library) Sets the number of helper threads that can improve the performance of slow JDBC operations. This parameter should only be modified with the assistance of up.time Customer Support. |
Changing the DataStore Database
The up.time DataStore is first linked to a database during the installation process, and contains important historical performance data that has since been collected. Linking the DataStore to a new database will result in lost data unless you properly migrate your data to the new database. As such, changing the DataStore’s database should be done only after some consideration and planning.
In cases where you would like to migrate the database (for example, from the default up.time MySQL implementation to Oracle) or move the DataStore to a different system from the Monitoring Station, you will modify the aforementioned database values in the uptime.conf
file. Note that the modification of these values is one of a series of steps. Refer to the up.time Knowledge Base for more information on migrating your DataStore.
Configuring Global Data Collection Methods
A Windows-based Element can retrieve metric data either through the up.time Agent, or via WMI (see Agentless WMI Systems for more information). You can configure details for either method at a global level, in the form of agent connection information or WMI access credentials. Having global details defined simplifies individual Element configuration, and also allows you to switch the data collection method for multiple Windows Elements, at once, as a group.
When a system is part of the up.time inventory, its data collection method is either configured to be based on an agent, or a WMI agentless method. This configuration option is set when the system is first added as an Element. If agent and WMI details have been globally defined, when adding the Element, you will be able to Use the up.time Agent Global Configuration, or use WMI Global Credentials to skip configuration steps.
Once configured, this data collection method can later be switched from an agent-based, to agentless method, or vice versa. Although this change can be made on a per-Element basis, multiple Elements can also be switched in a single batch. In the latter case, the data collection method must be globally defined.
To configure data collection methods globally, you can provide information for either the up.time Agent, or your organization’s WMI credentials, or both. Note that batches of Elements can only be converted to a particular data collection source when that method has been globally configured in the Global Element Settings panel.
Configuring Global WMI Credentials
To provide WMI credentials that can be used to switch Windows Elements from agent-based data collection:
- On the up.time tool bar, click Config.
- In the left panel, click Global Element Settings.
- In the WMI Agentless Global Credentials sub panel, click Edit Configuration.
- Enter the Windows Domain in which WMI has been implemented.
- In the Username field, enter the user ID that has administrative access to WMI on the Windows domain.
- In the Password field, enter the password for the WMI account.
- Click Save to retain your changes.
- Click Test Configuration to ensure the credentials provided are correct.
Configuring a Global up.time Agent Configuration
To provide up.time Agent information that can be used to switch Windows Elements from agentless, WMI-based data collection, do the following:
- On the up.time tool bar, click Config.
- In the left panel, click Global Element Settings.
- In the up.time Agent Global Configuration sub panel, click Edit Configuration.
Enter the Agent Port Number, indicating the port the up.time Agents use to communicate with the up.time Monitoring Station.
The port number entered reflects what the up.time Agents are configured to use; this setting does not modify the agent-side configuration.
- Select the Use SSL check box if the agents securely communicate with the Monitoring Station using SSL.
- Click Save to retain your changes.
- Click Test Configuration to ensure the information provided is correct.
Global SNMP Configuration Settings
When you add a network device to up.time, as part of the configuration process, you must provide details about how SNMP has been configured to communicate with and manage other devices on the network. These details describe, among other things, the SNMP protocol being used, and encryption methods.
By default, SNMP-specific settings are inputted for each network-type device, as they are added to up.time. To facilitate this process, your network’s SNMP settings can defined globally in the Global Element Settings panel.
Global SNMP Settings
The following SNMP settings are used to configure network-related Elements, and can be defined globally.
SNMP Version | The SNMP version the network device and your network are using. | |
SNMP Port | The port on which network devices have been configured to listen for SNMP messages. | |
Read Community | A string that acts like a user ID or password, giving you access to the network device instance. Common read communities are “public”, enabling you to retrieve read-only information from the device, and “private”, enabling you to access all information on the device. | |
Username | The name that is required to connect to the network device. | |
Authentication Password | The password that is required to connect to the network device. | |
Authentication Method | This option determines how encrypted information travelling between the network device and up.time will be authenticated:
| |
Privacy Password | The password that will be used to encrypt information travelling between the network device and up.time. | |
Privacy Type | From the list, select an option that will determine how information travelling between the network device and up.time will be encrypted:
| |
Pingable Node | This specifies whether up.time can contact the network device using the ping utility. There are scenarios in which you might not want the network device to be pingable (e.g., you have a firewall in place). Before enabling this option, you should try to contact it using the ping utility. If you cannot ping it, ensure this check box is left cleared. Then, change the default host check for the network device. See Changing Host Checks for more information. |
Globally Defining SNMP Version 2 Settings
To globally define the SNMP version 2 settings used to communicate with network devices on your network, do the following:
- On the up.time tool bar, click Config.
- In the left panel, click Global Element Settings.
- In the SNMP Global Credentials sub panel, click Edit Configuration.
- Enter the SNMP Port on which your network devices are listening.
- Enter the Read Community used to access network devices (for example,
public
orprivate
). - Indicate whether up.time can contact the network device with the ping utility by selecting or clearing Is Node Pingable? checkbox.
- Click Save to retain your changes.
- Click Test Configuration to ensure the information provided is correct.
Globally Defining SNMP Version 3 Settings
To globally define the SNMP version 2 settings used to communicate with network devices on your network, do the following:
- On the up.time tool bar, click Config.
- In the left panel, click Global Element Settings.
- In the SNMP Global Credentials sub panel, click Edit Configuration.
- For the SNMP Version, select v3.
The configuration fields relevant to that SNMP version will appear. - Enter the SNMP Port on which your network devices are listening.
- Enter the Username used to connect to network devices.
- Optionally enter the Authentication Password required to connect to network devices.
- Indicate the Authentication Method used for encryption.
If no password is provided, the authentication method is ignored. - Optionally enter the Privacy Password used to encrypt communication between network devices and up.time .
Indicate the Privacy Type used for encryption.
If no password is provided, the authentication method is ignored.You can set both the authentication and password types, only one of them, or neither.
- Indicate whether up.time can contact the network device with the ping utility by selecting or clearing Is Node Pingable? checkbox.
- Click Save to retain your changes.
- Click Test Configuration to ensure the information provided is correct.
RSS Feed Settings
up.time displays a list of recent knowledge base articles in the My Portal panel. This list is fed to the My Portal panel via RSS (Really Simple Syndication, a method for delivering summaries of and links to Web content). Clicking the title of an article opens it in your Web browser.
By default, RSS feeds are drawn directly from the up.time Support Portal without the use of proxy server information. If your Monitoring Station accesses the Internet through one, feeds will most likely not be available, and the following message will appear in the My Portal panel:
Changing Proxy Server Information for RSS Feeds
You can manually configure the settings for RSS feeds through the following parameters (default values, if applicable, are shown):
Parameter | Description |
---|---|
rssFeedUrl | the URL of the RSS feed (for example, rssFeedUrl=http://support.uptimesoftware.com/rss/kb.xml ) |
httpProxyHost | the host name of the proxy server that the Monitoring Station uses to access the Internet |
httpProxyPort | the port through which the Monitoring Station communicates with the proxy server |
httpProxyUsername | the user name required to use the proxy server |
httpProxyPassword | the password required to use the proxy server |
VMware vCenter Orchestrator Integration
Administrators can configure Action Profiles to automatically carry out tasks in the event of an up.time alert. One such task is the initiation of contact with VMware vCenter Orchestrator, and the execution of a workflow. To have access to this functionality, up.time needs to know how to communicate with Orchestrator.
For information about Action Profiles and VMware vCenter Orchestrator, see Action Profiles
Integrating up.time with VMware vCenter Orchestrator
To configure up.time integration with Orchestrator to execute workflows, do the following:
On the up.time tool bar, click Config.
In the left panel, click VMware vCenter Orchestrator.
- In the sub panel, click Edit Configuration.
- Ensure the VMware Orchestrator Enabled check box is selected.
- In the VMware Orchestrator Server field, enter the host name of, or IP address assigned to the Orchestrator server when it was configured.
- In the VMware Orchestrator Port field, enter the port the Orchestrator server was configured to use in order to communicate with other systems.
- Optionally select the Use SSL check box if Orchestrator was configured to use an SSL certificate.
- Enter the Username and Password of an appropriate user account on the Orchestrator server.
For proper integration, an Orchestrator account with View and Execute permissions is required. - Click Save.
The configuration window closes, and you are returned to the VMware vCenter Orchestrator Configuration panel. - To ensure the settings you provided are correct, click the Test Configuration button.
The Monitoring Station will try to communicate with the VMware vCenter Orchestrator server. If an error message appears in the subpanel, edit and then re-test the configuration.
Web Application Monitor Proxy Settings
When the Web Application Transaction monitor is recording a user session on an external site, it is intercepting URLs by acting as your browser’s proxy. For the monitor to do this, you must replace your organization’s proxy server information with the Web Application Transaction monitor in your browser settings. In order for the monitor to access the Internet, you must provide your proxy settings in up.time.
This monitor-specific proxy information is used during transaction recording; during session playback, the proxy normally used by up.time (defined by the httpProxy*
settings) is used.
For more information about the Web Application Transaction monitor, see Web Application Transactions.
You can change up.time’s proxy server configuration by manually inputting settings in the up.time Configuration panel, as outlined in Modifying up.time Config Panel Settings.
Changing Proxy Server Information for up.time
You can configure the proxy server settings used by up.time when running the Web Application Transaction monitor with the following parameters:
Parameter | Description |
---|---|
webmonitor.proxyHost | the host name of the proxy server that the Web Application Transaction monitor uses to access the Internet during transaction recording |
webmonitor.proxyPort | the port through which the Web Application Transaction monitor communicates with the proxy server during transaction recording |
Remote Reporting Settings
If you are using a reporting instance (an up.time instance that only generates and serves reports), the remote reporting settings enable you to specify the location of the reporting instance, and the port on which it is listening.
Modifying the Remote Reporting Server Settings
To configure the remote reporting instance used by up.time, do the following:
- On the up.time tool bar, click Config.
- In the left panel, click Remote Reporting.
- In the sub panel, click Edit Configuration.
- Ensure the Reporting Instance Enabled check box has been selected.
- In the Remote Reporting Server field, enter the host name or IP address of the server on which the remote reporting instance is found.
- Enter the port used to communicate with the server.
- Click Save.
The edit window closes, and you are returned to the Remote Reporting Instance Configuration panel. - To test the remote reporting server configuration, click Test Configuration.
A pop-up window appears, indicating whether up.time was able to connect to the remote reporting instance. If an error message is displayed, correct your configuration and re-test it.
Note that the modification of these values is one of a series of steps performed to correctly set up a remote reporting instance. See Remote Reporting Instances for more information.
User Interface Instance Settings
A UI instance is an up.time installation that does not perform any data collection tasks, and is primarily used for real-time monitoring and report generation. When there are many up.time users who do not need to perform full administrative tasks, UI instances can divert traffic from a core Monitoring Station implementation, improving data-collection performance and UI responsiveness.
You can manually configure UI instance settings with the following uptime.conf
parameters:
Parameter | Description |
---|---|
uiOnlyInstance | enables the Monitoring Station as a user interface instance |
uiOnlyInstance.monitoringStationHost | the host name or IP address of the up.time Monitoring Station that is performing data collection, and to which this UI instance will connect |
uiOnlyInstance.monitoringStationCommandPort | the port through which the UI instance can communicate with the core data-collecting Monitoring Station; in most cases, this port should be 9996, otherwise the UI instance will not communicate properly with the core Monitoring Station |
Creating an up.time UI Instance
To create a UI instance, do the following:
- Using the standard up.time installer, install a new instance of up.time on another server.
During the install process, when prompted to provide DataStore configuration information, ensure the UI instance has the same database settings as the core Monitoring Station (see Database Settings for more information). - After installation, enable the newly installed up.time as a UI instance by editing the following
uptime.conf
parameters:uiOnlyInstance=true
uiOnlyInstance.monitoringStationHost=<hostname>
hostname
is the hostname or IP address of the core, data-collecting Monitoring Station, with which this UI instance will communicateuiOnlyInstance.monitoringStationCommandPort=9996
the port through which the UI instance can communicate with the core Monitoring StationUnless your core Monitoring Station has been customized, it is configured to use port 9996 to communicate with a UI instance. If you wish to use a different port, you must ensure matching
uptime.conf
values exist on both the UI instance and core Monitoring Station. Contact up.time Technical Support for more information.
- Ensure the proxy used by the Controller on the UI instance directs to the core Monitoring Station. By default, this proxy is configured with the assumption that the Controller and Monitoring Station are running on the same host. See Configuring the up.time Controller for more information.
- Shut down the Data Collector service on the UI instance.
- Ensure you are logged in with a domain account, and that this account has access to the
<installDirectory>/gadgets
directory on the Monitoring Station. - To accommodate sharing user-created gadgets, on the core Monitoring Station system, make the
<installDirectory>/gadgets
directory accessible by the UI instance system.
How you make the/gadgets
directory accessible depends on the Monitoring Station platform:- On Linux, you can use NFS to share the directory on the core Monitoring Station, then mount it on the UI instance
- On Windows, you can use the
mklink
command to create a symbolic link on the UI instance that points to the/gadgets
directory on the core Monitoring Station, such as in the following example:mklink /D "C:\Program Files\uptime software\uptime\gadgets" "\\host\gadgets
"
You will most likely need to modify sharing and security permissions for the directory.
- Restart the Data Collector service on the UI instance.
Scrutinizer Settings
Scrutinizer is a NetFlow analyzer that can be installed to monitor network traffic managed by compatible switches and routers. Scrutinizer can be integrated with up.time as a NetFlow dashboard, and can directly link network devices monitored by Scrutinizer to their NetFlow data from each Element's Graphing tab. In order to access Scrutinizer, up.time needs to be pointed to your installation.
Modifying the Scrutinizer Settings
You can configure Scrutinizer’s integration with up.time through the following parameters:
Parameter | Description |
---|---|
netflow.enabled | determines whether Scrutinizer is integrated with the Monitoring Station |
netflow.hostname | the host name or IP address of your Scrutinizer installation |
netflow.port | the HTTP port through which Scrutinizer sends and receives communication |
netflow.username | the username required to log in to Scrutinizer |
netflow.password | the password required to log in to Scrutinizer |
Splunk Settings
Splunk is a third-party search engine that indexes log files and data from the devices, servers, and applications in your network. Using Splunk, you can quickly analyze your logs to pinpoint problems on a server or in a network, or ensure that you are in compliance with a regulatory mandate or Service Level Agreements. You install Splunk on a server in your datacenter.
When values are provided for the Splunk settings listed below, the Splunk icon will appear in the My Portal panel beside the names of services that are in WARN or CRIT states. When you click the Splunk icon, you will be automatically logged in to your Splunk search page.
You can change your up.time-Splunk integration by manually inputting settings in the up.time Configuration panel, as outlined in Modifying up.time Config Panel Settings.
Changing Splunk Server Information for up.time
You can enable automatic login to the Splunk search page, or modify an existing configuration through the following parameters:
Parameter | Description |
---|---|
splunk.url | the URL of the server on which your Splunk search page is hosted (for example, http://webportal:8000 ) |
splunk.username | the username required to log in to your Splunk search page |
splunk.password | the password required to log in to your Splunk search page |
splunk.soapurl | the URL that points to the SOAP management port that Splunk uses to communicate with the splunk daemon (for example, https://webportal:8089 ).In the URL, you must include the port on which the Splunk server listens for requests. See the Splunk Admin Manual for more information. |