USB Presenter Capture: Difference between revisions
No edit summary |
Tom.Wegener (talk | contribs) (describe the time after configuration option.) |
||
(11 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
This page describes how the Allegro Network Multimeter allows a user to start a capture with a USB presenter. This capture can be actioned 'Back in Time' for a defined period | This page describes how the Allegro Network Multimeter allows a user to start a capture with a USB presenter. This capture can be actioned 'Back in Time' for a defined period. | ||
This feature has been designed to allow non-IT staff to record pcaps when an error occurs; it also allows for captures without opening a Web interface. | In addition, the capture files can be uploaded to an SFTP server at a defined time. | ||
This feature has been designed to allow non-IT staff to record/initiate pcaps when an error occurs; it also allows for captures without opening a Web interface. | |||
<br><br> | |||
== Use case example == | |||
An IT or VoIP service provider needs to troubleshoot intermittent issues at a (residential) customer. | |||
The service provider is limited by time, resources and packet capture/data collection constraints (AVG, GDPR). | |||
With the Allegro Network Multimeter "USB Capture trigger" functionality, a "fool proof" remote control is handed to the customer, with the instruction to press any button when the issue arrises. | |||
A simple button press on the remote, will initiate a pre-configured capture (filter + duration) around the time of the "incident", e.g. from 60s before until 60s after the "incident". | |||
As only packets around an issue are being recorded and saved as a pcap, the service provider needs not sift through huge amounts of data for root-cause analysis. | |||
Also, there are little to no privacy implications, since the capture was end-customer initiated, pre-filtered and limited to short time-intervals only. | |||
<br><br> | |||
== Requirements == | == Requirements == | ||
This feature is supported by all Allegro Network Multimeters | This feature is supported by all Allegro Network Multimeters (also VM) from firmware release V3.0. | ||
As of now, the '''Logitech R400''' is supported. Allegro will add more presenters on request. An optional USB sound device will play a beep when a key has been pressed. | |||
It requires a free USB 2.0 (or higher) port on the Allegro Network Multimeter. An internal or external disk needs to be configured at '''Generic''' → '''Storage,''' and a [[Packet ring buffer|ring buffer]] must be configured. | |||
Please note that the capture initiated by this feature is extracted from the ring buffer, and ring buffer filter rules for packet slicing will affect exported pcaps. | |||
<br><br> | |||
== USB Capture Trigger Setup == | == USB Capture Trigger Setup == | ||
Connect the Logitech R400 USB dongle | Connect the Logitech R400 USB dongle to the Allegro Network Multimeter. If you have a Allegro Virtual Edition, please pass-through the USB device directly to the Allegro VM. | ||
Once this is done, navigate to the '''Settings''' -> '''Expert settings''' page and open the '''USB capture trigger'''. | Once this is done, navigate to the '''Settings''' -> '''Expert settings''' page and open the '''USB capture trigger'''. | ||
<br><br> | |||
[[File:Presenter dialog.png|600px]] | |||
Whenever a key on the presenter is pressed, a pcap will be generated. | |||
NOTE! - The pcap end-time, is when the button on the presenter is pressed and the start time is defined by the capture interval. | |||
This means, that a configured interval of 60 seconds, will generate a capture (pcap) of the full 60 seconds '''prior''' to when a presenter key was pressed. | |||
Captures are stored in the root directory of the storage partition or, if enabled, in the upload directory (cue) for periodic/automated SFTP uploads. | |||
<br> | |||
With version 4.2 it is possible to configure the time that will be recorded before and after the button is pressed instead of just the time before.<br> | |||
== SFTP Export Setup == | == SFTP Export Setup == | ||
The Allegro can automatically upload pcap files to an SFTP server from the upload directory on the disk. To configure it, please navigate to '''Settings''' → '''Remote Access and Export''' → '''Pcap export via SFTP''' | The Allegro Network Multimeter can automatically upload pcap files to an SFTP server from the upload directory on the disk. | ||
To configure it, please navigate to '''Settings''' → '''Remote Access and Export''' → '''Pcap export via SFTP'''. | |||
This allow to export all captured pcap files at a certain time of day. As example it can be used to transfer pcaps during the night from remote locations to a central SFTP server. | |||
<br><br> | |||
[[File:Sftp export.png|1000px]] | [[File:Sftp export.png|1000px]] | ||
<br> | |||
== Advanced Multi-pcap Setup == | == Advanced Multi-pcap Setup == | ||
There are situations where the Allegro | There are situations where the Allegro Network Multimeter may be configured to record multiple separate pcaps, each with specific filters, with only one button-press on the usb-presenter. | ||
This can be done by enabling the '''USB capture filter''' in the '''USB capture trigger''' dialog. Filter syntaxes are described in the [[Capture module]]. | |||
A good example is the installation of an Allegro 500 with 2 links and 2 virtual link groups ( see [[Virtual Link Group Configuration Guide]]), one before and one behind the firewall. | A good example is the installation of an Allegro 500 with 2 links and 2 virtual link groups ( see [[Virtual Link Group Configuration Guide]]), one before and one behind the firewall. | ||
<br><br> | |||
[[File:Presenter filter group.png|600px]] | [[File:Presenter filter group.png|600px]] | ||
As a second example, you can record pcaps of up to 4 different IP addresses at the same time with just one click. | |||
<br><br> | |||
[[File:Presenter filter ip.png|600px]] | [[File:Presenter filter ip.png|600px]] |
Latest revision as of 12:09, 2 November 2023
This page describes how the Allegro Network Multimeter allows a user to start a capture with a USB presenter. This capture can be actioned 'Back in Time' for a defined period.
In addition, the capture files can be uploaded to an SFTP server at a defined time.
This feature has been designed to allow non-IT staff to record/initiate pcaps when an error occurs; it also allows for captures without opening a Web interface.
Use case example
An IT or VoIP service provider needs to troubleshoot intermittent issues at a (residential) customer.
The service provider is limited by time, resources and packet capture/data collection constraints (AVG, GDPR).
With the Allegro Network Multimeter "USB Capture trigger" functionality, a "fool proof" remote control is handed to the customer, with the instruction to press any button when the issue arrises.
A simple button press on the remote, will initiate a pre-configured capture (filter + duration) around the time of the "incident", e.g. from 60s before until 60s after the "incident".
As only packets around an issue are being recorded and saved as a pcap, the service provider needs not sift through huge amounts of data for root-cause analysis.
Also, there are little to no privacy implications, since the capture was end-customer initiated, pre-filtered and limited to short time-intervals only.
Requirements
This feature is supported by all Allegro Network Multimeters (also VM) from firmware release V3.0.
As of now, the Logitech R400 is supported. Allegro will add more presenters on request. An optional USB sound device will play a beep when a key has been pressed.
It requires a free USB 2.0 (or higher) port on the Allegro Network Multimeter. An internal or external disk needs to be configured at Generic → Storage, and a ring buffer must be configured.
Please note that the capture initiated by this feature is extracted from the ring buffer, and ring buffer filter rules for packet slicing will affect exported pcaps.
USB Capture Trigger Setup
Connect the Logitech R400 USB dongle to the Allegro Network Multimeter. If you have a Allegro Virtual Edition, please pass-through the USB device directly to the Allegro VM.
Once this is done, navigate to the Settings -> Expert settings page and open the USB capture trigger.
Whenever a key on the presenter is pressed, a pcap will be generated.
NOTE! - The pcap end-time, is when the button on the presenter is pressed and the start time is defined by the capture interval.
This means, that a configured interval of 60 seconds, will generate a capture (pcap) of the full 60 seconds prior to when a presenter key was pressed.
Captures are stored in the root directory of the storage partition or, if enabled, in the upload directory (cue) for periodic/automated SFTP uploads.
With version 4.2 it is possible to configure the time that will be recorded before and after the button is pressed instead of just the time before.
SFTP Export Setup
The Allegro Network Multimeter can automatically upload pcap files to an SFTP server from the upload directory on the disk.
To configure it, please navigate to Settings → Remote Access and Export → Pcap export via SFTP.
This allow to export all captured pcap files at a certain time of day. As example it can be used to transfer pcaps during the night from remote locations to a central SFTP server.
Advanced Multi-pcap Setup
There are situations where the Allegro Network Multimeter may be configured to record multiple separate pcaps, each with specific filters, with only one button-press on the usb-presenter.
This can be done by enabling the USB capture filter in the USB capture trigger dialog. Filter syntaxes are described in the Capture module.
A good example is the installation of an Allegro 500 with 2 links and 2 virtual link groups ( see Virtual Link Group Configuration Guide), one before and one behind the firewall.
As a second example, you can record pcaps of up to 4 different IP addresses at the same time with just one click.