RSA Governance & Lifecycle Recipes: Telemetry Chart - Daily Collection Summary
2 years ago
Originally Published: 2020-12-09

Version: V 7.2.x

Modules: Governance

Product Area: Charts, Multiple Series (Applied to Admin/Topic Dashboard)

Associated Dashboard:

Time to apply: ~30 minutes

 

Summary

This chart provides key information about the collectors being run. It use the daily telemetry data that is collected and stored in: avuser.PV_TELEMETRY_DATA. This means the data is always 1 day behind.

The goal of this chart is to understand the status of collectors.

The chart can be used by admins to help them focus on if they need to take action, when collectors have failed. It could also be used to highlight if collectors that were expected to be run, were not run. 

 

Example Image (Click to enlarge)

pastedImage_2.png

 

Key Notes

  • This chart/report/dashboard is supplied "as is" - any modification of this item is done at your own risk. 
  • This chart is applied at the "topic" level, but you could also use this on a "home" dashboard too. 
  • If you have issues applying this chart/report/dashboard, please comment below for help, DO NOT contact the RSA Support team.
  • If you would like more assistance with this chart/report/dashboard or for help in creating other chart/report/dashboards, then RSA Professional Services (RSA PS) is available to help.
    • Please contact your RSA Account Manager or local RSA Sales Rep or reply below for further assistance.

 

Details

This chart includes the following key information, you can click the chart legend to show/hide results: 

  • Failed Collectors: The total number of collectors that have failed for that specific day
  • Successful Collectors: The total number of collectors that were successful for that specific day

 

 

Optional Changes to Dynamic Chart Values

This is how you can configure the chart, so it is useful for how you wish to view the data 

  • GROUPING: This allows you to group the data and display it based on the following date ranges. For example, you might want to show the data grouped per week, per quarter or per day. This will be up to you and your business needs. 
    For this chart, the recommendation is to use 'Daily'
    You MUST ensure you use a single quote ', either side of the value, for this to work properly in the RSA IGL Chart UI.
    However, when testing this in SQL Developer, the single quote ' is NOT required.
    Please copy and paste these values exactly as shown below to change the chart:
    • 'Daily'
    • 'Weekly'
    • 'Monthly'
    • 'Quarterly'
    • 'Yearly'

 

  • TotalDataPoints: This is how many results you want to display. It is a number and doesn't need any quotes. If you set this value to be 7, it would show 7 results. For example if you set "Grouping" to be 'Daily' then you might want to set "TotalDataPoints" = 14, showing you the results for the past 14 days. 
    For this chart, the recommendation is to use 14, however it will depending on the screen size you have and how this looks.
 

We strongly recommend you do not specify too many values for "TotalDataPoints" otherwise it will not display well

 

Chart SQL

First test this in your query tool (SQLDeveloper, Toad etc..)

