github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 09:48:58 -04:00
Code Issues Projects Releases Packages Wiki Activity

[Enterprise Search] Display user agent in crawl requests table (#140777)

Browse source 
* Display user agent in crawl requests table

* Fix mocks
This commit is contained in:
Byron Hulcher 2022-09-15 09:38:01 -04:00 • committed by GitHub
parent 1709be2d27
commit 5a05def0eb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 60 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

2
x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/api/crawler/_mocks_/crawler.mock.ts
View file

@ -19,10 +19,12 @@ export const CRAWLER_DATA: CrawlerData = {
domains: [CRAWLER_DOMAIN],
events: [CRAWL_EVENT],
mostRecentCrawlRequest: CRAWL_REQUEST,
userAgent: 'Elastic Crawler (0.0.1)',
};
export const CRAWLER_DATA_FROM_SERVER: CrawlerDataFromServer = {
domains: [CRAWLER_DOMAIN_FROM_SERVER],
events: [CRAWL_EVENT_FROM_SERVER],
most_recent_crawl_request: CRAWL_REQUEST_FROM_SERVER,
user_agent: 'Elastic Crawler (0.0.1)',
};

2
x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/api/crawler/types.ts
View file

@ -89,6 +89,7 @@ export interface CrawlerDataFromServer {
domains: CrawlerDomainFromServer[];
events: CrawlEventFromServer[];
most_recent_crawl_request: CrawlRequestFromServer | null;
user_agent: string;
}
export interface CrawlerDomainValidationResultFromServer {
@ -172,6 +173,7 @@ export interface CrawlerData {
domains: CrawlerDomain[];
events: CrawlEvent[];
mostRecentCrawlRequest: CrawlRequest | null;
userAgent: string;
}
export interface CrawlerDomainValidationStep {

8
x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/api/crawler/utils.ts
View file

@ -177,13 +177,19 @@ export function crawlRequestWithDetailsServerToClient(
}
export function crawlerDataServerToClient(payload: CrawlerDataFromServer): CrawlerData {
const { domains, events, most_recent_crawl_request: mostRecentCrawlRequest } = payload;
const {
domains,
events,
most_recent_crawl_request: mostRecentCrawlRequest,
user_agent: userAgent,
} = payload;
return {
domains: domains.map((domain) => crawlerDomainServerToClient(domain)),
events: events.map((event) => crawlEventServerToClient(event)),
mostRecentCrawlRequest:
mostRecentCrawlRequest && crawlRequestServerToClient(mostRecentCrawlRequest),
userAgent,
};
}

69
x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/search_index/crawler/crawl_requests_panel/crawl_requests_panel.tsx
View file

@ -7,29 +7,58 @@
import React from 'react';
import { useValues } from 'kea';
import { EuiCode, EuiLink, EuiPanel, EuiSpacer, EuiText } from '@elastic/eui';
import { i18n } from '@kbn/i18n';
import { DataPanel } from '../../../../../shared/data_panel/data_panel';
import { CrawlerLogic } from '../crawler_logic';
import { CrawlRequestsTable } from './crawl_requests_table';
export const CrawlRequestsPanel: React.FC = () => (
<DataPanel
hasBorder
title={
<h2>
{i18n.translate('xpack.enterpriseSearch.crawler.crawlRequestsPanel.title', {
defaultMessage: 'Crawl requests',
})}
</h2>
}
titleSize="s"
iconType="documents"
subtitle={i18n.translate('xpack.enterpriseSearch.crawler.crawlRequestsPanel.description', {
defaultMessage:
"Recent crawl requests are logged here. You can track progress and examine crawl events in Kibana's Discover or Logs user intefaces",
})}
>
<CrawlRequestsTable />
</DataPanel>
);
export const CrawlRequestsPanel: React.FC = () => {
const { data } = useValues(CrawlerLogic);
return (
<DataPanel
hasBorder
title={
<h2>
{i18n.translate('xpack.enterpriseSearch.crawler.crawlRequestsPanel.title', {
defaultMessage: 'Crawl requests',
})}
</h2>
}
titleSize="s"
iconType="documents"
subtitle={i18n.translate('xpack.enterpriseSearch.crawler.crawlRequestsPanel.description', {
defaultMessage:
"Recent crawl requests are logged here. You can track progress and examine crawl events in Kibana's Discover or Logs user intefaces",
})}
>
<EuiPanel color="subdued">
<EuiText size="s">
{i18n.translate(
'xpack.enterpriseSearch.crawler.crawlRequestsPanel.userAgentDescription',
{
defaultMessage:
'Requests originating from the crawler can be identified by the following User Agent. This is configured in your enterprise-search.yml file.',
}
)}{' '}
<EuiLink target="_blank" href={'' /* needs docLink */}>
{i18n.translate(
'xpack.enterpriseSearch.crawler.crawlRequestsPanel.userAgentDocumentationLink',
{
defaultMessage: 'Learn more about Elastic crawler user agents',
}
)}
</EuiLink>
</EuiText>
<EuiSpacer size="s" />
<EuiCode>{data ? data.userAgent : ''}</EuiCode>
</EuiPanel>
<EuiSpacer />
<CrawlRequestsTable />
</DataPanel>
);
};