Add_Targeted_Reports_and_Statistical_Data

Add Targeted Reports and Statistical Data

Summary

Conductor is currently focused on providing basic utility: the ability to create, edit, and destroy. These are key functions; however, they are not always the ones that users and administrators will need on a day-to-day basis. For example, a provider administrator will probably not need to create or edit provider accounts on a day-to-day basis. Instead, an administrator will need the missing item from the list above: reporting capabilities.

This feature aims to add relevant reports and statistics where needed. It is a broadly defined goal with a few subtleties:

• What statistics are considered “relevant” for a given entity? A pool or provider administrator is likely to be interested in a historical time series view of a given entity; however an image administrator may be more interested in flat usage numbers.
• How do we isolate different levels of privileged view for a given entity? For example, the /pools/ page currently lists all deployments that the given user is able to see. Would it make more sense to create a) a view for all user-owned deployments, b) a view for all viewable deployments, and c) an administrative view of deployments?

This document attempts to address these questions below; however, it is likely that the ultimate answer will require a fair amount of back-and-forth involving developers, usability experts, and end users.

Owner

Tzu-Mainn Chen (tzumainn)

Current Status

• Targeted release: Conductor 1.1 Release

User Scenarios

Non-Privileged User

Upon login, initial page should show. . .

• Self-deployments only, with important details such as status.
• Options for historical self-usage reports
• Options to view all deployments for which the user has the “View” privilege (essentially, the current “/pools/” page)
• Graphical views of additional data that may be relevant to user’s effectiveness; for example, time-based views of pool or provider usage would allow a user to see if there are optimal times to run a deployment

Administrator

• Go to a single administrative page that contains summary statistics of “key” entities. “Key” refers to entities that may have high usage or potential issues.
• Go to the index page of an entity type (“/providers/”) to view additional statistics of all entities of that type.
• Go to the “view” page of a single entity in order to view complete and detailed statistics.

Implementation tasks

High-level implementation details

Some generate notes:

• Reports can be implemented through a filter table; graphs through the use of Flot.
• Non-privileged and administrator views should be as distinct as possible. This will allow for a cleaner UI for both roles.
• All reports will include links to relevant actions and pages - for example, a user will want to be able to stop a deployment or create a new one; an administrator viewing a summary list of the “top X” images used will have a link to view all of the images.
• An option to export report data to CSV format should be available for all reports

The below gives a list of the types of reports to expect.

Non-Privileged User

* pools
> * self-deployments in a filter table
> * option to view deployments for which the user has the “View” privilege
> * option to view historical usage
> * graphs of overall usage on pools and providers to which the user has access

Administrator

* users
> * bar chart of top X users by usage, options to view over selectable time span
> * filter table of usage by all users

* pools
> * historical graph of usage, options to group by user and provider, selectable time span
> * bar chart of usage by user/provider over selectable time span
> * bar chart of deployment/instance statuses over selectable time span

* pool_families
> * similar to pools

* providers
> * historical graph of usage, options to group by user and pool, selectable time span
> * bar chart of usage by user/pool over selectable time span
> * bar chart of deployment/instance statuses over selectable time span

* images
> * bar chart of usage, options to group by user/pool/provider, selectable time span

* hardware_profiles
> * bar chart of usage, options to group by user/pool/provider, selectable time span

* dashboard
> * a summarized statistical view of the “key” entities above

Future Plan

References