Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Logs UI] Use short timestamps in the log stream view #47042

Merged
merged 9 commits into from
Oct 17, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions x-pack/legacy/plugins/infra/public/components/formatted_time.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,25 @@ const getFormattedTime = (
return userFormat ? moment(time).format(userFormat) : moment(time).format(fallbackFormat);
};

export const useFormattedTime = (time: number, fallbackFormat?: string) => {
const [dateFormat] = useKibanaUiSetting('dateFormat');
interface UseFormattedTimeOptions {
format?: 'dateTime' | 'time';
fallbackFormat?: string;
}

export const useFormattedTime = (
time: number,
{ format = 'dateTime', fallbackFormat }: UseFormattedTimeOptions = {}
) => {
// `dateFormat:scaled` is an array of `[key, format]` tuples.
// The hook might return `undefined`, so use a sane default for the `find` later.
const scaledTuples = useKibanaUiSetting('dateFormat:scaled')[0] || [['', undefined]];

const formatMap = {
dateTime: useKibanaUiSetting('dateFormat')[0],
time: scaledTuples.find(([key]: [string, string]) => key === '')[1],
};

const dateFormat = formatMap[format];
const formattedTime = useMemo(() => getFormattedTime(time, dateFormat, fallbackFormat), [
getFormattedTime,
time,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
*/

import React from 'react';
import { transparentize } from 'polished';

import euiStyled from '../../../../../../common/eui_styled_components';
import {
Expand All @@ -20,6 +21,8 @@ import {
LogEntryColumnWidths,
} from './log_entry_column';
import { ASSUMED_SCROLLBAR_WIDTH } from './vertical_scroll_panel';
import { WithLogPosition } from '../../../containers/logs/with_log_position';
import { localizedDate } from '../../../utils/formatters/datetime';

export const LogColumnHeaders: React.FunctionComponent<{
columnConfigurations: LogColumnConfiguration[];
Expand All @@ -30,13 +33,16 @@ export const LogColumnHeaders: React.FunctionComponent<{
{columnConfigurations.map(columnConfiguration => {
if (isTimestampLogColumnConfiguration(columnConfiguration)) {
return (
<LogColumnHeader
columnWidth={columnWidths[columnConfiguration.timestampColumn.id]}
data-test-subj="logColumnHeader timestampLogColumnHeader"
key={columnConfiguration.timestampColumn.id}
>
Timestamp
</LogColumnHeader>
<WithLogPosition key={columnConfiguration.timestampColumn.id}>
{({ firstVisiblePosition }) => (
<LogColumnHeader
columnWidth={columnWidths[columnConfiguration.timestampColumn.id]}
data-test-subj="logColumnHeader timestampLogColumnHeader"
>
{firstVisiblePosition ? localizedDate(firstVisiblePosition.time) : 'Timestamp'}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 I like that localizedDate is a utility function which can be used directly, by hooks, etc

</LogColumnHeader>
)}
</WithLogPosition>
);
} else if (isMessageLogColumnConfiguration(columnConfiguration)) {
return (
Expand Down Expand Up @@ -83,13 +89,16 @@ const LogColumnHeadersWrapper = euiStyled.div.attrs({
justify-content: flex-start;
overflow: hidden;
padding-right: ${ASSUMED_SCROLLBAR_WIDTH}px;
border-bottom: ${props => props.theme.eui.euiBorderThin};
box-shadow: 0 2px 2px -1px ${props => transparentize(0.3, props.theme.eui.euiColorLightShade)};
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we could use the euiSlightShadow mixin here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we could use the euiSlightShadow mixin here.

I'm not sure that can be done with the CSS-in-JS library we use. I'll give it a shot

position: relative;
z-index: 1;
`;

const LogColumnHeaderWrapper = LogEntryColumn.extend.attrs({
role: 'columnheader',
})`
align-items: center;
border-bottom: ${props => props.theme.eui.euiBorderThick};
display: flex;
flex-direction: row;
height: 32px;
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License;
* you may not use this file except in compliance with the Elastic License.
*/
import React from 'react';
import { EuiFlexGroup, EuiFlexItem, EuiHorizontalRule, EuiTitle } from '@elastic/eui';
import { localizedDate } from '../../../utils/formatters/datetime';

interface LogDateRowProps {
timestamp: number;
}

/**
* Show a row with the date in the log stream
*/
export const LogDateRow: React.FC<LogDateRowProps> = ({ timestamp }) => {
const formattedDate = localizedDate(timestamp);

return (
<EuiFlexGroup alignItems="center" gutterSize="s">
<EuiFlexItem grow={false}>
<EuiTitle size="xxs">
<h2 style={{ paddingLeft: 8 }}>{formattedDate}</h2>
</EuiTitle>
</EuiFlexItem>
<EuiFlexItem>
<EuiHorizontalRule />
</EuiFlexItem>
</EuiFlexGroup>
);
};
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ interface LogEntryTimestampColumnProps {

export const LogEntryTimestampColumn = memo<LogEntryTimestampColumnProps>(
({ isHighlighted, isHovered, time }) => {
const formattedTime = useFormattedTime(time);
const formattedTime = useFormattedTime(time, { format: 'time' });

return (
<TimestampColumnContent isHovered={isHovered} isHighlighted={isHighlighted}>
Expand All @@ -45,11 +45,8 @@ const TimestampColumnContent = LogEntryColumnContent.extend.attrs<{
isHovered: boolean;
isHighlighted: boolean;
}>({})`
background-color: ${props => props.theme.eui.euiColorLightestShade};
border-right: solid 2px ${props => props.theme.eui.euiColorLightShade};
color: ${props => props.theme.eui.euiColorDarkShade};
overflow: hidden;
text-align: right;
text-overflow: clip;
white-space: pre;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@

import { i18n } from '@kbn/i18n';
import { FormattedMessage } from '@kbn/i18n/react';
import React, { useMemo } from 'react';
import React, { Fragment, useMemo } from 'react';
import moment from 'moment';

import euiStyled from '../../../../../../common/eui_styled_components';
import { TextScale } from '../../../../common/log_text_scale';
Expand All @@ -26,6 +27,7 @@ import { MeasurableItemView } from './measurable_item_view';
import { VerticalScrollPanel } from './vertical_scroll_panel';
import { getColumnWidths, LogEntryColumnWidths } from './log_entry_column';
import { useMeasuredCharacterDimensions } from './text_styles';
import { LogDateRow } from './log_date_row';

interface ScrollableLogTextStreamViewProps {
columnConfigurations: LogColumnConfiguration[];
Expand Down Expand Up @@ -188,35 +190,47 @@ export class ScrollableLogTextStreamView extends React.PureComponent<
isStreaming={false}
lastStreamingUpdate={null}
/>
{items.map(item => (
<MeasurableItemView
register={registerChild}
registrationKey={getStreamItemId(item)}
key={getStreamItemId(item)}
>
{itemMeasureRef => (
<LogEntryRow
columnConfigurations={columnConfigurations}
columnWidths={columnWidths}
openFlyoutWithItem={this.handleOpenFlyout}
boundingBoxRef={itemMeasureRef}
logEntry={item.logEntry}
highlights={item.highlights}
isActiveHighlight={
!!currentHighlightKey &&
currentHighlightKey.gid === item.logEntry.gid
}
scale={scale}
wrap={wrap}
isHighlighted={
highlightedItem
? item.logEntry.gid === highlightedItem
: false
}
/>
)}
</MeasurableItemView>
))}
{items.map((item, idx) => {
const currentTimestamp = item.logEntry.key.time;
let showDate = false;

if (idx > 0) {
const prevTimestamp = items[idx - 1].logEntry.key.time;
showDate = !moment(currentTimestamp).isSame(prevTimestamp, 'day');
}

return (
<Fragment key={getStreamItemId(item)}>
{showDate && <LogDateRow timestamp={currentTimestamp} />}
<MeasurableItemView
register={registerChild}
registrationKey={getStreamItemId(item)}
>
{itemMeasureRef => (
<LogEntryRow
columnConfigurations={columnConfigurations}
columnWidths={columnWidths}
openFlyoutWithItem={this.handleOpenFlyout}
boundingBoxRef={itemMeasureRef}
logEntry={item.logEntry}
highlights={item.highlights}
isActiveHighlight={
!!currentHighlightKey &&
currentHighlightKey.gid === item.logEntry.gid
}
scale={scale}
wrap={wrap}
isHighlighted={
highlightedItem
? item.logEntry.gid === highlightedItem
: false
}
/>
)}
</MeasurableItemView>
</Fragment>
);
})}
<LogTextStreamLoadingItemView
alignment="top"
isLoading={isStreaming || isLoadingMore}
Expand Down Expand Up @@ -326,7 +340,7 @@ const WithColumnWidths: React.FunctionComponent<{
}> = ({ children, columnConfigurations, scale }) => {
const { CharacterDimensionsProbe, dimensions } = useMeasuredCharacterDimensions(scale);
const referenceTime = useMemo(() => Date.now(), []);
const formattedCurrentDate = useFormattedTime(referenceTime);
const formattedCurrentDate = useFormattedTime(referenceTime, { format: 'time' });
const columnWidths = useMemo(
() => getColumnWidths(columnConfigurations, dimensions.width, formattedCurrentDate.length),
[columnConfigurations, dimensions.width, formattedCurrentDate]
Expand Down
17 changes: 17 additions & 0 deletions x-pack/legacy/plugins/infra/public/utils/formatters/datetime.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License;
* you may not use this file except in compliance with the Elastic License.
*/

import { i18n } from '@kbn/i18n';

export function localizedDate(dateTime: number | Date, locale: string = i18n.getLocale()) {
const formatter = new Intl.DateTimeFormat(locale, {
year: 'numeric',
month: 'short',
day: 'numeric',
});

return formatter.format(dateTime);
}
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => {
await pageObjects.common.navigateToActualUrl('infraLogs', 'logs/stream');
const columnHeaderLabels = await infraLogStream.getColumnHeaderLabels();

expect(columnHeaderLabels).to.eql(['Timestamp', 'event.dataset', 'Message']);
expect(columnHeaderLabels).to.eql(['Oct 17, 2018', 'event.dataset', 'Message']);

const logStreamEntries = await infraLogStream.getStreamEntries();
expect(logStreamEntries.length).to.be.greaterThan(0);
Expand Down Expand Up @@ -98,7 +98,7 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => {

// TODO: make test more robust
// expect(columnHeaderLabels).to.eql(['host.name', 'Timestamp']);
expect(columnHeaderLabels).to.eql(['Timestamp', 'host.name']);
expect(columnHeaderLabels).to.eql(['Oct 17, 2018', 'host.name']);

const logStreamEntries = await infraLogStream.getStreamEntries();

Expand Down