Working with Monitors

Create and configure monitors

The monitoring feature enables Webscale to track potential problems or system changes. Monitors generate events when they detect activity that matches or exceeds conditions that you define. They can send email notifications when these events occur.

For example, you can create monitors that notify you about website security violations or when the data transfer for outbound traffic exceeds a threshold.

The monitor type determines the activities that monitors can track.

  • data-transfer-billing: Monitors data transfer for all account applications
  • logs: Monitors traffic logs for specified applications
  • data-plane: Monitors particular data plane attributes for changes

When adding or editing a monitor, shared and type-specific settings become visible after selecting a type.

Monitors page list

Topics

Shared monitor settings

All monitor types share the following settings.

  • Type: Specifies monitor type
  • Name: Identifies the monitor
  • Description: Provides a short description of the monitor’s purpose
  • Log events: Enables adding events that match monitor conditions to the event logs
  • Notify: Enables sending notifications when events that the monitor tracks occur
  • Message: Enables customizing the notification message

The Type and Name settings are required. The remaining settings are optional.

Specify Splunk On-Call notification

Notification messages

Message section

The Messages section enables you to create email notification messages. For some monitors, you can choose to create notifications that indicate potential problems. (A monitor will trigger when thresholds that you have defined are met or exceeded.) Webscale will send recovery messages when the monitor no longer detects potential threat conditions.

When creating messages. You can:

  • Type a message in the Edit tab that Webscale sends for all circumstances
  • Define dynamic messages that change according to the situation

Dynamic messages

Dynamic messages use variables that reference specific values from your Webscale account. The available variables are visible in the Context tab.

Message section

In the Message section:

  • Edit tab: Displays a sample message that demonstrates how to use the context variables. You can modify or replace this sample message.
  • Context tab: Displays the available variables for the message
  • Preview tab: Displays a rendered version of the message
  • Message type option menu: Specifies if the message is an alert or recovery notification. Displays when you select the Context tab.

When you create dynamic messages, Webscale uses Liquid templates to reformat your message into Markdown. Liquid then reformats it from Markdown into HTML for the email message.

A Liquid template also defines the message format. You can switch to another Liquid template to change the message appearance through Liquid. Created by Shopify, Liquid is an open-source template language for web applications. For more information about how to use Liquid, see the Liquid documentation.

Illustrated example

Monitor dynamic messages illustration

The above graphic illustrates how you can compose two sentences of a message, using variables from the Context tab. The Preview tab displays how they will render. The Alerting logs condition option menu selection determines that the message is an alert.

In the scenarios for the graphic, the boxes with the colored borders show how a variable can be used and rendered.

Data transfer monitor

The data transfer monitor is present by default and always lists on the Monitors page. It tracks data transfer usage for all account applications. It is the only monitor with the data-transfer-billing type. While you can edit this monitor, you cannot delete it.

The information that the data transfer monitor collects provides the content for the Data Transfer report.

Logs monitor

You can view your site’s activity in near real-time through Traffic Viewer, which uses Webscale traffic logs information. These logs document the activity for each application.

You can configure monitors for each of the following logs types.

  • CDN
  • CSP (Content Security Policy)
  • Pageview
  • Proxy

Through CDN and Proxy logs, you can view the activities that your site’s CDN and application generate. Pageview logs can provide insight into your user experience. CSP reports inform you of violations of your site’s security policy.

Data plane monitor

The data plane monitor lets you know when changes have been made to a particular attribute of the data plane being monitored.

You can use Monitors page to perform the following operations.

Data planes

Data planes are sets of proxies that service all of your application traffic. They sit between your application and the internet, functioning as reverse proxies. Data planes can perform many functions, such as load balancing, protecting your application, and caching.

Each application is connected to a data plane. Your account can have multiple data planes. Multiple applications can share a single data plane.

IP addressing

Data planes enable you to manage proxies. Each proxy must have a public IP address. The cloud provider for the data plane, such as AWS, Azure, or Google Cloud Platform, allocates IP addresses for new proxies. When you create or edit a data plane, you can choose the method for assigning IP addresses.

One option is to use a pool of pre-allocated static IP addresses that the provider generates. When Webscale creates proxies for a data plane, it assigns IP addresses from the pool. For deleted proxies, Webscale returns the pre-allocated static IP address to the pool. It can then reassign the static IP address to new proxies.

Another method is for Webscale to allocate a new public IP address when it creates the proxy. The IP address does not belong to a pre-allocated pool. When Webscale deletes a proxy, the address will be released.

Data plane monitors and static IPs

Data plane monitors track changes to a specified attribute of a data plane.

The static_ips attribute enables the monitor to record a change to the static IP address set. Depending on the monitor configuration, the monitor can send a notification when a change occurs. For example, a monitor will trigger when static IP addresses are added to a data plane due to an increase in its maximum size.

You can create monitors and choose the static_ips attribute for data planes that do not have the static IP addressing feature enabled. These monitors track changes to this attribute for specified data planes. If you enable this feature for an existing data plane, Webscale will add the data plane’s existing IP addresses to its static IP address pool. The monitor will register the change. If you have entered an email address or VictorOps information, Webscale will then send a notification.

Create data plane monitors

You can create multiple data plane monitors. For instance, you might create a monitor for each of your data planes if you have more than one data plane. Or, you could create multiple monitors for one data plane with different recipients and messages for each monitor.

The Context tab of the Message section of the Create monitor dialog box contains some variables that are specific to the data plane monitor.

Create data plane monitor

To create a data plane monitor

  1. On the Webscale Control Panel page, click the menu icon on the upper left of the screen.
  2. On the sidebar menu, select Monitors.
  3. In the Monitors page, click Create monitor.
  4. In the Create monitor dialog box, select the object-data-plane monitor type.
  5. Enter a monitor name.
  6. Optionally, enter a description for the monitor.
  7. To disable logging events that match monitor conditions, toggle the Log events switch to off.
  8. Specify the data plane to monitor by selecting it from the Data plane drop-down menu.
  9. Specify the attribute to monitor from the Attribute drop-down menu.
  10. Optionally, specify the notification recipients in the Notify section:

To send email notifications, make sure that the mailto option is selected in the drop-down menu and enter one or more email addresses. Click Add.

-or-

To use the Splunk On-Call third-party notification system, select victorops and enter the api and routing keys. Click Add.

  1. Define your message in the Message section.
  2. Click Save.

Edit data plane monitors

You can edit the details for a data plane monitor.

To edit a data plane monitor

  1. On the Monitors page list, select the monitor.

  2. Click the edit icon that displays for it.

    Select edit icon for a data plane monitor
  3. In the Edit Monitor dialog box, modify the monitor settings.

    Edit data plane monitor dialog box

  4. Click Save.

Delete data plane monitors

You can delete data plane monitors. If you plan to delete a data plane, you must delete any monitors for it before you can delete it.

To delete a data plane monitor

  1. On the Monitors page list, select the monitor.

  2. Click the Delete file icon that displays for it.

    Select delete icon for a data plane monitor
  3. Click Ok in the confirmation box.

    Delete data plane monitor confirmation box

Further reading

Have questions not answered here? Please Contact Support to get more help.


Last modified July 16, 2020