Page tree
Skip to end of metadata
Go to start of metadata

PROT-DASH USER GUIDE

This guide will show the main screens of of Prot-dash and some examples on how using it.

If you have some doubts or concerns, please feel free to send an email to: apbautista@gmv.com

HOME SCREEN

In this screen you will be presented with 4 hardcoded Widgets:

  • Alerts per source: Stacked graph of number of alerts per source per hour over the last 7 days
  • Source status: Table with following columns: alert source, time and date of last report seen, number of reports in last five minutes
  • Alerts per partner: Stacked graph of number of alerts per partner per hour over the last 7 days
  • Alerts per category: Stacked graph of number of alerts per category per hour over the last 7 days

These graphs are refreshed every time that you refresh your browser screen or every time that you go to the home screen.

ALERTS SCREEN

In this screen you will have to fill in a form in order to get a Table with your results. In this form, there are two params that always must be the same:

  • Databases: mentat
  • Tables: alerts_dates
  • Limit: Indicates the number of results that you want to see.

All the other fields can be filled as you want depending on what results are you looking for.

STATISTICS SCREEN

In this screen you will be able to generate custom graphs and save or load them. In order to do that you will need to follow the steps described below:

The first thing to do is to select a View Provider, in this dropdown you will be presented a number of options. In this guide we will describe the 2 main View Providers.

Chart JS (Multiple)

If you select this View Provider and click Add widget, a blank widget will appear in the page. Now if you click on the wrench icon 3 options will appear:

 

 

 

 

 

  • View: To Maximize the Widget
  • Edit: To edit the configuration of the Widget
  • Remove: Destroys the Widget. This action can't be undone.




  • You can drag the bottom right corner of the Widget to make it bigger

 

Now, to configure the Widget, click on Edit.

Here you will be presented 3 Tabs with different options:

  • General Tab
    • Title: Change this to set the title of the Widget.
    • Data Provider: Select Neon Framework.
    • Mapping Provider: It will be automatically set.

  • View Provider Tab
    • Select chart type: Here you can select the type of the graph you want, bar chart, pie chart, etc.

  • Data Provider Tab
    • Databases: Select mentat
    • Tables: Select alerts_dates

    • Select Multiple Query Fields: select the fields to be displayed, if any field selected the agregation option is dissabled.

    • Limit: Indicates the number of results that you want to see.

      All the other fields can be filled in depending on your requirements.
    • HINT! If you want for example a Category count, in Aggregation section you have to put the following:
      • Agg. Operation: COUNT
      • Field: _id
      • Group By: Category
        This will count all the event IDs and group them by Category. 

 

Once the query is done, you can go to the View Provider Tab and change the type of graph as you want.

When you finish, click on Statistics on the left menu to return to the Statistics Screen.

 

Plotly Timeline

As before, if you select this View Provider and click Add widget, a blank widget will appear in the page. Now if you click on the wrench icon and on Edit, there will be 2 available Tabs:

  • General Tab
    • Title: Change this to set the title of the Widget.
    • Data Provider: Select Neon Time Series Framework.
    • Mapping Provider: It will be automatically set.

  • Data Provider Tab
    • Databases: Select mentat
    • Tables: Select alerts_dates
    • Date field: Date field used in the "x" axis of the graph.
    • Date Granularity: group the results by hour,month, etc.
    • Aggregation: Allows to create stacked an stacked graph. For example if you select Category you will have a Time Series graph grouped by category.
    • EWMA Trend: specify the value for the alpha parameter to compute the trend. It must be a value between 0 and 1. If the event value is bigger than 30 and is 3 times bigger than the value computed for the algorithm a dropdown with the alerts will be shown just above the graph.
    • Limit: Indicates the number of results that you want to see.
      All the other fields can be filled in depending on your requirements.

Saving / Loading current layout

Once you finish creating all the Widgets, you can persist the current state of the Statistics Screen. In order to do that just click on Save Config button. This will save all your widgets and their configurations.

The next time that you enter in Prot-dash or you refresh the page you will see that Statistics Screen is empty. So, if you persisted the config before, click on Load Config button and your saved widgets will appear.

 

PLOTLY USER GUIDE

Plotly provides a lot of features to modify the displayed graph. when you hover over the graph a set of tools will appear on the top right corner.

  • Download plot: Downloads the plot as .png image.
  • Zoom tool: Allows to select parts of the graph to zoom in. 
    • If you click and drag only vertically you will zoom in the "y" axis:
                                                 ORIGINAL                                                                                                                                                      ZOOMED
                               
    • If you click and drag only horizontally you will zoom the "x" axis: 
                                                 ORIGINAL                                                                                                                                                       ZOOMED
                               
    • If you click making a square, you will zoom in the selected area:
                                                ORIGINAL                                                                                                                                                        ZOOMED
                               

  • Pan: It allows to navigate trough the graph by dragging on it.
  • Box select: highlights only the selected area of the graph.
  • Zoom in/out:  Zooms in or zooms out all the graph.
  • Autoscale: Probably one of the most important features. It allows to resize the graph, it undoes all the zoomings and also adapts the graph to the current widget size. Useful when switching from the Widget configuration to Statistics screen or when entering in View mode of the Widget.
  • Toogle spike Lines: Shows a line to x and y axes when hovering over a bar.
  • Show closest data:  When this is selected, when hovering over a stacked bar, in the tooltip that appears, you will only see the current group.
  • Compare data: When this is selected, when hovering over a stacked bar, in the tooltip that appears, you will see all the groups of the bar.

SHOWING META-ALERTS

We can use ProtDash in order to see the generated meta-alerts.

  1. Go to Statistics screen
  2. Select "Basic Table" on the dropdown and click on add Widget.
  3. Now click on the wrench icon and on Edit:
    General Tab
    • Title: Change this to set the title of the Widget.
    • Data Provider: Select Neon Framework.
    • Mapping Provider: It will be automatically set.
    Data Provider Tab
    • Databases: Select mentat
    • Tables: Select meta_alerts
  4. Select the fields that you want to see in the resulting table or set up the aggregation fields to group the results.
  5. Click on Send Query.

Below you can find two configuration examples to see meta-alerts:

  1. In this case, we are grouping by MACategory and doing a count of them.

And the result will be: 

Finally, in the next example we only select to show the fields DetectTime, MAQuality and Source

Then, the result will be: 

 

  • No labels