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

[Infrastructure UI] Hosts view: Add links to apm and uptime for a single host #154269

Merged
Show file tree
Hide file tree
Changes from 12 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
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,29 @@
*/

import React from 'react';
import { EuiFlyout, EuiFlyoutHeader, EuiTitle, EuiFlyoutBody } from '@elastic/eui';
import { EuiSpacer, EuiTabs, EuiTab } from '@elastic/eui';
import {
EuiFlyout,
EuiFlyoutHeader,
EuiTitle,
EuiFlyoutBody,
EuiFlexGroup,
EuiFlexItem,
EuiLink,
EuiTab,
EuiSpacer,
EuiTabs,
} from '@elastic/eui';
import { EuiIcon } from '@elastic/eui';
import { FormattedMessage } from '@kbn/i18n-react';
import { css } from '@emotion/react';
import { useKibanaContextForPlugin } from '../../../../../hooks/use_kibana';
import { useUnifiedSearchContext } from '../../hooks/use_unified_search';
import { navigateToUptime } from './links/navigate_to_uptime';
import { LinkToApmServices } from './links/link_to_apm_services';
import { useLazyRef } from '../../../../../hooks/use_lazy_ref';
import { metadataTab } from './metadata';
import type { InventoryItemType } from '../../../../../../common/inventory_models/types';
import type { HostNodeRow } from '../../hooks/use_hosts_table';
import { useUnifiedSearchContext } from '../../hooks/use_unified_search';
import { processesTab } from './processes';
import { Metadata } from './metadata/metadata';
import { Processes } from './processes/processes';
Expand All @@ -28,6 +44,7 @@ const NODE_TYPE = 'host' as InventoryItemType;

