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

[8.14] [Search] Add sync status to connector page (#184024) #184315

Merged
merged 1 commit into from
May 27, 2024
Merged

[8.14] [Search] Add sync status to connector page (#184024) #184315

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 2 additions & 4 deletions ...ic/applications/enterprise_search_content/components/connector_detail/connector_stats.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,10 +118,8 @@ export const ConnectorStats: React.FC<ConnectorStatsProps> = ({ connector, index
</EuiText>
</EuiFlexItem>
<EuiFlexItem grow={false}>
<EuiBadge
color={connectorStatusToColor(connector?.status, !!connector?.index_name)}
>
{connectorStatusToText(connector?.status, !!connector?.index_name)}
<EuiBadge color={connectorStatusToColor(connector)}>
{connectorStatusToText(connector)}
</EuiBadge>
</EuiFlexItem>
</EuiFlexGroup>
Expand Down
6 changes: 5 additions & 1 deletion ...pplications/enterprise_search_content/components/connector_detail/connector_view_logic.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,11 @@ export const ConnectorViewLogic = kea<MakeLogicType<ConnectorViewValues, Connect
connectorId: [() => [selectors.connector], (connector) => connector?.id],
error: [
() => [selectors.connector],
(connector: Connector | undefined) => connector?.error || connector?.last_sync_error || null,
(connector: Connector | undefined) =>
connector?.error ||
connector?.last_sync_error ||
connector?.last_access_control_sync_error ||
null,
],
indexName: [
() => [selectors.connector],
Expand Down
5 changes: 4 additions & 1 deletion ...ch/public/applications/enterprise_search_content/components/connector_detail/overview.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,10 @@ export const ConnectorDetailOverview: React.FC = () => {
{connector && connector.service_type !== ENTERPRISE_SEARCH_CONNECTOR_CRAWLER_SERVICE_TYPE && (
<>
<EuiSpacer />
<SyncJobs />
<SyncJobs
errorOnAccessSync={Boolean(connector.last_access_control_sync_error)}
errorOnContentSync={Boolean(connector.last_sync_error)}
/>
</>
)}
</>
Expand Down
1 change: 1 addition & 0 deletions ...h/public/applications/enterprise_search_content/components/connectors/connector_stats.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,7 @@ export const ConnectorStats: React.FC<ConnectorStatsProps> = ({ isCrawler }) =>
<EuiBadge
onClick={() => {}}
onClickAriaLabel={getSyncJobErrorsLabel(errorCount, isCrawler)}
color={errorCount > 0 ? 'danger' : 'default'}
>
{getSyncJobErrorsLabel(errorCount, isCrawler)}
</EuiBadge>
Expand Down
8 changes: 2 additions & 6 deletions .../public/applications/enterprise_search_content/components/connectors/connectors_table.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,12 +135,8 @@ export const ConnectorsTable: React.FC<ConnectorsTableProps> = ({
}
),
render: (connector: ConnectorViewItem) => {
const label = connectorStatusToText(connector.status, !!connector.index_name);
return (
<EuiBadge color={connectorStatusToColor(connector.status, !!connector.index_name)}>
{label}
</EuiBadge>
);
const label = connectorStatusToText(connector);
return <EuiBadge color={connectorStatusToColor(connector)}>{label}</EuiBadge>;
},
truncateText: true,
width: '15%',
Expand Down
6 changes: 5 additions & 1 deletion ...public/applications/enterprise_search_content/components/search_index/index_view_logic.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,11 @@ export const IndexViewLogic = kea<MakeLogicType<IndexViewValues, IndexViewAction
],
error: [
() => [selectors.connector],
(connector: Connector | undefined) => connector?.error || connector?.last_sync_error || null,
(connector: Connector | undefined) =>
connector?.error ||
connector?.last_sync_error ||
connector?.last_access_control_sync_error ||
null,
],
hasAdvancedFilteringFeature: [
() => [selectors.connector],
Expand Down
18 changes: 15 additions & 3 deletions ...search/public/applications/enterprise_search_content/components/search_index/overview.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,11 @@ export const SearchIndexOverview: React.FC = () => {
defaultMessage="Convert it to a {link}, to be self-managed on your own infrastructure. Native connectors are available only in your Elastic Cloud deployment."
values={{
link: (
<EuiLink href={docLinks.buildConnector} target="_blank">
<EuiLink
data-test-subj="enterpriseSearchSearchIndexOverviewConnectorClientLink"
href={docLinks.buildConnector}
target="_blank"
>
{i18n.translate(
'xpack.enterpriseSearch.content.searchIndex.nativeCloudCallout.connectorClient',
{ defaultMessage: 'connector client' }
Expand All @@ -93,7 +97,12 @@ export const SearchIndexOverview: React.FC = () => {
</p>
</EuiText>
<EuiSpacer size="s" />
<EuiButton color="warning" fill onClick={() => showModal()}>
<EuiButton
data-test-subj="enterpriseSearchSearchIndexOverviewConvertConnectorButton"
color="warning"
fill
onClick={() => showModal()}
>
{i18n.translate(
'xpack.enterpriseSearch.content.indices.searchIndex.convertConnector.buttonLabel',
{ defaultMessage: 'Convert connector' }
Expand Down Expand Up @@ -126,7 +135,10 @@ export const SearchIndexOverview: React.FC = () => {
{isConnectorIndex(indexData) && (
<>
<EuiSpacer />
<SyncJobs />
<SyncJobs
errorOnAccessSync={Boolean(indexData.connector.last_access_control_sync_error)}
errorOnContentSync={Boolean(indexData.connector.last_sync_error)}
/>
</>
)}
</>
Expand Down
12 changes: 11 additions & 1 deletion ...ic/applications/enterprise_search_content/components/search_index/sync_jobs/sync_jobs.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,15 @@ import { IndexViewLogic } from '../index_view_logic';

import { SyncJobsViewLogic } from './sync_jobs_view_logic';

export const SyncJobs: React.FC = () => {
export interface SyncJobsProps {
errorOnAccessSync?: boolean;
errorOnContentSync?: boolean;
}

export const SyncJobs: React.FC<SyncJobsProps> = ({
errorOnAccessSync = false,
errorOnContentSync = false,
}) => {
const { hasDocumentLevelSecurityFeature } = useValues(IndexViewLogic);
const { productFeatures } = useValues(KibanaLogic);
const shouldShowAccessSyncs =
Expand Down Expand Up @@ -74,6 +82,7 @@ export const SyncJobs: React.FC = () => {
'xpack.enterpriseSearch.content.syncJobs.lastSync.tableSelector.content.label',
{ defaultMessage: 'Content syncs' }
),
...(errorOnContentSync ? { iconSide: 'right', iconType: 'warning' } : {}),
},

{
Expand All @@ -82,6 +91,7 @@ export const SyncJobs: React.FC = () => {
'xpack.enterpriseSearch.content.syncJobs.lastSync.tableSelector.accessControl.label',
{ defaultMessage: 'Access control syncs' }
),
...(errorOnAccessSync ? { iconSide: 'right', iconType: 'warning' } : {}),
},
]}
/>
Expand Down
37 changes: 25 additions & 12 deletions ...se_search/public/applications/enterprise_search_content/utils/connector_status_helpers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,16 @@
*/

import { i18n } from '@kbn/i18n';
import { ConnectorStatus } from '@kbn/search-connectors';
import { Connector, ConnectorStatus, SyncStatus } from '@kbn/search-connectors';

const incompleteText = i18n.translate(
'xpack.enterpriseSearch.content.searchIndices.ingestionStatus.incomplete.label',
{ defaultMessage: 'Incomplete' }
);

export function connectorStatusToText(
connectorStatus: ConnectorStatus,
hasIndexName: boolean
): string {
export function connectorStatusToText(connector: Connector): string {
const hasIndexName = !!connector.index_name;
const connectorStatus = connector.status;
if (
connectorStatus === ConnectorStatus.CREATED ||
connectorStatus === ConnectorStatus.NEEDS_CONFIGURATION
Expand All @@ -26,6 +25,16 @@ export function connectorStatusToText(
{ defaultMessage: 'Needs Configuration' }
);
}
if (
connector.error === SyncStatus.ERROR ||
connector.last_sync_error !== null ||
connector.last_access_control_sync_error !== null
) {
return i18n.translate(
'xpack.enterpriseSearch.content.searchIndices.connectorStatus.syncFailure.label',
{ defaultMessage: 'Sync Failure' }
);
}
if (connectorStatus === ConnectorStatus.ERROR) {
return i18n.translate(
'xpack.enterpriseSearch.content.searchIndices.connectorStatus.connectorFailure.label',
Expand All @@ -51,18 +60,22 @@ export function connectorStatusToText(
return incompleteText;
}

export function connectorStatusToColor(
connectorStatus: ConnectorStatus,
hasIndexName: boolean
): 'warning' | 'danger' | 'success' {
export function connectorStatusToColor(connector: Connector): 'warning' | 'danger' | 'success' {
const hasIndexName = !!connector.index_name;
const connectorStatus = connector.status;
if (!hasIndexName) {
return 'warning';
}
if (
connectorStatus === ConnectorStatus.ERROR ||
connector.error === SyncStatus.ERROR ||
connector.last_sync_error !== null ||
connector.last_access_control_sync_error !== null
) {
return 'danger';
}
if (connectorStatus === ConnectorStatus.CONNECTED) {
return 'success';
}
if (connectorStatus === ConnectorStatus.ERROR) {
return 'danger';
}
return 'warning';
}
24 changes: 9 additions & 15 deletions x-pack/plugins/enterprise_search/server/utils/get_sync_jobs_queries.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -331,24 +331,18 @@ export const getIncompleteCountQuery = (isCrawler?: boolean) => {
}
return {
bool: {
should: [
{
bool: {
must_not: {
terms: {
status: [ConnectorStatus.CONNECTED, ConnectorStatus.ERROR],
},
},
},
must_not: {
terms: {
status: [ConnectorStatus.CONNECTED, ConnectorStatus.ERROR],
},
{
range: {
last_seen: {
lt: moment().subtract(30, 'minutes').toISOString(),
},
},
must: {
range: {
last_seen: {
lt: moment().subtract(30, 'minutes').toISOString(),
},
},
],
},
filter: [
{
bool: {
Expand Down
Loading