COSMOS Design 200275
Contents
Refactor Report Component to use Data Collection Convenient query asembly APIs
Change History
| Name: | Date: | Revised Sections: |
|---|---|---|
| Sheldon Lee-Loy | 11/14/2007 |
|
| John Todd | 12/04/2007 |
|
| John Todd | 12/06/2007 |
|
Workload Estimation
| Process | Sizing | Names of people doing the work |
|---|---|---|
| Design | 0.5 | Sheldon Lee-Loy |
| Code | TBD | |
| Test | 0.2 | |
| Documentation | 0.2 | |
| Build and infrastructure | 0.2 | |
| Code review, etc.* | 0.2 | |
| TOTAL | TBD |
'* - includes other committer work (e.g. check-in, contribution tracking)
Terminologies/Acronyms
The terminologies/acronyms below are commonly used throughout this document. The list below defines each term regarding how it is used in this document:
| Term | Definition |
|---|---|
| MDR | Management Data Repository |
Purpose
This enhancement involves refactoring the existing reports to use the new Data Collection Query APIs. The existing examplar report templates utilize the old query assembly components. In addition, a datafeed is required to get a list of datasource that a statistical or monitoring data manager is aware of.
Requirements
The Data Collection Query APIs referenced in the Purpose section were done as part of ER 212187 and ER 21819
The CBE and Statistical DataManagers referenced are also part of ERs 212187 and 212189.
Implementation details
There is currently two types of report templates.
- Statistical Report
- Monitoring Report
The refactoring involves changing the binding logic defined in the datasets and modification to the report parameter.
Statistical Report Template Refactor Design
The following new report parameters should be defined for the statistical report:
- epr - epr address to the statistical data manager.
- datasource id - an identifier that represents a datasource known by the data manager
These report parameters will replace the existing one of DataSource and KeySet
The binding logic defined in the datasets will take the above report parameters to bind to the statistical data manager. Once bound the dataset will use the "convenient apis" provided by the statistical data manager. These APIs are defined by the data collection component. The corresponding data collection enhancement will define the APIs [reference bugzilla # is required here].
Monitoring Report Template Refactor Design
The monitoring report template will undergo similar refactoring. The following new report parameters should be defined for the monitoring report:
- epr - epr address to the statistical data manager.
- datasource id - an identifier that represents a datasource known by the data manager
These report parameters will replace the existing ones of DataSource and KeySet
The binding logic defined in the datasets will take the above report parameters to bind to the monitoring data manager. Once bound the dataset will use the "convenient apis" provided by the statistical data manager. These APIs are defined by the data collection component. The corresponding data collection enhancement will define the APIs [reference bugzilla # is required here].
Data Feed
When visualizing a statistical or monitoring data manger the COSMOS UI will allow the user to expand the monitoring/statistical data manger node in the Navigator. The expansion of this node will send a query to either the monitoring or statistical data manager to get the list of data sources known by the data manager. For example, consider an MDR that contains statistical data for several tomcat servers and operating systems. This view will list all the set of tomcat servers and operating servers as data sources contain statistical data. The user has the option to right-click on a particular data source to generate a report based on a set of available statistical reports.
Mockup
Sample Data Feed
The following is the output that the data feed will produce a list of datsources from a monitoring data manager:
{ identifier: "object", label: "title",
items:[
{title:"Windows XP Application Log ",datasource:"server 1",classification:"CBE",nodeClass:"datasource",object:"2"}
,{title:"Appache HTTP Access Log ver 5.5",datasource:"server 1", classification:"CBE",nodeClass:"datasource",object:"3"}
]
}
Test Coverage
The following links can be used to test the Log report template and the Statistical report template outside the GUI context of the COSMOS UI These links use the running tomcat on localhost
And
Open Issues
The APIs the report templates will use have been completed so there no longer any open issues.