Web interface

Dashboard tab

The Dashboard tab provides real time visualization of the overall operations of the Replicator. Information, such as total packets inbound, packets outbound, bits inbound, and bits outbound, is provided in the gauge charts and live trends (line graphs) displaying the last 20 data points of traffic. The time span of each trend will vary depending on the overall refresh rate of the live data.

Below the trends is a summary of total exporters, collectors, exporter/collector pairs, profiles, and last sample of traffic totals.

Streams Tab

The streams tab provides real time status of exporters sending packets to the Replicator. The streams that stopped will highlight in red. The user can summarize all stopped streams by checking the alarm only box. A filter box is provided to quickly narrow the list down based on a keyword match.

Clicking on the DNS Name globe button prompts the Replicator to attempt resolving the name of the exporter.

Additional details such as Last Status check, current status, and traffic details are displayed.

Exporters tab

The Exporters tab provides details related to the devices sending packets to the Replicator. If there are any alarm conditions detected, the total number of alerts will be highlighted by the Exporter tab.

There are two sub tabs: Exporters in profiles and Exporters not in a profile.

Exporters in profiles

Any exporter that is in an alarm state is highlighted in red. The total number of exporters in profiles with alarms are highlighted beside the sub tab. The same checkbox and filter is available on each tab to quickly find the desired exporter(s).

Exporters not in a profile

The sub tab includes the incomin streams from exporters that are currently not associated with a profile. It helps quickly find andconfigure streams that are not replicated to any collectors. Exporters highlighted in red indicate a stream that was previously known has stopped. The user can click the globe button to attempt to resolve the DNS name of the exporter. Clicking the + button will open a dialog box to select a profile to associate this stream with. To remove an exporter from a profile, use the - link. The eye icon will display the configuration of the profile associated with the selected exporter.

Additional details such as packets and bits received are also displayed.

Collector tab

The collector tab displays real time data associated with collectors. The number beside the tab represents the number of collectors in an alarm state.

Any row highlighted in red indicates an issue with that collector. To manage collectors, use the following options:

  • [-] the collector from all the profile;
  • [note] add description or a note to a collector;
  • [globe] attempt resolving the DNS name;
  • [gauge] set a threshold to alarm if a certain packet rate is exceeded;
  • [circle] acknowledge an alarm;
  • [+] add a collector to a profile;
  • [-] remove a collector from a profile;
  • [eye] view a profile associated with the alarm.

Profiles tab

Profiles define how packets come in and go out of the Replicator. The profiles tab lists all configured profiles and their current state. The number beside the tab represents the number of profiles in an alarm state.

Real time data such as inbound and outbound traffic is shown as well as total policies, exporters, and collectors. Profiles highlighted in red indicate an issue with the policy. [edit] a policy will provide details on why that policy is in an alarm state.

The following actions are available from the profile tab:

  • [-] remove the profile which will stop packets to the collectors configured for the defined exporter streams;
  • [pencil] edit the current profile;
  • [+] add a new profile.

Creating a new Profile

Clicking the plus button will launch the new profile wizard. A profile consists of a name, an In Port, and an Out Port. These are the UDP ports which will define what ports Replicator will be listening on and send packet traffic to.

In most cases, users want to replicate traffic from any exporter sending packets on the in port. Otherwise, users can uncheck the match all box and specify a network and CIDR (e.g. 192.168.2.0/24) to match a certain set of exporters.

Multiple policies can be later added to a profile. See the next section for more information.

After the configuration has been completed, click save.

Editing a Profile

Clicking the pencil button next to a profile will display its current configuration, such as a name, description, real time data, policies, exporters, and collector.

Important

Profiles are not considered complete until there are at least one exporter and one

collector configured.

From this interface the following actions are available:

  • [<-] returns the user to the list of profiles
  • [+] launches the new profile wizard
  • [-] permanently removes the profile
  • [note] add description or a note
  • [pencil] launches the edit profile modal to modify the name, the in port, and out port, or the description modal to modify the description of the profile
  • [+ policy] launches the add policy modal
  • [+ exporter] launches the add exporter modal
  • [+ collector] launches the add collector modal
  • [-] removes the policy, exporter, or collector depending on which one is selected.

Settings tab

The Settings tab is where users can modify the configuration of the Replicator. Certain features can be enabled and disabled by checking or unchecking the enabled checkbox in the setting column. The settings column also contains the current value of the option. The description column explains what the option does.

If the user enters an invalid value, the Replicator will provide feedback informing the user what entry values should be.

Server health LED

The Server health LED lists the state of all services and profiles and provides a status of each. It is a high level view of the health of the Replicator processes.