Target release 
Version

1.2.0

Document status

DRAFT

Document owner
Designer
Developers
QAMichelle Beard

Goals

  1. Addresses short-comings/Vulnerabilities in ability to extract specific information from Headers
  2. Addresses "entropy" in our data model–standardizes indexes attached to specific information that is collected from different sources
  3. Capture Additional information from headers
  4. Investigates some odd behavior in certain log classes
    1. Interval logs may be writing overlapping logs (patch)

Background and strategic fit

  1. We have previously relied on Logstash to handle requests from the page for data from headers. This is a vulnerability for two reasons: it makes certain information passed to UserALE.js via our API unobtainable and it places a strong dependency on Elastic assets and specific system configurations to get basic data.
  2. As the scope of information that UserALE.js collects has increased, we find that our schema for indexing this data has not similarly scaled intelligently. A key example is that pageUrl is a property of both raw/interval logs and tab tracking logs, however pageUrl is not indexed the same way. This makes for difficult querying after data is collected. Moreover, legacy field names, e.g., type should be re-labeled to be more intuitive (userEventClass)
  3. In upgrading how we collect data from headers, we should consider adding new data that is easy to collect.

Assumptions

  1. UserALE.js can be made capable of making header information requests, servicing different levels of request based on when data is made available from the browser vs. the page (e.g., we are relying on script tag vs. plugin model of deployment).
  2. We can build a new indexing pattern in ES that will reindex data being collected now to reflect changes in new schema. We will communicate a timeline for how long we will maintain this backward compatibility 

 

Requirements

#TitleJIRA TicketImportanceNotes
1Remove Logstash Dependency for Retrieving Header Data SENSSOFT-289 - Getting issue details... STATUS MUST HAVE 
3Remap UserALE.js indices for Standardization and Easy Querying SENSSOFT-291 - Getting issue details... STATUS SHOULD HAVE 
4Investigate, Eliminate Errors in Interval Log Formats SENSSOFT-292 - Getting issue details... STATUS MUST HAVE 

Questions

Below is a list of questions to be addressed as a result of this requirements document:

QuestionOutcome
  

Not Doing

  • No labels