[SLO] Changing Custom KQL to Custom Query (#179497)

This PR fixes #179495 by changing `Custom KQL` to `Custom Query`
throughout the product. This is a cosmetic change only.

Co-authored-by: Shahzad <shahzad31comp@gmail.com>
This commit is contained in:
Chris Cowan 2024-03-27 07:32:29 -06:00 committed by GitHub
parent 39379a2e9e
commit e1fb905a6a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
8 changed files with 17 additions and 17 deletions

View file

@ -36,7 +36,7 @@ Get help with the data forge tool: `node x-pack/scripts/data_forge.js --help`
2. Create SLOs
> [!TIP]
> Using the API is possible, but to prevent this document of becoming out of date, we refer to the [openAPI](../docs/openapi/slo/bundled.yaml) specification instead.
> Using the API is possible, but to prevent this document of becoming out of date, we refer to the [openAPI](../docs/openapi/slo/bundled.yaml) specification instead.
> Using the UI for developping/testing is the simpler approach.
@ -51,7 +51,7 @@ On this page, you'll be able to create SLOs.
With the data generated from the above section, the easiest SLO you can setup would be:
> **Type**: Custom KQL
> **Type**: Custom Query
>
> **Index**: Admin Console
>
@ -71,14 +71,14 @@ We currently support the following SLI:
- APM Transaction Error Rate, known as APM Availability
- APM Transaction Duration, known as APM Latency
- Custom KQL
- Custom Query
- Custom Metric
- Histogram Metric
- Timeslice Metric
For the APM SLIs, customer can provide the service, environment, transaction name and type to configure them. For the **APM Latency** SLI, a threshold in milliseconds needs to be provided to discriminate the good and bad responses (events). For the **APM Availability** SLI, we use the `event.outcome` as a way to discriminate the good and the bad responses(events). The API supports an optional kql filter to further filter the apm data.
The **Custom KQL** SLI requires an index pattern, an optional filter query, a numerator query, and denominator query. A custom `timestampField` can be provided to override the default @timestamp field.
The **Custom Query** SLI requires an index pattern, an optional filter query, a numerator query, and denominator query. A custom `timestampField` can be provided to override the default @timestamp field.
The **Custom Metric** SLI requires an index pattern, an optional filter query, a set of metrics for the numerator, and a set of metrics for the denominator. A custom `timestampField` can be provided to override the default @timestamp field.
@ -347,7 +347,7 @@ curl --request POST \
</details>
### Custom KQL
### Custom Query
<details>
<summary>98.5% of 'logs lantency < 300ms' for 'groupId: group-0' over the last 7 days</summary>
@ -481,4 +481,4 @@ curl --request POST \
}
}'
```
</details>
</details>

View file

@ -1100,12 +1100,12 @@
]
},
"indicator_properties_custom_kql": {
"title": "Custom KQL",
"title": "Custom Query",
"required": [
"type",
"params"
],
"description": "Defines properties for a custom KQL indicator type",
"description": "Defines properties for a custom query indicator type",
"type": "object",
"properties": {
"params": {
@ -2472,4 +2472,4 @@
}
}
}
}
}

View file

@ -687,11 +687,11 @@ components:
items:
$ref: '#/components/schemas/filter'
indicator_properties_custom_kql:
title: Custom KQL
title: Custom Query
required:
- type
- params
description: Defines properties for a custom KQL indicator type
description: Defines properties for a custom query indicator type
type: object
properties:
params:

View file

@ -1,8 +1,8 @@
title: Custom KQL
title: Custom Query
required:
- type
- params
description: Defines properties for a custom KQL indicator type
description: Defines properties for a custom query indicator type
type: object
properties:
params:

View file

@ -332,7 +332,7 @@ describe('SLO Details Page', () => {
});
});
describe('when an Custom KQL SLO is loaded', () => {
describe('when an Custom Query SLO is loaded', () => {
it("does not render a 'Explore in APM' button under actions menu", async () => {
const slo = buildSlo();
jest.spyOn(Router, 'useParams').mockReturnValue({ sloId: slo.id });

View file

@ -257,7 +257,7 @@ Object {
}
`;
exports[`Transform partial URL state into form state with 'indicator' in URL state handles partial Custom KQL state 1`] = `
exports[`Transform partial URL state into form state with 'indicator' in URL state handles partial Custom Query state 1`] = `
Object {
"budgetingMethod": "occurrences",
"description": "",

View file

@ -39,7 +39,7 @@ describe('Transform partial URL state into form state', () => {
).toMatchSnapshot();
});
it('handles partial Custom KQL state', () => {
it('handles partial Custom Query state', () => {
expect(
transform({
indicator: {

View file

@ -11,7 +11,7 @@ import { assertNever } from '@kbn/std';
import { toDuration } from './duration';
export const INDICATOR_CUSTOM_KQL = i18n.translate('xpack.slo.indicators.customKql', {
defaultMessage: 'Custom KQL',
defaultMessage: 'Custom Query',
});
export const INDICATOR_CUSTOM_METRIC = i18n.translate('xpack.slo.indicators.customMetric', {