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

[Metrics UI] Add docs link to redundant groupBy detection #116822

Merged
merged 6 commits into from
Nov 4, 2021
Merged

[Metrics UI] Add docs link to redundant groupBy detection #116822

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
54e79ce
[Metrics UI] Fix OR logic on redundant groupBy detection
Zacqary Oct 28, 2021
ed09b2a
Switch regex change to doc change
Zacqary Nov 1, 2021
c743588
Merge branch 'main' into 116195-groupby-or-fix
Zacqary Nov 1, 2021
aece73e
Fix core docs links
Zacqary Nov 1, 2021
5856bae
Update x-pack/plugins/infra/public/alerting/metric_threshold/componen…
Zacqary Nov 1, 2021
018a4ea
Merge branch 'main' into 116195-groupby-or-fix
kibanamachine Nov 4, 2021
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: 3 additions & 3 deletions src/core/public/doc_links/doc_links_service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,9 +305,9 @@ export class DocLinksService {
},
observability: {
guide: `${ELASTIC_WEBSITE_URL}guide/en/observability/${DOC_LINK_VERSION}/index.html`,
infrastructureThreshold: `{ELASTIC_WEBSITE_URL}guide/en/observability/${DOC_LINK_VERSION}/infrastructure-threshold-alert.html`,
logsThreshold: `{ELASTIC_WEBSITE_URL}guide/en/observability/${DOC_LINK_VERSION}/logs-threshold-alert.html`,
metricsThreshold: `{ELASTIC_WEBSITE_URL}guide/en/observability/${DOC_LINK_VERSION}/metrics-threshold-alert.html`,
infrastructureThreshold: `${ELASTIC_WEBSITE_URL}guide/en/observability/${DOC_LINK_VERSION}/infrastructure-threshold-alert.html`,
logsThreshold: `${ELASTIC_WEBSITE_URL}guide/en/observability/${DOC_LINK_VERSION}/logs-threshold-alert.html`,
metricsThreshold: `${ELASTIC_WEBSITE_URL}guide/en/observability/${DOC_LINK_VERSION}/metrics-threshold-alert.html`,
monitorStatus: `${ELASTIC_WEBSITE_URL}guide/en/observability/${DOC_LINK_VERSION}/monitor-status-alert.html`,
monitorUptime: `${ELASTIC_WEBSITE_URL}guide/en/observability/${DOC_LINK_VERSION}/monitor-uptime.html`,
tlsCertificate: `${ELASTIC_WEBSITE_URL}guide/en/observability/${DOC_LINK_VERSION}/tls-certificate-alert.html`,
Expand Down
18 changes: 16 additions & 2 deletions x-pack/plugins/infra/public/alerting/metric_threshold/components/expression.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import {
EuiFieldSearch,
EuiAccordion,
EuiPanel,
EuiLink,
} from '@elastic/eui';
import { FormattedMessage } from '@kbn/i18n/react';
import { i18n } from '@kbn/i18n';
Expand Down Expand Up @@ -58,7 +59,7 @@ export { defaultExpression };

export const Expressions: React.FC<Props> = (props) => {
const { setAlertParams, alertParams, errors, metadata } = props;
const { http, notifications } = useKibanaContextForPlugin().services;
const { http, notifications, docLinks } = useKibanaContextForPlugin().services;
const { source, createDerivedIndexPattern } = useSourceViaHttp({
sourceId: 'default',
fetch: http.fetch,
Expand Down Expand Up @@ -260,6 +261,9 @@ export const Expressions: React.FC<Props> = (props) => {
[alertParams.groupBy]
);

// Test to see if any of the group fields in groupBy are already filtered down to a single
// group by the filterQuery. If this is the case, then a groupBy is unnecessary, as it would only
// ever produce one group instance
const groupByFilterTestPatterns = useMemo(() => {
if (!alertParams.groupBy) return null;
const groups = !Array.isArray(alertParams.groupBy)
Expand Down Expand Up @@ -456,10 +460,20 @@ export const Expressions: React.FC<Props> = (props) => {
<EuiText size="xs" color="danger">
<FormattedMessage
id="xpack.infra.metrics.alertFlyout.alertPerRedundantFilterError"
defaultMessage="This rule will only alert per one {matchedGroups} because the filter query contains an exact match for {groupCount, plural, one {this field} other {these fields}}."
defaultMessage="This rule may alert on {matchedGroups} less than expected, because the filter query contains a match for {groupCount, plural, one {this field} other {these fields}}. For more information, refer to {filteringAndGroupingLink}."
values={{
matchedGroups: <strong>{redundantFilterGroupBy.join(', ')}</strong>,
groupCount: redundantFilterGroupBy.length,
filteringAndGroupingLink: (
<EuiLink
href={`${docLinks.links.observability.metricsThreshold}#filtering-and-grouping`}
>
{i18n.translate(
'xpack.infra.metrics.alertFlyout.alertPerRedundantFilterError.docsLink',
{ defaultMessage: 'the docs' }
)}
</EuiLink>
),
}}
/>
</EuiText>
Expand Down