-
Notifications
You must be signed in to change notification settings - Fork 358
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
ff10537
commit 26e68d9
Showing
21 changed files
with
8,324 additions
and
6,103 deletions.
There are no files selected for viewing
56 changes: 56 additions & 0 deletions
56
app/javascript/components/timeline-options/timeline-chart.jsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
import React, { useEffect, useRef } from 'react'; | ||
import PropTypes from 'prop-types'; | ||
import { LineChart } from '@carbon/charts-react'; | ||
import { timelineUiOptions } from './timeline-helper'; | ||
|
||
const TimelineChart = ({ data, title, buildTableData }) => { | ||
const chartRef = useRef(null); | ||
const chartOnClick = ({ detail }) => { | ||
buildTableData(detail.datum); | ||
}; | ||
|
||
useEffect(() => { | ||
// TODO: move these notes onto the PR Description | ||
// You can see the current dispatched events here. | ||
// https://carbon-design-system.github.io/carbon-charts/documentation/modules/_interfaces_events_.html | ||
// https://charts.carbondesignsystem.com/?path=/story/docs-tutorials--event-listeners | ||
// https://charts.carbondesignsystem.com/documentation/enums/_interfaces_events_.line.html | ||
chartRef.current.chart.services.events.addEventListener( | ||
'scatter-click', | ||
chartOnClick | ||
); | ||
}, [chartRef]); | ||
|
||
// Unmount | ||
useEffect( | ||
() => () => { | ||
if (chartRef.current) { | ||
chartRef.current.chart.services.events.removeEventListener( | ||
'scatter-click', | ||
chartOnClick | ||
); | ||
} | ||
}, | ||
[] | ||
); | ||
|
||
return ( | ||
<div> | ||
<LineChart className="line_charts" data={data} options={timelineUiOptions(title)} ref={chartRef} /> | ||
</div> | ||
); | ||
}; | ||
|
||
TimelineChart.propTypes = { | ||
data: PropTypes.arrayOf(PropTypes.any).isRequired, | ||
title: PropTypes.string, | ||
buildTableData: PropTypes.func.isRequired, | ||
}; | ||
|
||
TimelineChart.defaultProps = { | ||
data: [], | ||
title: '', | ||
buildTableData: PropTypes.func.isRequired, | ||
}; | ||
|
||
export default TimelineChart; |
125 changes: 125 additions & 0 deletions
125
app/javascript/components/timeline-options/timeline-helper.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,125 @@ | ||
export const timelineUiOptions = (title) => ({ | ||
title, | ||
axes: { | ||
bottom: { | ||
title: __('Date'), | ||
mapsTo: 'date', | ||
scaleType: 'time', | ||
}, | ||
left: { | ||
title: __('# of Events'), | ||
mapsTo: 'value', | ||
scaleType: 'linear', | ||
/** | ||
* scaleType: "labels" - will only show the values we have (ex. if we have 9 events and 1 event, it will only show 1 and 9 equidistant from eachother) | ||
* scaleType: "linear" - will show all the values including ones we dont have but on smaller cases (ie we only have 1 event) it will show decimals | ||
* ^ fun fact the decimals disappear when you have 1 and *5* events, anything lower renders decimals | ||
*/ | ||
}, | ||
}, | ||
legend: { | ||
clickable: true, | ||
}, | ||
tooltip: { | ||
totalLabel: __('Total Events'), | ||
}, | ||
points: { | ||
radius: 3, | ||
fillOpacity: 1, | ||
filled: true, | ||
enabled: true, | ||
}, | ||
zoomBar: { | ||
top: { | ||
className: 'zoom-bar', | ||
enabled: true, | ||
type: 'graph_view', | ||
}, | ||
}, | ||
height: '400px', | ||
}); | ||
|
||
/** | ||
* | ||
*/ | ||
|
||
const smartAndOrStatements = (group, array) => { | ||
let shortUrl = ''; | ||
if (array.length == 1) { | ||
shortUrl += `&filter[]=${group}=${array[0]}`; | ||
} else { | ||
shortUrl += `&filter[]=${group}=[${array.toString()}]`; | ||
} | ||
return shortUrl; | ||
} | ||
|
||
/** Function to build the URL to get all events that fall under the user selected parameters. */ | ||
export const buildUrl = (values) => { | ||
// TODO: verify that everyone needs / uses the host and ems on the filters | ||
let url = `/api/event_streams?limit=5000&offset=0&expand=resources&attributes=group,group_level,group_name,id,event_type,message,ems_id,type,timestamp,created_on,host,source,ems_id,ext_management_system`; | ||
|
||
url += `&filter[]=type=${values.type}`; | ||
url += smartAndOrStatements('group', values.group); | ||
url += smartAndOrStatements('group_level', values.group_level); | ||
|
||
if (values.start_date) { | ||
url += `&filter[]=timestamp%3E${values.start_date[0].toISOString()}`; | ||
} | ||
if (values.end_date) { | ||
url += `&filter[]=timestamp%3C${values.end_date[0].toISOString()}`; | ||
} | ||
return url; | ||
}; | ||
|
||
/** Function to format the raw data such that it can be used by the Timeline Chart component */ | ||
export const buildChartDataObject = (rawData) => { | ||
// https://codesandbox.io/s/tender-river-9t3vu5?file=/src/index.js | ||
// Here is a link to how a dataset object should look for a timeline | ||
const datasets = []; | ||
rawData.resources.forEach((event) => { | ||
const idx = datasets.findIndex((element) => { | ||
if(element.date === event.timestamp && element.group === event.group_name) { | ||
return true; | ||
} else { | ||
return false; | ||
} | ||
}); | ||
if (datasets[idx]) { | ||
datasets[idx].value += 1; | ||
datasets[idx].eventsObj.push(event) | ||
} else { // idx comes back as -1 when its undefined | ||
const obj = { | ||
group: event.group_name, | ||
date: event.timestamp ? event.timestamp : event.created_on, | ||
value: 1, | ||
eventsObj: [event], | ||
} | ||
datasets.push(obj) | ||
} | ||
}) | ||
return datasets; | ||
}; | ||
|
||
/** Function to go through all the data pulled by the form submit and finds the right objects */ | ||
export const buildDataTableObject = (pointChoice) => { | ||
const tableData = []; | ||
pointChoice.eventsObj.forEach((event) => { | ||
// TODO: something about this event host crashes us | ||
const eventHost = (event.host === null) ? "" : event.host.name; | ||
const eventObj = { | ||
event_type: event.event_type, | ||
source: event.source, | ||
group_level: event.group_level, | ||
provider: '', // hyperlink | ||
provider_username: '', | ||
message: '', | ||
host: eventHost, // hyperlink | ||
source_vm: '', // hyperlink | ||
source_vm_location: '', | ||
timestamp: event.timestamp, // is Zulu time, should copnvert to user's timezone | ||
id: event.id, | ||
}; | ||
tableData.push(eventObj); | ||
}); | ||
return tableData; | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
56 changes: 56 additions & 0 deletions
56
app/javascript/components/timeline-options/timeline-page.jsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
import React, { useState } from 'react'; | ||
import TimelineOptions from './timeline-options'; | ||
import TimelineChart from './timeline-chart'; | ||
import TimelineTable from './timeline-table'; | ||
import NoRecordsFound from '../no-records-found'; | ||
import { buildUrl, buildChartDataObject, buildDataTableObject } from './timeline-helper'; | ||
|
||
const TimelinePage = ({ id }) => { | ||
console.log(id) | ||
|
||
const [{ | ||
timelineFormChoices, timelineResources, timelineChartData, timelineTableData, | ||
}, setState] = useState({ | ||
timelineFormChoices: {}, | ||
timelineResources: [], | ||
timelineChartData: [], | ||
timelineTableData: [], | ||
}); | ||
|
||
const submitChosenFormOptions = (formChoices) => { | ||
API.get(buildUrl(formChoices)).then((chartValues) => { | ||
miqSparkleOff(); // Turning off the sparkle caused by the form onSubmit() | ||
setState((state) => ({ | ||
...state, | ||
timelineFormChoices: formChoices, | ||
timelineResources: chartValues.resources, | ||
timelineChartData: buildChartDataObject(chartValues), | ||
timelineTableData: [], | ||
})); | ||
}); | ||
}; | ||
|
||
const buildTableData = (pointChosen) => { | ||
setState((state) => ({ | ||
...state, | ||
timelineTableData: buildDataTableObject(pointChosen), | ||
})); | ||
}; | ||
|
||
// TODO: Have it be such that on page load its empty, but after pressing submit it would be NoRecordFound | ||
const timelineComponent = timelineChartData.length === 0 ? <NoRecordsFound /> | ||
: <TimelineChart data={timelineChartData} title={__('Timeline Data')} buildTableData={buildTableData} />; | ||
|
||
const timelineTableComponent = timelineTableData.length === 0 ? <></> | ||
: <TimelineTable data={timelineTableData} />; | ||
|
||
return ( | ||
<> | ||
<TimelineOptions submitChosenFormOptions={submitChosenFormOptions} /> | ||
{timelineComponent} | ||
{timelineTableComponent} | ||
</> | ||
); | ||
}; | ||
|
||
export default TimelinePage; |
66 changes: 66 additions & 0 deletions
66
app/javascript/components/timeline-options/timeline-table.jsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
import React from 'react'; | ||
import PropTypes from 'prop-types'; | ||
import MiqDataTable from '../miq-data-table'; | ||
|
||
const TimelineTable = ({ data }) => { | ||
const headers = [ | ||
{ | ||
key: 'event_type', | ||
header: __('Event Type'), | ||
}, { | ||
key: 'source', | ||
header: __('Event Source'), | ||
}, { | ||
key: 'group_level', | ||
header: __('Group Level'), | ||
}, { | ||
key: 'provider', | ||
header: __('Provider'), | ||
}, { | ||
key: 'provider_username', | ||
header: __('Provider User Name'), | ||
}, { | ||
key: 'message', | ||
header: __('Message'), | ||
}, { | ||
key: 'host', | ||
header: __('Source Host'), | ||
}, { | ||
key: 'source_vm', | ||
header: __('Source VM'), | ||
}, { | ||
key: 'source_vm_location', | ||
header: __('Source VM Location'), | ||
}, { | ||
key: 'timestamp', | ||
header: __('Date Time'), | ||
}, | ||
]; | ||
/** | ||
* NOTE: In the original tables, the information displayed was different | ||
* depending from where you accessed the timeline page from | ||
* | ||
* Ex. 'Source VM Location' would now appear on the Host page, but it would | ||
* for the VM & Templates page | ||
*/ | ||
|
||
return ( | ||
<div className="timeline-data-table"> | ||
<MiqDataTable | ||
rows={data} | ||
headers={headers} | ||
/> | ||
</div> | ||
|
||
); | ||
}; | ||
|
||
TimelineTable.propTypes = { | ||
data: PropTypes.arrayOf(PropTypes.any).isRequired, | ||
}; | ||
|
||
TimelineTable.defaultProps = { | ||
data: [], | ||
}; | ||
|
||
export default TimelineTable; |
Oops, something went wrong.