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

Added Time-series indexing (TSDB) to Integrations Experimental Indexing settings #144974

Merged
merged 10 commits into from
Nov 17, 2022
Merged

Added Time-series indexing (TSDB) to Integrations Experimental Indexing settings #144974

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
e2360a9
WIP: TSDB setting
juliaElastic Nov 10, 2022
ab8f60b
moved logic of setting tsdb true by default to one level up
juliaElastic Nov 14, 2022
9c3fe32
Merge branch 'main' into feat/tsdb
kibanamachine Nov 14, 2022
99da806
renamed to lowercase tsdb
juliaElastic Nov 14, 2022
41fe664
fixed test, added unit test
juliaElastic Nov 14, 2022
5646bf5
changed condition to only update comp template on synthetic source ch…
juliaElastic Nov 14, 2022
fc64c1b
added missing index_mode field to package archive parse logic
juliaElastic Nov 15, 2022
980b1b3
generating routing_path from dimension fields
juliaElastic Nov 15, 2022
12801bb
Merge branch 'main' into feat/tsdb
kibanamachine Nov 16, 2022
d764486
Merge branch 'main' into feat/tsdb
kibanamachine Nov 16, 2022
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
2 changes: 1 addition & 1 deletion src/core/server/integration_tests/saved_objects/migrations/check_registered_types.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ describe('checking migration metadata changes on all registered SO types', () =>
"endpoint:user-artifact": "f94c250a52b30d0a2d32635f8b4c5bdabd1e25c0",
"endpoint:user-artifact-manifest": "8c14d49a385d5d1307d956aa743ec78de0b2be88",
"enterprise_search_telemetry": "fafcc8318528d34f721c42d1270787c52565bad5",
"epm-packages": "cb22b422398a785e7e0565a19c6d4d5c7af6f2fd",
"epm-packages": "fe3716a54188b3c71327fa060dd6780a674d3994",
"epm-packages-assets": "9fd3d6726ac77369249e9a973902c2cd615fc771",
"event_loop_delays_daily": "d2ed39cf669577d90921c176499908b4943fb7bd",
"exception-list": "fe8cc004fd2742177cdb9300f4a67689463faf9c",
Expand Down
2 changes: 2 additions & 0 deletions x-pack/plugins/fleet/common/services/simplified_package_policy_helper.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,7 @@ describe('toPackagePolicy', () => {
data_stream: 'logs-nginx.access',
features: {
synthetic_source: true,
tsdb: false,
},
},
],
Expand All @@ -142,6 +143,7 @@ describe('toPackagePolicy', () => {
data_stream: 'logs-nginx.access',
features: {
synthetic_source: true,
tsdb: false,
},
},
]);
Expand Down
3 changes: 2 additions & 1 deletion x-pack/plugins/fleet/common/types/models/epm.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -352,6 +352,7 @@ export interface RegistryElasticsearch {
'index_template.mappings'?: estypes.MappingTypeMapping;
'ingest_pipeline.name'?: string;
source_mode?: 'default' | 'synthetic';
index_mode?: 'time_series';
}