export const Flyout = ({ node, closeFlyout }: Props) => {
const { getDateRangeAsTimestamp } = useUnifiedSearchContext();
const { share } = useKibanaContextForPlugin().services;

const currentTimeRange = {
...getDateRangeAsTimestamp(),
Expand Down Expand Up @@ -57,9 +74,33 @@ export const Flyout = ({ node, closeFlyout }: Props) => {
return (
<EuiFlyout onClose={closeFlyout} ownFocus={false}>
<EuiFlyoutHeader hasBorder>
<EuiTitle size="xs">
<h2>{node.name}</h2>
</EuiTitle>
<EuiFlexGroup justifyContent="spaceBetween">
<EuiFlexItem>
<EuiTitle size="xs">
<h2>{node.name}</h2>
</EuiTitle>
</EuiFlexItem>
<EuiFlexItem grow={false}>
<LinkToApmServices hostName={node.name} apmField={'host.hostname'} />
</EuiFlexItem>
<EuiFlexItem
grow={false}
css={css`
padding-right: 20px;
`}
Copy link
Contributor

Choose a reason for hiding this comment

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

Perhaps we could use euiTheme standards instead. wdyt?

{css`
    margin-right: ${euiTheme.size.l};
`}

euiTheme.size.l -> 24px

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, looks fine also with 24px, changed 👍

>
<EuiLink
data-test-subj="infraHostsViewFlyoutUptimeLink"
Copy link
Contributor

Choose a reason for hiding this comment

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

I guess the naming standard for data-test-subj is hostsView-flyout-uptime-link. It starts with hostsView instead of infraHosts and in most places is separated by -.

Copy link
Contributor

Choose a reason for hiding this comment

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

I guess the conventions here mentions its without -
but you are right most of the places already has it with dashes

Copy link
Contributor

@crespocarlos crespocarlos Apr 5, 2023

Choose a reason for hiding this comment

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

Yeah. It's probably too late to change those places with dashes since telemetry is already being collected. Unless Roshan hasn't done anything with it yet, then we might be able to standardise it (or change the convention).

Or since the feature is not GA, we may have some room to fix where it's not following the convention.

Copy link
Member Author

Choose a reason for hiding this comment

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

Hmm yeah, I saw the telemetry guide that's why I used that naming convention - also mentioned in the processes PR But as this is only used in the hosts view I can change to hostsView way and we can migrate together with the others maybe 🤔

Copy link
Member Author

Choose a reason for hiding this comment

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

Renamed here

onClick={() => navigateToUptime(share.url.locators, NODE_TYPE, node)}
>
<EuiIcon type="popout" />{' '}
jennypavlova marked this conversation as resolved.
Show resolved Hide resolved
<FormattedMessage
id="xpack.infra.hostsViewPage.flyout.uptimeLinkLabel"
defaultMessage="Uptime"
/>
</EuiLink>
</EuiFlexItem>
</EuiFlexGroup>
<EuiSpacer size="s" />
<EuiTabs style={{ marginBottom: '-25px' }} size="s">
{tabEntries}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0; you may not use this file except in compliance with the Elastic License
* 2.0.
*/
import React from 'react';
import { stringify } from 'querystring';
import { encode } from '@kbn/rison';
import { RedirectAppLinks } from '@kbn/shared-ux-link-redirect-app';
import { EuiIcon, EuiLink } from '@elastic/eui';
import { FormattedMessage } from '@kbn/i18n-react';
import { useKibanaContextForPlugin } from '../../../../../../hooks/use_kibana';

interface LinkToApmServicesProps {
hostName: string;
apmField: string;
}

export const LinkToApmServices = ({ hostName, apmField }: LinkToApmServicesProps) => {
const { services } = useKibanaContextForPlugin();
const { http } = services;

const queryString = new URLSearchParams(
encode(
stringify({
kuery: `${apmField}:"${hostName}"`,
})
)
);

const linkToApmServices = http.basePath.prepend(`/app/apm/services?${queryString}`);

return (
<RedirectAppLinks coreStart={services}>
<EuiLink href={linkToApmServices} data-test-subj="infraHostsViewFlyoutApmServicesLink">
<EuiIcon type="popout" />{' '}
jennypavlova marked this conversation as resolved.
Show resolved Hide resolved
<FormattedMessage
id="xpack.infra.hostsViewPage.flyout.apmServicesLinkLabel"
defaultMessage="APM Services"
/>
</EuiLink>
</RedirectAppLinks>
);
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0; you may not use this file except in compliance with the Elastic License
* 2.0.
*/

import { uptimeOverviewLocatorID } from '@kbn/observability-plugin/public';
import { LocatorClient } from '@kbn/share-plugin/common/url_service/locators';
import type { InventoryItemType } from '../../../../../../../common/inventory_models/types';
import type { HostNodeRow } from '../../../hooks/use_hosts_table';

export const navigateToUptime = (
locators: LocatorClient,
nodeType: InventoryItemType,
node: HostNodeRow
) => {
return locators.get(uptimeOverviewLocatorID)!.navigate({ [nodeType]: node.name, ip: node.ip });
Copy link
Contributor

Choose a reason for hiding this comment

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

How about creating a link component here that knows how to redirect to Uptime, similar to the link_to_apm_services? flyOut component wouldn't need to worry about the details to redirect to uptime.

Copy link
Member Author

Choose a reason for hiding this comment

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

Good idea, thanks! I moved it to a separate component like the APM link 👍

};
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ describe('useHostTable hook', () => {
{
name: 'host-0',
os: '-',
ip: '',
id: 'host-0-0',
title: {
cloudProvider: 'aws',
Expand Down Expand Up @@ -103,6 +104,7 @@ describe('useHostTable hook', () => {
{
name: 'host-1',
os: 'macOS',
ip: '243.86.94.22',
id: 'host-1-1',
title: {
cloudProvider: null,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ type HostMetrics = Record<HostMetric, SnapshotNodeMetric>;

export interface HostNodeRow extends HostMetrics {
os?: string | null;
ip?: string | null;
servicesOnHost?: number | null;
title: { name: string; cloudProvider?: CloudProvider | null };
name: string;
Expand All @@ -53,6 +54,7 @@ const buildItemsList = (nodes: SnapshotNode[]) => {
id: `${name}-${index}`,
name,
os: path.at(-1)?.os ?? '-',
ip: path.at(-1)?.ip ?? '',
title: {
name,
cloudProvider: path.at(-1)?.cloudProvider ?? null,
Expand Down
20 changes: 20 additions & 0 deletions x-pack/test/functional/apps/infra/hosts_view.ts
Original file line number Diff line number Diff line change
Expand Up @@ -243,6 +243,26 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => {
expect(metadataTab).to.contain('Metadata');
});

it('should navigate to Uptime after click', async () => {
await pageObjects.infraHostsView.clickFlyoutUptimeLink();
await pageObjects.infraHome.waitForLoading();
const url = await browser.getCurrentUrl();
expect(url).to.contain(
'app/uptime/?search=host.name%3A%20%22Jennys-MBP.fritz.box%22%20OR%20host.ip%3A%20%22192.168.1.79%22'
);
await browser.goBack();
await pageObjects.infraHome.waitForLoading();
});

it('should navigate to APM services after click', async () => {
await pageObjects.infraHostsView.clickFlyoutApmServicesLink();
await pageObjects.infraHome.waitForLoading();
const url = await browser.getCurrentUrl();
expect(url).to.contain('app/apm/services?kuery=host.hostname%3A%22Jennys-MBP.fritz.box%22');
await browser.goBack();
await pageObjects.infraHome.waitForLoading();
});

describe('should render processes tab', async () => {
const processTitles = [
'Total processes',
Expand Down
8 changes: 8 additions & 0 deletions x-pack/test/functional/page_objects/infra_hosts_view.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,14 @@ export function InfraHostsViewProvider({ getService }: FtrProviderContext) {
return testSubjects.click('infraProcessRowButton');
},

async clickFlyoutUptimeLink() {
return testSubjects.click('infraHostsViewFlyoutUptimeLink');
},

async clickFlyoutApmServicesLink() {
return testSubjects.click('infraHostsViewFlyoutApmServicesLink');
},

async getHostsLandingPageDisabled() {
const container = await testSubjects.find('hostView-no-enable-access');
const containerText = await container.getVisibleText();
Expand Down