Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation
Guide That Contains This Content
[+] Expand All
[-] Collapse All
     

    Related Documentation

     

    User Collected Data Report

    The User Collected Data Report can be generated automatically through the Task Manager, User-Defined SNMP Collection task, as explained in User-Defined SNMP Collection.

    Alternatively, the admin user can create IP/MPLSView reports based on other user collected data, as long as it is processed into IP/MPLSView’s report directory structure. For information on this report directory structure, see Adding a User Collected Data Report.

    Note: This feature requires a license. Please contact your Juniper representative for more details on this feature.


    Web Report Generated from User-Defined SNMP Collection Task


    1. After collecting successive intervals via the User-Defined SNMP Collection task, the generated web report can be viewed from Reports > User Collected Data Report. The Report Name configured in the task should be displayed in the list of available reports.

      Figure 1: User Collected Data Report

      User Collected Data Report
    2. Select Details to see the configuration options that were used to generate this report. Figure 2 shows an example of the report details and configuration options.

      Figure 2: Report Details

      Report Details
    3. Each Report is configured with the following settings:
      • Report Name is the title of the report. REQUIRED.
      • Data dir is the path of the report. Use only the /reportname path. REQUIRED.
      • Data file extension specifies to use only the files with matching extension name entered. If no extension name is entered, then all files are used. Example, report directory contains traffic.cisco and traffic.juniper files, data file extension entered is juniper, then only traffic.juniper will be used in the report.
      • Use file name as key for Column1 sets the filename as the keyword for Column1. The first keyword in the data file then becomes Column2, the second keyword Column3 and so forth. One example of using this option can be when filenames are organized by router name.
      • Calculate Util uses the util integer in the file and calculates Util% using formula 100/util. The field entry is to name the ColumnUtil.
      • Data Interval sets the time interval between the sequence of data values.
      • Show Delta displays the difference in data values by subtracting the previous value. If the difference is negative or if there is no previous value, no value is displayed. This option is primarily used when the data value is based on a counter that increments such as traffic values reported by a router.
      • Calculate Rate divides the data value by the unit of measure chosen in the bytes per sec option.
      • Unit sets the unit of measure for the data values.
      • User Administration: Check for Regional Router Filtering applies regional views to the marked Column# and viewers of the report will only be able to see the data row if they belong to that region. Regional groups are organized by router names so only a Column# using the router name as the keyword can be applied. Regional groups and user assignments are setup in the User Administration module.
      • Column field is an entry to set the Column header name.
    4. Select Show to see the actual report itself. From this page, you can select the date range, the task collection time interval, the Aggregate method (Max, Avg, Sum, 80th, 90th, 95th, or 99th percentile), and the Unit. Click Apply after changing the filter criteria. Charts can be created by clicking the PDF Charts icon or the Trending icon. Figure 3 shows a sample User Collected Data Report.

      Figure 3: Sample User Collected Data Report

      Sample User Collected
