Skip to content

feat(slo): Add index sorting on SLI and split per day #244978

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
+136 −86
Open

feat(slo): Add index sorting on SLI and split per day #244978

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c8e092f
Implement daily rollup and index sorting
kdelemme Dec 2, 2025
7cd48a1
Add sort order
kdelemme Dec 2, 2025
3ac0add
Update tests
kdelemme Dec 2, 2025
6c7c9a4
Fix integration tests
kdelemme Dec 3, 2025
00e7e75
Remove sorting on id
kdelemme Dec 3, 2025
669e83c
Merge branch 'main' into poc/slo-resources-installation
kdelemme Dec 3, 2025
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
20 changes: 11 additions & 9 deletions x-pack/solutions/observability/plugins/slo/common/constants.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,21 +56,23 @@ export const SUPPRESSED_PRIORITY_ACTION = {
export const LOCK_ID_RESOURCE_INSTALLER = 'slo:resource_installer';

export const SLO_MODEL_VERSION = 2;
export const SLO_RESOURCES_VERSION = 3.5;
export const SLO_RESOURCES_VERSION = 3.6;
export const SLO_RESOURCES_VERSION_MAJOR = 3;

export const SLI_COMPONENT_TEMPLATE_MAPPINGS_NAME = '.slo-observability.sli-mappings';
export const SLI_COMPONENT_TEMPLATE_SETTINGS_NAME = '.slo-observability.sli-settings';
export const SLI_INDEX_TEMPLATE_NAME = '.slo-observability.sli';
export const SLI_INDEX_TEMPLATE_PATTERN = `.slo-observability.sli-*`;
export const SLI_COMPONENT_TEMPLATE_MAPPINGS_NAME = `.slo-observability.sli-mappings-v${SLO_RESOURCES_VERSION}`;
export const SLI_COMPONENT_TEMPLATE_SETTINGS_NAME = `.slo-observability.sli-settings-v${SLO_RESOURCES_VERSION}`;

export const SLI_INDEX_TEMPLATE_NAME = `.slo-observability.sli-v${SLO_RESOURCES_VERSION}`;
export const SLI_INDEX_TEMPLATE_PATTERN = `.slo-observability.sli-v${SLO_RESOURCES_VERSION}*`;
export const SLI_DESTINATION_INDEX_NAME = `.slo-observability.sli-v${SLO_RESOURCES_VERSION}`;
export const SLI_DESTINATION_INDEX_PATTERN = `.slo-observability.sli-v${SLO_RESOURCES_VERSION_MAJOR}*`;

export const SLI_INGEST_PIPELINE_INDEX_NAME_PREFIX = `.slo-observability.sli-v${SLO_RESOURCES_VERSION}.`;

export const SUMMARY_COMPONENT_TEMPLATE_MAPPINGS_NAME = '.slo-observability.summary-mappings';
export const SUMMARY_COMPONENT_TEMPLATE_SETTINGS_NAME = '.slo-observability.summary-settings';
export const SUMMARY_INDEX_TEMPLATE_NAME = '.slo-observability.summary';
export const SUMMARY_INDEX_TEMPLATE_PATTERN = `.slo-observability.summary-*`;
export const SUMMARY_COMPONENT_TEMPLATE_MAPPINGS_NAME = `.slo-observability.summary-mappings-v${SLO_RESOURCES_VERSION}`;
export const SUMMARY_COMPONENT_TEMPLATE_SETTINGS_NAME = `.slo-observability.summary-settings-v${SLO_RESOURCES_VERSION}`;
export const SUMMARY_INDEX_TEMPLATE_NAME = `.slo-observability.summary-v${SLO_RESOURCES_VERSION}`;
export const SUMMARY_INDEX_TEMPLATE_PATTERN = `.slo-observability.summary-v${SLO_RESOURCES_VERSION}*`;
export const SUMMARY_DESTINATION_INDEX_NAME = `.slo-observability.summary-v${SLO_RESOURCES_VERSION}`; // store the summary document generated by transform
export const SUMMARY_TEMP_INDEX_NAME = `.slo-observability.summary-v${SLO_RESOURCES_VERSION}.temp`; // store the temporary summary document
export const SUMMARY_DESTINATION_INDEX_PATTERN = `.slo-observability.summary-v${SLO_RESOURCES_VERSION_MAJOR}*`; // include temp and non-temp summary indices
Expand Down
5 changes: 4 additions & 1 deletion ...ions/observability/plugins/slo/server/assets/component_templates/sli_settings_template.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,18 @@
* 2.0.
*/

import type { ClusterPutComponentTemplateRequest } from '@elastic/elasticsearch/lib/api/types';
import {
SLI_COMPONENT_TEMPLATE_SETTINGS_NAME,
SLO_RESOURCES_VERSION,
} from '../../../common/constants';

export const SLI_SETTINGS_TEMPLATE = {
export const SLI_SETTINGS_TEMPLATE: ClusterPutComponentTemplateRequest = {
name: SLI_COMPONENT_TEMPLATE_SETTINGS_NAME,
template: {
settings: {
'sort.field': ['slo.id', 'slo.revision', 'slo.instanceId'],
'sort.order': ['asc', 'asc', 'asc'],
auto_expand_replicas: '0-1',
hidden: true,
},
Expand Down
3 changes: 2 additions & 1 deletion .../observability/plugins/slo/server/assets/component_templates/summary_settings_template.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,13 @@
* 2.0.
*/

import type { ClusterPutComponentTemplateRequest } from '@elastic/elasticsearch/lib/api/types';
import {
SLO_RESOURCES_VERSION,
SUMMARY_COMPONENT_TEMPLATE_SETTINGS_NAME,
} from '../../../common/constants';

export const SUMMARY_SETTINGS_TEMPLATE = {
export const SUMMARY_SETTINGS_TEMPLATE: ClusterPutComponentTemplateRequest = {
name: SUMMARY_COMPONENT_TEMPLATE_SETTINGS_NAME,
template: {
settings: {
Expand Down
5 changes: 3 additions & 2 deletions ...k/solutions/observability/plugins/slo/server/assets/index_templates/sli_index_template.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
* 2.0.
*/

import type { IndicesPutIndexTemplateRequest } from '@elastic/elasticsearch/lib/api/types';
import {
SLI_COMPONENT_TEMPLATE_MAPPINGS_NAME,
SLI_COMPONENT_TEMPLATE_SETTINGS_NAME,
Expand All @@ -13,11 +14,11 @@ import {
SLO_RESOURCES_VERSION,
} from '../../../common/constants';

export const SLI_INDEX_TEMPLATE = {
export const SLI_INDEX_TEMPLATE: IndicesPutIndexTemplateRequest = {
name: SLI_INDEX_TEMPLATE_NAME,
index_patterns: [SLI_INDEX_TEMPLATE_PATTERN],
composed_of: [SLI_COMPONENT_TEMPLATE_MAPPINGS_NAME, SLI_COMPONENT_TEMPLATE_SETTINGS_NAME],
priority: 500,
priority: 600,
Copy link
Contributor Author

@kdelemme kdelemme Dec 3, 2025

Choose a reason for hiding this comment

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

To override the previous index template matching on broader index pattern, e.g. .slo-observability.sli-* instead of .slo-observability.sli-v3.6* like now

_meta: {
description: 'Template for SLO rollup data',
version: SLO_RESOURCES_VERSION,
Expand Down
5 changes: 3 additions & 2 deletions ...lutions/observability/plugins/slo/server/assets/index_templates/summary_index_template.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
* 2.0.
*/

import type { IndicesPutIndexTemplateRequest } from '@elastic/elasticsearch/lib/api/types';
import {
SLO_RESOURCES_VERSION,
SUMMARY_COMPONENT_TEMPLATE_MAPPINGS_NAME,
Expand All @@ -13,11 +14,11 @@ import {
SUMMARY_INDEX_TEMPLATE_PATTERN,
} from '../../../common/constants';

export const SUMMARY_INDEX_TEMPLATE = {
export const SUMMARY_INDEX_TEMPLATE: IndicesPutIndexTemplateRequest = {
name: SUMMARY_INDEX_TEMPLATE_NAME,
index_patterns: [SUMMARY_INDEX_TEMPLATE_PATTERN],
composed_of: [SUMMARY_COMPONENT_TEMPLATE_MAPPINGS_NAME, SUMMARY_COMPONENT_TEMPLATE_SETTINGS_NAME],
priority: 500,
priority: 600,
_meta: {
description: 'SLO summary index template',
version: SLO_RESOURCES_VERSION,
Expand Down
26 changes: 20 additions & 6 deletions ...ugins/slo/server/assets/ingest_templates/__snapshots__/sli_pipeline_template.test.ts.snap
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 8 additions & 1 deletion ...lutions/observability/plugins/slo/server/assets/ingest_templates/sli_pipeline_template.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ export const getSLIPipelineTemplate = (
date_index_name: {
field: '@timestamp',
index_name_prefix: SLI_INGEST_PIPELINE_INDEX_NAME_PREFIX,
date_rounding: 'M',
date_rounding: 'd',
date_formats: ['UNIX_MS', 'ISO8601', "yyyy-MM-dd'T'HH:mm:ss.SSSXX"],
},
},
Expand Down Expand Up @@ -100,6 +100,13 @@ export const getSLIPipelineTemplate = (
name: `slo-${slo.id}@custom`,
},
},
{
pipeline: {
ignore_missing_pipeline: true,
ignore_failure: true,
name: 'slo-rollup-global@custom',
},
},
],
_meta: {
description: 'Ingest pipeline for SLO rollup data',
Expand Down
14 changes: 14 additions & 0 deletions ...ons/observability/plugins/slo/server/assets/ingest_templates/summary_pipeline_template.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,6 +249,20 @@ export const getSummaryPipelineTemplate = (
ignore_failure: true,
},
},
{
pipeline: {
ignore_missing_pipeline: true,
ignore_failure: true,
name: `slo-${slo.id}@custom`,
},
},
{
pipeline: {
ignore_missing_pipeline: true,
ignore_failure: true,
name: 'slo-summary-global@custom',
},
},
],
_meta: {
description: `Ingest pipeline for SLO summary data [id: ${slo.id}, revision: ${slo.revision}]`,
Expand Down
4 changes: 2 additions & 2 deletions ...bservability/plugins/slo/server/assets/transform_templates/slo_transform_template.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ describe('slo transform template', () => {
},
defer_validation: true,
_meta: {
version: 3.5,
version: 3.6,
managed: true,
managed_by: 'observability',
},
Expand Down Expand Up @@ -247,7 +247,7 @@ describe('slo transform template', () => {
},
defer_validation: true,
_meta: {
version: 3.5,
version: 3.6,
managed: true,
managed_by: 'observability',
},
Expand Down
15 changes: 11 additions & 4 deletions ...solutions/observability/plugins/slo/server/services/__snapshots__/create_slo.test.ts.snap
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions ...y/plugins/slo/server/services/management/__snapshots__/clean_up_temp_summary.test.ts.snap
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions x-pack/solutions/observability/plugins/slo/server/services/resource_installer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,18 +87,18 @@ export class DefaultResourceInstaller implements ResourceInstaller {
}

private async fetchComponentTemplateVersion(name: string) {
const getTemplateRes = await this.execute(() =>
const response = await this.execute(() =>
this.esClient.cluster.getComponentTemplate({ name }, { ignore: [404] })
);

return getTemplateRes?.component_templates?.[0]?.component_template?._meta?.version ?? null;
return response?.component_templates?.[0]?.component_template?._meta?.version ?? null;
}

private async fetchIndexTemplateVersion(name: string) {
const getTemplateRes = await this.execute(() =>
const response = await this.execute(() =>
this.esClient.indices.getIndexTemplate({ name }, { ignore: [404] })
);

return getTemplateRes?.index_templates?.[0]?.index_template?._meta?.version ?? null;
return response?.index_templates?.[0]?.index_template?._meta?.version ?? null;
}
}
Loading