Reports - Report view: Summary, list view of the runs and filters
Description
As a CDAP user, I want to be able to view and filter runs, create a report that can be downloaded as Excel file or generate a link that can be shared and viewed by the user of that Namespace(s).
The user can navigate to the Report view from the Run Monitor by selecting the link in the toggle on top of the page.
DOWNLOAD AS EXCEL A "Report" includes the Summary and the single runs list view. A user can download the report as an excel document: the download will capture any information displayed below the top gray banner: Summary and run list view Any filters applied by the user to further narrow down the report will be captured as well.
PERMALINK The user can share a link to the report. The link will capture not just the selections in the top gray area, but also any filter applied to the run list Use cases: The report displays metrics from 2 different Namespaces.
If a user has the credentials to view the same 2 Namespaces: will be able to view all the information
If a user has the credentials to view only one of the two Namespaces, he will be able to view only the runs that are he is credentialed to view; a message is displayed. "You are not credentialed to view <number> of the Namespaces originally included in this report. Please contact your administrator to update your privileges"
If a user is not credentialed to view any of the Namespaces a message is going to be displayed. "You are not credentialed to view any of the Namespaces originally included in this report. Please contact your administrator to update your privileges"
The report is comprised of a summary and a list of the runs that meet the criterions selected by the user.
A summary for each of the columns selected (the summary is only displayed if the colum is selected), • Namespace: '<Namespace>' ( # runs), '<Namespace>' ( # runs) • Time Range: display time range selected e.g. Nov. 5, 2017 1pm to 12pm Nov. 5, 2017 • Status: display list of statuses selected, separated by a comma. • Start Time: newest: <timestamp>, oldest <timestamp> • End Time: most recently ended: <timestamp>, least recently ended: <timestamp> • Run Durantion: Min.: <time>, Max: <time>, Average: <time> • Users: <username> (# or runs started), <username> (# or runs started) • Start Method: by schedule (#), by trigger (#), manually (#) • Runtime Args: • Memory Usage: Min.: <#>, Max: <#>, Average: <#> • Cores: Max used <#>, Max available <#> • Containers: Max used <#>, Max available <#> • Log Warnings: Min.: <#>, Max: <#>, Average: <#> • Log Errors: Min.: <#>, Max: <#>, Average: <#> • Records Out: Min.: <#>, Max: <#>, Average: <#>
When pipelines runs are selected, always display: • Pipeline Types: <#> batch, <#> realtime
When custom apps are selected, always display: • Custom App Types: <#> spark, <#> worker, <#> flow, <#> service
RUN LIST This is a list of all the runs of any pipeline or custom apps that meet the criterions selected.
The total number of runs displayed on top of the page, next to the pagination (e.g. "52 Pipelines")
Runs are paginated: 15 to 20 runs are displayed per page.
The user can search runs displayed on the list, by typing the name of pipeline. The search should autocomplete and typeahead feature that includes all the names of the runs within that selection.
The Name column is always displayed. It displays name of the pipelines. For custom app, the name is displayed using the following format: <Name of the App> - <Program name>
The user can sort the runs list by column headers. By Default, the runs are organized by Start Time, with the most recent pipeline displayed on the top.
Filter The user can filter most of the column, by selecting the filter icon on the left of the column header. When selected, the filter icon is displayed in CDAP orange. hex #FB6620 This is a list of the columns that can be filtered,
Namespace: Title: Filter by Namespaces List of all namespaces displayed in ta list. Selected checkboxes next to each name. The option to "Select All | Clear
Type: Title: Filter by Type List of all Types displayed in a list. Selected checkboxes next to each type. The option to "Select All | Clear
Status Title: Filter by Status List of all Statuses displayed in the list selected checkboxes next to each status. The option to "Select All | Clear
Start time: CANNOT BE FILTERED - only sorted
End time: CANNOT BE FILTERED - only sorted
Duration Title: Filter by Duration Default selection: View all Subtitle: View runs that lasted • more than 30 min • more than 1 hour • more than 2 hours • more than 24 hours • less than 30 min • less than 1 hour • less than 2 hours • less than 24 hours
User Title: Filter by User List of all users names displayed in a list. Selected checkboxes next to each username. The option to "Select All | Clear
Start Method Title: Filter by Start Method List of all methods displayed in a list. Selected checkboxes next to each method. The option to "Select All | Clear
Runtime Args Title: Filter by Runtime Args Two Options (both selected): "yes"; "no"
Memory Title: Filter by Memory Usage Default selection: View all Subtitle: View runs that used • more than 1 GB • more than 5 GB • more than 10 GB • more than 25 GB • less than 1 GB • less than 5 GB • less than 10 GB • less than 25 GB
Cores Title: Filter by Cores Usage List of all number of cores displayed in a list. Selected checkboxes next to each number. The option to "Select All | Clear
Containers Title: Filter by Containers Usage List of all number of containers displayed in a list. Selected checkboxes next to each number. The option to "Select All | Clear
Log warnings: CANNOT BE FILTERED - only sorted
Log errors: CANNOT BE FILTERED - only sorted
Records out: CANNOT BE FILTERED - only sorted
Release Notes
Added a UI to generate reports on programs and pipelines that ran over a period of time
As a CDAP user, I want to be able to view and filter runs, create a report that can be downloaded as Excel file or generate a link that can be shared and viewed by the user of that Namespace(s).
The user can navigate to the Report view from the Run Monitor by selecting the link in the toggle on top of the page.
DOWNLOAD AS EXCEL
A "Report" includes the Summary and the single runs list view.
A user can download the report as an excel document: the download will capture any information displayed below the top gray banner: Summary and run list view
Any filters applied by the user to further narrow down the report will be captured as well.
PERMALINK
The user can share a link to the report. The link will capture not just the selections in the top gray area, but also any filter applied to the run list
Use cases:
The report displays metrics from 2 different Namespaces.
If a user has the credentials to view the same 2 Namespaces: will be able to view all the information
If a user has the credentials to view only one of the two Namespaces, he will be able to view only the runs that are he is credentialed to view; a message is displayed. "You are not credentialed to view <number> of the Namespaces originally included in this report. Please contact your administrator to update your privileges"
If a user is not credentialed to view any of the Namespaces a message is going to be displayed. "You are not credentialed to view any of the Namespaces originally included in this report. Please contact your administrator to update your privileges"
The report is comprised of a summary and a list of the runs that meet the criterions selected by the user.
REPORT SUMMARY
Title: Summary - <Selected Statuses> Runs (<selected runs>)
e.g. Summary - Failed, Successful Runs (Pipelines)
Timestamp of the last update
A summary for each of the columns selected (the summary is only displayed if the colum is selected),
• Namespace: '<Namespace>' ( # runs), '<Namespace>' ( # runs)
• Time Range: display time range selected
e.g. Nov. 5, 2017 1pm to 12pm Nov. 5, 2017
• Status: display list of statuses selected, separated by a comma.
• Start Time: newest: <timestamp>, oldest <timestamp>
• End Time: most recently ended: <timestamp>, least recently ended: <timestamp>
• Run Durantion: Min.: <time>, Max: <time>, Average: <time>
• Users: <username> (# or runs started), <username> (# or runs started)
• Start Method: by schedule (#), by trigger (#), manually (#)
• Runtime Args:
• Memory Usage: Min.: <#>, Max: <#>, Average: <#>
• Cores: Max used <#>, Max available <#>
• Containers: Max used <#>, Max available <#>
• Log Warnings: Min.: <#>, Max: <#>, Average: <#>
• Log Errors: Min.: <#>, Max: <#>, Average: <#>
• Records Out: Min.: <#>, Max: <#>, Average: <#>
When pipelines runs are selected, always display:
• Pipeline Types: <#> batch, <#> realtime
When custom apps are selected, always display:
• Custom App Types: <#> spark, <#> worker, <#> flow, <#> service
RUN LIST
This is a list of all the runs of any pipeline or custom apps that meet the criterions selected.
The total number of runs displayed on top of the page, next to the pagination (e.g. "52 Pipelines")
Runs are paginated: 15 to 20 runs are displayed per page.
The user can search runs displayed on the list, by typing the name of pipeline. The search should autocomplete and typeahead feature that includes all the names of the runs within that selection.
The Name column is always displayed. It displays name of the pipelines. For custom app, the name is displayed using the following format: <Name of the App> - <Program name>
The user can sort the runs list by column headers. By Default, the runs are organized by Start Time, with the most recent pipeline displayed on the top.
Filter
The user can filter most of the column, by selecting the filter icon on the left of the column header. When selected, the filter icon is displayed in CDAP orange. hex #FB6620
This is a list of the columns that can be filtered,
Namespace:
Title: Filter by Namespaces
List of all namespaces displayed in ta list. Selected checkboxes next to each name. The option to "Select All | Clear
Type:
Title: Filter by Type
List of all Types displayed in a list. Selected checkboxes next to each type. The option to "Select All | Clear
Status
Title: Filter by Status
List of all Statuses displayed in the list selected checkboxes next to each status. The option to "Select All | Clear
Start time: CANNOT BE FILTERED - only sorted
End time: CANNOT BE FILTERED - only sorted
Duration
Title: Filter by Duration
Default selection: View all
Subtitle: View runs that lasted
• more than 30 min
• more than 1 hour
• more than 2 hours
• more than 24 hours
• less than 30 min
• less than 1 hour
• less than 2 hours
• less than 24 hours
User
Title: Filter by User
List of all users names displayed in a list. Selected checkboxes next to each username. The option to "Select All | Clear
Start Method
Title: Filter by Start Method
List of all methods displayed in a list. Selected checkboxes next to each method. The option to "Select All | Clear
Runtime Args
Title: Filter by Runtime Args
Two Options (both selected): "yes"; "no"
Memory
Title: Filter by Memory Usage
Default selection: View all
Subtitle: View runs that used
• more than 1 GB
• more than 5 GB
• more than 10 GB
• more than 25 GB
• less than 1 GB
• less than 5 GB
• less than 10 GB
• less than 25 GB
Cores
Title: Filter by Cores Usage
List of all number of cores displayed in a list. Selected checkboxes next to each number. The option to "Select All | Clear
Containers
Title: Filter by Containers Usage
List of all number of containers displayed in a list. Selected checkboxes next to each number. The option to "Select All | Clear
Log warnings: CANNOT BE FILTERED - only sorted
Log errors: CANNOT BE FILTERED - only sorted
Records out: CANNOT BE FILTERED - only sorted