(select 
    tFailedCollectors.starttime,
    tFailedCollectors.value as "Failed Collectors",
    tSuccessfulCollectors.value as "Successful Collectors"
from
    (
        SELECT
            TO_CHAR(Tdates.dates, DECODE(trim( :GROUPING ) , 'Daily', 'YYYY-Mon-DD', 'Weekly', 'YYYY - "Week "WW', 'Monthly', 'YYYY - Month', 'Quarterly', 'YYYY - "Q"Q', 'Yearly', 'YYYY')) StartTime,
            /* 
            Use count(t1.value) to count the number of rows based on your filters
            Use max(t1.value) to get the maximum value on the specific date
            Use sum(t1.value) to get the collective total of values on the specific date
            */
            nvl(max(td.value), 0) VALUE
        FROM
            (
            SELECT
            CASE
                /* if using avuser.PV_TELEMETRY_DATA then change sysdate to be sysdate-1. This is beacuse telemetry is calculated 1 day later */
                    WHEN :GROUPING = 'Daily' THEN trunc(sysdate-1, 'DD') - (LEVEL-1)
                    WHEN :GROUPING = 'Weekly' THEN trunc(sysdate-1, 'D') - (7 * (LEVEL-1))
                    WHEN :GROUPING = 'Monthly' THEN ADD_MONTHS(trunc(sysdate-1, 'MM'),-1 *(LEVEL-1))
                    WHEN :GROUPING = 'Quarterly' THEN ADD_MONTHS(trunc(sysdate-1, 'Q'),-3 *(LEVEL-1))
                    WHEN :GROUPING = 'Yearly' THEN ADD_MONTHS(trunc(sysdate-1, 'Y'),-12 *(LEVEL-1))
                END dates
            FROM
                dual
            CONNECT BY
                LEVEL <= :TotalDataPoints 
            ) Tdates
           LEFT JOIN avuser.PV_TELEMETRY_DATA td 
                on td.CATEGORY = 'collectors'
                 AND td.NAME =('collectors.failures.today')
                /* 
                Use = to get values at the exact dates. 
                Use <= to get values on or before the exact date 
                */
                AND trunc(td."DAY", DECODE(:GROUPING ,'Daily','DD','Weekly','D','Monthly','MM','Quarterly','Q','Yearly','Y')) = Tdates.dates
        GROUP BY Tdates.dates
        ORDER BY Tdates.dates ASC
    ) tFailedCollectors
left join 
    (
        SELECT
            TO_CHAR(Tdates.dates, DECODE(trim( :GROUPING ) , 'Daily', 'YYYY-Mon-DD', 'Weekly', 'YYYY - "Week "WW', 'Monthly', 'YYYY - Month', 'Quarterly', 'YYYY - "Q"Q', 'Yearly', 'YYYY')) StartTime,
            /* 
            Use count(t1.value) to count the number of rows based on your filters
            Use max(t1.value) to get the maximum value on the specific date
            Use sum(t1.value) to get the collective total of values on the specific date
            */
            nvl(max(td.value), 0) VALUE
        FROM
            (
            SELECT
            CASE
                /* if using avuser.PV_TELEMETRY_DATA then change sysdate to be sysdate-1. This is beacuse telemetry is calculated 1 day later */
                    WHEN :GROUPING = 'Daily' THEN trunc(sysdate-1, 'DD') - (LEVEL-1)
                    WHEN :GROUPING = 'Weekly' THEN trunc(sysdate-1, 'D') - (7 * (LEVEL-1))
                    WHEN :GROUPING = 'Monthly' THEN ADD_MONTHS(trunc(sysdate-1, 'MM'),-1 *(LEVEL-1))
                    WHEN :GROUPING = 'Quarterly' THEN ADD_MONTHS(trunc(sysdate-1, 'Q'),-3 *(LEVEL-1))
                    WHEN :GROUPING = 'Yearly' THEN ADD_MONTHS(trunc(sysdate-1, 'Y'),-12 *(LEVEL-1))
                END dates
            FROM
                dual
            CONNECT BY
                LEVEL <= :TotalDataPoints 
            ) Tdates
           LEFT JOIN avuser.PV_TELEMETRY_DATA td 
                on td.CATEGORY = 'collectors'
                 AND td.NAME =('collectors.success.today')
                /* 
                Use = to get values at the exact dates. 
                Use <= to get values on or before the exact date 
                */
                AND trunc(td."DAY", DECODE(:GROUPING ,'Daily','DD','Weekly','D','Monthly','MM','Quarterly','Q','Yearly','Y')) = Tdates.dates
        GROUP BY Tdates.dates
        ORDER BY Tdates.dates ASC
    ) tSuccessfulCollectors
    on tSuccessfulCollectors.StartTime = tFailedCollectors.starttime)

Example of the results:

pastedImage_5.png

 

Chart Implementation

  1. Log into RSA IGL as a user who can create charts. In my example, im using AveksaAdmin
  2. Go to "Reports" / "Charts"
  3. Select "+ Create Chart" button
    pastedImage_4.png
  4. Under the "General Tab" add the following details:
    • Name: Telemetry Chart - Daily Collectors
    • Description: From RSA IGL Link Community. This chart provides information on the daily collectors that were run. This chart uses data from avuser.PV_TELEMETRY_DATA which is collected nightly, so the data is always 1 day behind.
    • Type = Multiple Series Chart
      pastedImage_7.png
       
  5. Under the "Query" Tab, copy the SQL from above
  6. Update the 2 dynamic values as noted above, recommendation:
    Grouping: 'Daily'
    TotalDataPoints: 14
  7. Press the "Preview" button, you should see some results, as per the example image below.
    If you get an error at this stage, please test your SQL in a Query tool, like "SQL Developer" or "SQL Squirrel" to ensure it works first. 
    If it still doesn't work, please share your SQL and a screen shot of the issue below. DO NOT contact RSA Support 
    pastedImage_6.png
  8. Under the "Columns" Tab, please use the configuration shown in the image below.
    Notes: 
    - You can update the display name if you need, eg. you can change "Failed Collectors" to just "Failed"
    - You can also manually specify a color for each value if you require. 
    pastedImage_8.png
     
  9. Under the "Display Attributes" tab, you should select "Style = MS Line". Please also apply these settings, however you can update the wording with what is best for you.
    • Under "Title and Axis Names"
      • Caption: Daily Collection Info
      • Sub Caption: Recommendation: Review any failed collectors ASAP
      • X Axis Name: Date
      • Y Axis Name: Total
        pastedImage_13.png
    • Under "Functional attributes"
      • Select "Animation" = ticked
      • Select "Show Labels"  = ticked
      • Select "Show Values" = ticked
      • Select "Rotate Values" = ticke
      • Select "Slant Values" = ticked
      • Label Display = WRAP
      • Label Step: 2 (Note: this just skips each value in the X axis display, remove this if you want to show all results, but this might not look great if you do)
        pastedImage_12.png
    • Under "Data Dataset Element
      • Select "Show Values" = Ticked
        pastedImage_26.png
 

There are MANY other "display attributes" you can play with on this screen, so please update and make changes as you see fit. 

pastedImage_14.png