Data Report

    This section describes how to view the reports.

    • Go refreshes and displays the report based on the configured report settings.
    • Dates to view is the date range to display.
    • Display data points every is the time interval to display.
    • Aggregate Method uses calculation described in Aggregate Method section.
    • Unit is the unit to display.
    • Column Filter filters the display by Column header.
    • Sort By sorts the display by Column header.
    • Show PDF Charts displays row data as charts. You must mark at least one Row. You can mark all rows near the Column header.
    • Multiple Charts creates one chart for each row marked.
    • Single Charts creates one chart for all rows marked.
    • Line, Bar, 3D Bar, Area are chart types.
    • Chart icon displays a chart for the Row.
    • Trending displays trending report for the Row.

    Aggregate Method


    Aggregate Method is a report display option that returns new data values depending on which aggregate method is chosen. The table below will be used as an example in this section. The time interval of this data set is 1 hour.

    Table 1: Aggregate Method Report Results

    Base Data

    Method

    1:00

    2:00

    3:00

    4:00

    widgets

    N/A

    6

    4

    9

    5

    For aggregation to work, it requires aggregating the time interval of your data collection. This is done by changing the Display data points every option. If the Base Data is aggregated from 1 hour to 2 hours, the new time interval changes to 2 hours and the table changes. 1:00 and 2:00 are aggregated as 1:00, and 3:00 and 4:00 are aggregated as 3:00.

    Table 2: Aggregate Method Report Two-hour Results

    Aggregate Data

    Method

    1:00

    3:00

    widgets

    select

    data

    data

    The data value for widgets depends on which Aggregate Method is chosen. When data is aggregated, its calculation is based on the new time interval.

    • Minimum displays the lowest value in the aggregate time.
    • Maximum displays the highest value in the aggregate time.
    • Average displays the average value in the aggregate time.
    • Sum displays the sum value in the aggregate time.

    The new data values for each method:

    Table 3: Aggregate Method Report New-value Results

    Aggregate Data

    Method

    1:00

    3:00

    widgets

    Minimum

    4

    5

    widgets

    Maximum

    6

    9

    widgets

    Average

    5

    7

    widgets

    Sum

    10

    14

    Data values using aggregate method Y percentile:

    • 80% displays 80th percentile using formula average x 0.85 x sd
    • 90% displays 90th percentile using formula average x 1.282 x sd
    • 95% displays 95th percentile using formula average x 1.645 x sd
    • 99% displays 99th percentile using formula average x 2.32 x sd

    The new data values using Y percentile and aggregating from 1 hour to 4 hours:

    Table 4: Aggregate Method Report Y Percentile Results

    Aggregate Data

    Method

    1:00

    widgets

    80%

    7.836

    widgets

    90%

    8.769

    widgets

    95%

    9

    widgets

    99%

    9


    Adding a User Collected Data Report


    The User Collected Data Report also allows you to use your own set of data for creation of IP/MPLSView Web reports. This allows for the creation of customized reports as long as your data format follows the User Collected Data Report format requirements, specified below.

    After the directory structure and files are created in the proper format specified below in Report Directory Structure, you can define the data content in the files and configure the report settings.

    Login to the IP/MPLSView Web Interface as “admin”. For example, if the administrative user is wandl, you would login with the username “admin” but type in wandl’s password. Select Reports > User Collected Data Report. Next, click Add report. Follow the instructions below.

    Figure 4: Add Report

    Add Report

    Figure 5: Add Report Options

    Add Report Options
    • Report Name is the title of the report.
    • Data dir is the directory path of the report.
    • Data file extension specifies to use only the files with matching extension name entered in the report directory. If no extension name is entered, then all files are used. For example, if the report directory contains traffic.cisco and traffic.juniper files, and the data file extension entered is juniper, then only traffic.juniper will be used in the report.
    • Use file name as key for Column1 sets the filename as the keyword for Column1. The first keyword in the data file then becomes Column2, the second keyword Column3 and so forth. One example of using this option can be when filenames are organized by router name.
    • Calculate Util uses the util integer in the file and calculates Util% using formula 100/util. The field entry is to name the ColumnUtil.
    • Data Interval sets the time interval between the sequence of data values.
    • Show Delta displays the difference in data values by subtracting the previous value. If the difference is negative or if there is no previous value, no value is displayed. This option is primarily used when the data value is based on a counter that increments such as traffic values reported by a router.
    • Calculate Rate divides the data value by the unit of measure chosen in the bytes per sec option.
    • Unit sets the unit of measure for the data values.
    • User Administration: Check for Regional Router Filtering applies regional views to the marked Column# and viewers of the report will only be able to see the data row if they belong to that region. Regional groups are organized by router names so only a Column# using the router name as the keyword can be applied. Regional groups and user assignments are setup in the User Administration module.
    • Column field is an entry to set the Column header name.

    Report Directory Structure


    The report generally consists of keywords followed by a sequence of values with a definable time interval between those values. One example of a report using this format are traffic reports. The keywords are routers, the values represent traffic data, and the time interval can be defined as hourly. To use this report feature, the requirements are having proper format for the report directory structure and data files on the application server.

    Each path corresponds to one day of data. If multiple days are desired for the reports, multiple paths must be created. The directory structure uses the format:

    /reportname/YYMMDD

    • reportname is a string and helps identifies the report subject.
    • YYMMDD is year, month, day. All 6 digits must be entered.
    • To share the reports with all users, it's recommended to create the directory structure path in /u/wandl/data/report/
    • To restrict the reports from other users, it's recommended to create the directory structure path in user's home directory /export/home/username

    Sample directory structure shared with all users for traffic reports from January 20, 2011 to January 22, 2011:

    /u/wandl/data/report/traffic/110120
    /u/wandl/data/report/traffic/110121
    /u/wandl/data/report/traffic/110122

    File Format


    Each file corresponds to one day of data. If multiple days of data are desired for the reports, each file must be placed in the appropriate path using the directory structure format. The filename can be any string and extension that's valid in UNIX. The file contents use the format per line:

    keyword1^keyword2 ^^^ util value value

    • keyword1 is a string and identifies the data in Column1. REQUIRED.
    • ^ is used to separate keywords.
    • keyword2 is a string and identifies the data in Column2. Up to 9 keywords are supported. OPTIONAL.
    • ^^^ is used after the last keyword to indicate the start of the value sequence. REQUIRED

      Note: The ^^^ separator is space,carrot,carrot,carrot,space ( ^^^ )

    • util is an integer that modifies the report's Util% calculation using formula 100/util. If you do not need Util% calculation in the report, there is an option to ignore util in Settings.

      Note: The first integer after the ^^^ separator is always considered the util even if Util% calculation is ignored in the Settings. If you do not need Util% calculation, it's recommended to enter 0 for the util before starting the value sequence.

    • value is an integer and identifies the data in the Row. Values are separated by a space. Up to 288 values are supported per row. Additional values after 288 are ignored. The first value entry corresponds to timestamp 00:00 or 12:00am. The time interval between each value is set in Settings.

    The following table corresponds the number of data points to time intervals. If your Row has more data points than the interval selected, the additional data points are ignored. If your Row has less data points than the interval selected, there will be time intervals with no data.

    Table 5: Data Points To Time Intervals

    Time Interval

    Data Points

    5 minutes

    288

    10 minutes

    144

    15 minutes

    96

    20 minutes

    72

    30 minutes

    48

    1 hour

    24

    2 hours

    12

    3 hours

    8

    4 hours

    6

    6 hours

    4

    8 hours

    3

    12 hours

    2

    24 hours

    1

    Sample file format containing 2 keywords, 0 util, and 8 values:

    BRTN^VT ^^^ 0 299 250 160 300 499 99 600 430
    SMKN^NV ^^^ 0 180 50 499 250 610 450 320 420
    LBTC^WA ^^^ 0 459 299 410 326 410 199 200 315

    Directory and File


    Place your data files into each directory. /reportname/YYMMDD/filename

    • Each path corresponds to one unique day. Thus the file contents should be organized as data only for that day.
    • Multiple files can be placed in the same YYMMDD directory. The report will use all the keywords in all the files and sort them alphabetically in Column1. One example of using multiples files can be traffic data collected and organized by vendor such as traffic.cisco and traffic.juniper.
    • Consecutive days are not required for the directory structure.
    • The report will display the date range for the directories created.
     

    Related Documentation

     

    Modified: 2016-09-09