export interface RegistryDataStreamPrivileges {
Expand Down Expand Up @@ -444,7 +445,7 @@ export type PackageInfo =
| Installable<Merge<ArchivePackage, EpmPackageAdditions>>;

// TODO - Expand this with other experimental indexing types
export type ExperimentalIndexingFeature = 'synthetic_source';
export type ExperimentalIndexingFeature = 'synthetic_source' | 'tsdb';

export interface ExperimentalDataStreamFeature {
data_stream: string;
Expand Down
1 change: 1 addition & 0 deletions x-pack/plugins/fleet/common/types/models/package_policy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ export interface NewPackagePolicyInputStream {
privileges?: {
indices?: string[];
};
index_mode?: string;
};
};
release?: RegistryRelease;
Expand Down
36 changes: 36 additions & 0 deletions ...icy/create_package_policy_page/components/steps/components/package_policy_input_panel.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import {
EuiButtonEmpty,
} from '@elastic/eui';

import { getRegistryDataStreamAssetBaseName } from '../../../../../../../../../common/services';
import type {
NewPackagePolicy,
NewPackagePolicyInput,
Expand Down Expand Up @@ -125,6 +126,41 @@ export const PackagePolicyInputPanel: React.FunctionComponent<{
[packageInputStreams, packagePolicyInput.streams]
);

// setting Indexing setting: TSDB to enabled by default, if the data stream's index_mode is set to time_series
let isUpdated = false;
inputStreams.forEach(({ packagePolicyInputStream }) => {
const dataStreamInfo = packageInfo.data_streams?.find(
(ds) => ds.dataset === packagePolicyInputStream?.data_stream.dataset
);

if (dataStreamInfo?.elasticsearch?.index_mode === 'time_series') {
if (!packagePolicy.package) return;
if (!packagePolicy.package?.experimental_data_stream_features)
packagePolicy.package!.experimental_data_stream_features = [];

const dsName = getRegistryDataStreamAssetBaseName(packagePolicyInputStream!.data_stream);
const match = packagePolicy.package!.experimental_data_stream_features.find(
(feat) => feat.data_stream === dsName
);
if (match) {
if (!match.features.tsdb) {
match.features.tsdb = true;
isUpdated = true;
}
} else {
packagePolicy.package!.experimental_data_stream_features.push({
data_stream: dsName,
features: { tsdb: true, synthetic_source: false },
});
isUpdated = true;
}
}
});

if (isUpdated) {
updatePackagePolicy(packagePolicy);
}

return (
<>
{/* Header / input-level toggle */}
Expand Down
132 changes: 88 additions & 44 deletions ...cy/create_package_policy_page/components/steps/components/package_policy_input_stream.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
* 2.0.
*/

import React, { useState, Fragment, memo, useMemo, useEffect, useRef } from 'react';
import React, { useState, Fragment, memo, useMemo, useEffect, useRef, useCallback } from 'react';
import ReactMarkdown from 'react-markdown';
import styled from 'styled-components';
import { FormattedMessage } from '@kbn/i18n-react';
Expand All @@ -18,13 +18,14 @@ import {
EuiSpacer,
EuiButtonEmpty,
EuiTitle,
EuiToolTip,
} from '@elastic/eui';
import { useRouteMatch } from 'react-router-dom';

import { mapPackageReleaseToIntegrationCardRelease } from '../../../../../../../../services/package_prerelease';

import { getRegistryDataStreamAssetBaseName } from '../../../../../../../../../common/services';

import type { ExperimentalIndexingFeature } from '../../../../../../../../../common/types/models/epm';
import type {
NewPackagePolicy,
NewPackagePolicyInputStream,
Expand Down Expand Up @@ -120,6 +121,62 @@ export const PackagePolicyInputStreamConfig = memo<Props>(
[advancedVars, inputStreamValidationResults?.vars]
);

const isFeatureEnabled = useCallback(
(feature: ExperimentalIndexingFeature) =>
packagePolicy.package?.experimental_data_stream_features?.some(
({ data_stream: dataStream, features }) =>
dataStream ===
getRegistryDataStreamAssetBaseName(packagePolicyInputStream.data_stream) &&
features[feature]
) ?? false,
[
packagePolicy.package?.experimental_data_stream_features,
packagePolicyInputStream.data_stream,
]
);

const newExperimentalIndexingFeature = {
synthetic_source: isFeatureEnabled('synthetic_source'),
tsdb: isFeatureEnabled('tsdb'),
};

const onIndexingSettingChange = (
features: Partial<Record<ExperimentalIndexingFeature, boolean>>
) => {
if (!packagePolicy.package) {
return;
}

const newExperimentalDataStreamFeatures = [
...(packagePolicy.package.experimental_data_stream_features ?? []),
];

const dataStream = getRegistryDataStreamAssetBaseName(packagePolicyInputStream.data_stream);

const existingSettingRecord = newExperimentalDataStreamFeatures.find(
(x) => x.data_stream === dataStream
);

if (existingSettingRecord) {
existingSettingRecord.features = {
...existingSettingRecord.features,
...features,
};
} else {
newExperimentalDataStreamFeatures.push({
data_stream: dataStream,
features: { ...newExperimentalIndexingFeature, ...features },
});
}

updatePackagePolicy({
package: {
...packagePolicy.package,
experimental_data_stream_features: newExperimentalDataStreamFeatures,
},
});
};

return (
<>
<EuiFlexGrid columns={2} id={isDefaultDatstream ? 'test123' : 'asas'}>
Expand Down Expand Up @@ -311,59 +368,46 @@ export const PackagePolicyInputStreamConfig = memo<Props>(
<EuiSpacer size="s" />
<EuiFlexItem>
<EuiSwitch
checked={
packagePolicy.package?.experimental_data_stream_features?.some(
({ data_stream: dataStream, features }) =>
dataStream ===
getRegistryDataStreamAssetBaseName(
packagePolicyInputStream.data_stream
) && features.synthetic_source
) ?? false
}
checked={isFeatureEnabled('synthetic_source')}
label={
<FormattedMessage
id="xpack.fleet.createPackagePolicy.experimentalFeatures.syntheticSourceLabel"
defaultMessage="Synthetic source"
/>
}
onChange={(e) => {
if (!packagePolicy.package) {
return;
}

const newExperimentalDataStreamFeatures = [
...(packagePolicy.package.experimental_data_stream_features ?? []),
];

const dataStream = getRegistryDataStreamAssetBaseName(
packagePolicyInputStream.data_stream
);

const existingSettingRecord = newExperimentalDataStreamFeatures.find(
(x) => x.data_stream === dataStream
);

if (existingSettingRecord) {
existingSettingRecord.features.synthetic_source = e.target.checked;
} else {
newExperimentalDataStreamFeatures.push({
data_stream: dataStream,
features: {
synthetic_source: e.target.checked,
},
});
}

updatePackagePolicy({
package: {
...packagePolicy.package,
experimental_data_stream_features:
newExperimentalDataStreamFeatures,
},
onIndexingSettingChange({
synthetic_source: e.target.checked,
});
}}
/>
</EuiFlexItem>
<EuiFlexItem>
<EuiToolTip
content={
<FormattedMessage
id="xpack.fleet.createPackagePolicy.experimentalFeatures.TSDBTooltip"
defaultMessage="Enabling this feature is irreversible"
/>
}
>
<EuiSwitch
disabled={isFeatureEnabled('tsdb')}
checked={isFeatureEnabled('tsdb')}
label={
<FormattedMessage
id="xpack.fleet.createPackagePolicy.experimentalFeatures.TSDBLabel"
defaultMessage="Time-series indexing (TSDB)"
/>
}
onChange={(e) => {
onIndexingSettingChange({
tsdb: e.target.checked,
});
}}
/>
</EuiToolTip>
</EuiFlexItem>
</EuiFlexGroup>
</EuiFlexItem>
</>
Expand Down
1 change: 1 addition & 0 deletions x-pack/plugins/fleet/server/saved_objects/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,6 +284,7 @@ const getSavedObjectTypes = (
type: 'nested',
properties: {
synthetic_source: { type: 'boolean' },
tsdb: { type: 'boolean' },
Copy link
Contributor Author

@juliaElastic juliaElastic Nov 15, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

@elastic/kibana-core @pgayvallet hey, could you approve the change in core? It is due to a new property added to a fleet saved object.

},
},
},
Expand Down
Loading