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.

Sign up for GitHub

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

Jump to bottom

[APM] Use doc link service instead of ElasticDocsLink #109027

Merged
merged 3 commits into from
Sep 1, 2021
Merged

[APM] Use doc link service instead of ElasticDocsLink #109027

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e5a157a
[APM] Use doc link service in APM service maps
lcawl Aug 18, 2021
10ad369
Adds docLinksServiceMock to apm plugin context
lcawl Aug 19, 2021
a08746a
Revert use of mock doc link service
lcawl Aug 31, 2021
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
4 changes: 4 additions & 0 deletions docs/development/core/public/kibana-plugin-core-public.doclinksstart.links.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@
```typescript
readonly links: {
readonly settings: string;
readonly apm: {
readonly kibanaSettings: string;
readonly supportedServiceMaps: string;
};
readonly canvas: {
readonly guide: string;
};
Expand Down
8 changes: 8 additions & 0 deletions src/core/public/doc_links/doc_links_service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ export class DocLinksService {
ELASTIC_WEBSITE_URL,
links: {
settings: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/settings.html`,
apm: {
kibanaSettings: `${KIBANA_DOCS}apm-settings-in-kibana.html`,
supportedServiceMaps: `${KIBANA_DOCS}service-maps.html#service-maps-supported`,
},
canvas: {
guide: `${KIBANA_DOCS}canvas.html`,
},
Expand Down Expand Up @@ -451,6 +455,10 @@ export interface DocLinksStart {
readonly ELASTIC_WEBSITE_URL: string;
readonly links: {
readonly settings: string;
readonly apm: {
readonly kibanaSettings: string;
readonly supportedServiceMaps: string;
};
readonly canvas: {
readonly guide: string;
};
Expand Down
4 changes: 4 additions & 0 deletions src/core/public/public.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -473,6 +473,10 @@ export interface DocLinksStart {
// (undocumented)
readonly links: {
readonly settings: string;
readonly apm: {
readonly kibanaSettings: string;
readonly supportedServiceMaps: string;
};
readonly canvas: {
readonly guide: string;
};
Expand Down
12 changes: 5 additions & 7 deletions x-pack/plugins/apm/public/components/app/service_map/EmptyBanner.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@
*/

import React, { useContext, useEffect, useState } from 'react';
import { EuiCallOut } from '@elastic/eui';
import { EuiCallOut, EuiLink } from '@elastic/eui';
import { i18n } from '@kbn/i18n';
import { euiStyled } from '../../../../../../../src/plugins/kibana_react/common';
import { ElasticDocsLink } from '../../shared/Links/ElasticDocsLink';
import { CytoscapeContext } from './Cytoscape';
import { useTheme } from '../../../hooks/use_theme';
import { useApmPluginContext } from '../../../context/apm_plugin/use_apm_plugin_context';

const EmptyBannerContainer = euiStyled.div`
margin: ${({ theme }) => theme.eui.gutterTypes.gutterSmall};
Expand All @@ -28,6 +28,7 @@ export function EmptyBanner() {
const theme = useTheme();
const cy = useContext(CytoscapeContext);
const [nodeCount, setNodeCount] = useState(0);
const { docLinks } = useApmPluginContext().core;

useEffect(() => {
const handler: cytoscape.EventHandler = (event) =>
Expand Down Expand Up @@ -67,14 +68,11 @@ export function EmptyBanner() {
defaultMessage:
"We will map out connected services and external requests if we can detect them. Please make sure you're running the latest version of the APM agent.",
})}{' '}
<ElasticDocsLink
section="/kibana"
path="/service-maps.html#service-maps-supported"
>
<EuiLink href={docLinks.links.apm.supportedServiceMaps}>
{i18n.translate('xpack.apm.serviceMap.emptyBanner.docsLink', {
defaultMessage: 'Learn more in the docs',
})}
</ElasticDocsLink>
</EuiLink>
</EuiCallOut>
</EmptyBannerContainer>
);
Expand Down
9 changes: 5 additions & 4 deletions x-pack/plugins/apm/public/components/app/service_map/timeout_prompt.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
* 2.0.
*/

import { EuiEmptyPrompt } from '@elastic/eui';
import { EuiEmptyPrompt, EuiLink } from '@elastic/eui';
import { i18n } from '@kbn/i18n';
import React from 'react';
import { ElasticDocsLink } from '../../shared/Links/ElasticDocsLink';
import { useApmPluginContext } from '../../../context/apm_plugin/use_apm_plugin_context';

export function TimeoutPrompt({
isGlobalServiceMap,
Expand Down Expand Up @@ -44,11 +44,12 @@ export function TimeoutPrompt({
}

function ApmSettingsDocLink() {
const { docLinks } = useApmPluginContext().core;
return (
<ElasticDocsLink section="/kibana" path="/apm-settings-in-kibana.html">
<EuiLink href={docLinks.links.apm.kibanaSettings}>
{i18n.translate('xpack.apm.serviceMap.timeoutPrompt.docsLink', {
defaultMessage: 'Learn more about APM settings in the docs',
})}
</ElasticDocsLink>
</EuiLink>
);
}
3 changes: 3 additions & 0 deletions x-pack/plugins/apm/public/context/apm_plugin/mock_apm_plugin_context.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,9 @@ const mockCore = {
docLinks: {
DOC_LINK_VERSION: '0',
ELASTIC_WEBSITE_URL: 'https://www.elastic.co/',
links: {
apm: {},
},
},
http: {
basePath: {
Expand Down