Last modified on January 12, 2018

ServerAgent is a component of Private Node Server that monitors the location health and resource usage. If your private location misses a scheduled monitor run, or if it stops communicating with AlertSite, an alert will be sent to the selected recipients.

ServerAgent is not enabled by default, you need to configure it manually. This guide explains how you can do this.

Note: Currently, you can view the ServerAgent status and reports only in AlertSite 1.0 (the classic interface). You cannot view them in AlertSite. However, alerts will come anyway.

Plan Availability

Before you begin, verify that you have an available (free of charge) plan that lets you use ServerAgent on your private nodes:

  • In AlertSite UXM, select  > Plan Details from the top menu.

  • You should see the ServerAgent 5 w/ InSite plan in the list.

    'ServerAgent 5 w/ InSite' plan

Customer Support or your AlertSite Sales Representative immediately.

Generating a Monitor ID for ServerAgent

Once the ServerAgent plan is in place, you can configure ServerAgent to monitor your Private Node Server. First, you need to generate a Device (Monitor) ID in the AlertSite console:

  1. In AlertSite UXM, select  > AlertSite 1.0 from the top menu to switch to the classic interface.

  2. Go to Configuration > ServerAgents.

  3. Click Add a New ServerAgent.

    Add a New ServerAgent
  4. Enter your ServerAgent parameters:

    • Site Name – a name for ServerAgent that will be displayed in AlertSite dashboards and reports.

    • Site Plan – select the Server Agent 5 w/ InSite plan. If you do not see the plan, contact your AlertSite Sales representative.

    • Monitoring Is – set to Enabled.

    • Notify on Error? – set to Yes. You will receive alerts when ServerAgent detects a problem with your Private Node Server.

    • Reporting Interval – specify how often (in minutes) ServerAgent should check in with AlertSite to report results and indicate that it is up and running. If ServerAgent has not reported in at the expected interval, a 4050 - server not responding error occurs.

    ServerAgent name and parameters
  5. Click Submit in the top right corner.

  6. This will generate a Device ID for your ServerAgent.

    ServerAgent Device ID
  7. Copy this value somewhere – you will need it later.

Selecting a Location to Receive Data

ServerAgent does not send data directly to the AlertSite platform. It sends it to one of AlertSite global monitoring locations, and from there, the data gets to AlertSite. The location is selected automatically on the previous step, but you can change it. Note that if your Private Node Server is behind a firewall, you must allow outgoing communication to this location through port 4892 (see Network Connectivity).

To view or change the location to which ServerAgent sends data:

  • In AlertSite 1.0, on the ServerAgent configuration page, click Locations in the top right corner.

    View or change ServerAgent reporting location
  • Note down the first location in the list – it is marked as Primary.

    ServerAgent reporting location
  • (Optional.) If you want to change the location, select the radio button next to another location and click Submit.

    Note: If you are a Usage-Based Monitoring customer and you select a location outside the United States, Canada or Europe, you will consume additional measurement credits for each ServerAgent check.

  • To find the secondary location:

    • Go to Reports > Performance Reports.

    • Select your ServerAgent in the list.

    • Note down the secondary location that is displayed.

    Note: The secondary location is assigned automatically and cannot be changed.

  • On the Monitoring Locations - IP Addresses page, find these locations and note down all of their IP addresses.

  • Configure your firewall to allow outgoing traffic on port 4892 to all the IPs listed.

Note that if you change the location at any time later, you will have to update the firewall rules to allow connections to the new location.

Registering & Starting ServerAgent on Private Node Server

  1. Navigate to https://<IP address>, where <IP address> is the IP address of your Private Node Server.

  2. Go to ServerAgent > Register ServerAgent.

  3. Enter the Device (Monitor) ID that you copied from AlertSite earlier and click Register.

    Registering ServerAgent
  4. After ServerAgent is registered successfully, click the link to start it.

    Start ServerAgent
  5. After a few minutes, the ServerAgent information in AlertSite will update to include the configuration section at the bottom of the page.

    Agent Configuration table
  6. On this page, switch to the User Scripts tab.

  7. Select the Enable User Scripts Monitor check box.

  8. Make the following changes in the first (blank) line:

    • Select the Enabled and Notify check boxes.

    • Enter lastsend.sh in the Name column.

    • Change the Compare operator to > or >=.

    • Change Warning Value to 15.

    • Change Threshold Value to 20.

    This means that ServerAgent will report a warning condition if your Private Node Server has not reported to AlertSite for 15 minutes, and an error condition if has not reported for 20 minutes or more.

    User Scripts
    Note: You may use different Warning and Threshold values, but do not make them lower than 20 minutes + the shortest run interval of monitors on your private node. Also, note that if your shortest run interval is 10 minutes, the data may not be sent until the next 10-minute check.
  9. Click Submit in the top right corner.

ServerAgent starts working immediately. There is no need to reboot Private Node Server, and there is no loss of monitoring.

Note: You may receive one or two alerts initially while the system syncs up the connection to ServerAgent

Viewing the ServerAgent Status

You can see the most recently reported status of your ServerAgents on the Status > ServerAgents screen in AlertSite 1.0 (the classic interface).

ServerAgent Status

To view historical data, you can run the ServerAgent Detail report in Reports > Performance Reports. Note that the report is limited to one week of data.

ServerAgent Status Codes

The following status codes are returned for problems detected by ServerAgent:

Status Code Description
4050 Server is not responding (see Troubleshooting below).
4040 Error threshold exceeded.
4030 Warning threshold exceeded.

Alerting

ServerAgent sends alerts to warn you about potential issues with your Private Node Server. These alerts are similar to monitor alerts, but use the status codes mentioned above.

To receive alerts, you need to have alert recipients configured.

Note that by default, ServerAgent sends alerts to all the recipients configured in your AlertSite account. To limit the number of recipients, create a recipient group for ServerAgent.

Troubleshooting

Testing Connection Through Port 4892

ServerAgent sends outgoing performance data through port 4892.

In Private Node Server 2.0.2 and later:

  1. Open the Control Panel (web interface) of your private node by navigating to https://<IP address>, where <IP address> is that of your private node.

  2. From the top menu, select Diagnostics > Connection Tests.

  3. Wait until the results are displayed. ServerAgent test results are displayed at the end of the table.

In earlier versions:

  1. Find which AlertSite locations your ServerAgent sends data to (see above). There are two locations, primary and secondary.

  2. On the Monitoring Locations - IP Addresses page, find all the IP addresses for these locations.

  3. Open the Control Panel (web interface) of your private node by navigating to https://<IP address>, where <IP address> is that of your private node.

  4. From the top menu, select Diagnostics > Diagnostic Tests.

  5. Run a Traceroute to ip_address 4892, replacing ip_address with one of the AlertSite location IP addresses from step 2.

  6. The traceroute results appear in a new window. Verify that the connection goes past your firewall.

  7. Repeat the test for the other IP addresses of that location.

If there are connection problems, make sure your firewall allows traffic from the private node to the specified ServerAgent hosts through port 4892. You can also try restarting the private node or the ServerAgent.

Restarting ServerAgent

Sometimes, restarting ServerAgent may solve connection problems. To restart ServerAgent:

  • Navigate to https://<InSite IP address>, where <InSite IP address> is the IP address of your Private Node Server.

  • Go to ServerAgent > Start/Stop ServerAgent and click Stop.

  • Go to ServerAgent > Start/Stop ServerAgent again and click Start.

Note that restarting the private node itself will also restart the ServerAgent.

See Also

Private Locations
Registering a Private Location in AlertSite
Configuring Private Node Server on Your Network