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

[8.x] [Synthetics] Added error track trace to status/tls rule context variable !! (#198599) #198672

Merged
merged 1 commit into from
Nov 1, 2024
Merged

[8.x] [Synthetics] Added error track trace to status/tls rule context variable !! (#198599) #198672

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
1 change: 1 addition & 0 deletions packages/kbn-alerts-as-data-utils/src/schemas/generated/observability_uptime_schema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ const ObservabilityUptimeAlertOptional = rt.partial({
'anomaly.start': schemaDate,
configId: schemaString,
'error.message': schemaString,
'error.stack_trace': schemaString,
'host.name': schemaString,
'kibana.alert.context': schemaUnknown,
'kibana.alert.evaluation.threshold': schemaStringOrNumber,
Expand Down
20 changes: 20 additions & 0 deletions ...plugins/alerting/server/integration_tests/__snapshots__/alert_as_data_fields.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.

1 change: 1 addition & 0 deletions x-pack/plugins/observability_solution/synthetics/common/field_names.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ export const OBSERVER_NAME = 'observer.name';
export const SERVICE_NAME = 'service.name';
export const OBSERVER_GEO_NAME = 'observer.geo.name';
export const ERROR_MESSAGE = 'error.message';
export const ERROR_STACK_TRACE = 'error.stack_trace';
export const STATE_ID = 'monitor.state.id';

export const CERT_COMMON_NAME = 'tls.server.x509.subject.common_name';
Expand Down
3 changes: 2 additions & 1 deletion x-pack/plugins/observability_solution/synthetics/common/requests/get_certs_request_body.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ export const getCertsRequestBody = ({
'service',
'labels',
'tags',
'error.message',
'error',
],
collapse: {
field: 'tls.server.hash.sha256',
Expand Down Expand Up @@ -222,6 +222,7 @@ export const processCertsResult = (result: CertificatesResults): CertResult => {
locationId: ping?.observer?.name,
locationName: ping?.observer?.geo?.name,
errorMessage: ping?.error?.message,
errorStackTrace: ping?.error?.stack_trace,
};
});
const total = result.aggregations?.total?.value ?? 0;
Expand Down
4 changes: 4 additions & 0 deletions x-pack/plugins/observability_solution/synthetics/common/rules/synthetics_rule_field_map.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@ export const syntheticsRuleFieldMap: FieldMap = {
type: 'text',
required: false,
},
'error.stack_trace': {
type: 'wildcard',
required: false,
},
'agent.name': {
type: 'keyword',
required: false,
Expand Down
1 change: 1 addition & 0 deletions x-pack/plugins/observability_solution/synthetics/common/runtime_types/certs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ export const CertType = t.intersection([
'@timestamp': t.string,
serviceName: t.string,
errorMessage: t.string,
errorStackTrace: t.union([t.string, t.null]),
labels: t.record(t.string, t.string),
tags: t.array(t.string),
}),
Expand Down
7 changes: 6 additions & 1 deletion ...plugins/observability_solution/synthetics/server/alert_rules/status_rule/message_utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import {
AGENT_NAME,
STATE_ID,
SERVICE_NAME,
ERROR_STACK_TRACE,
} from '../../../common/field_names';
import { OverviewPing } from '../../../common/runtime_types';
import { UNNAMED_LOCATION } from '../../../common/constants';
Expand All @@ -42,6 +43,8 @@ export const getMonitorAlertDocument = (
[OBSERVER_GEO_NAME]: locationNames,
[OBSERVER_NAME]: locationIds,
[ERROR_MESSAGE]: monitorSummary.lastErrorMessage,
// done to avoid assigning null to the field
[ERROR_STACK_TRACE]: monitorSummary.lastErrorStack ? monitorSummary.lastErrorStack : undefined,
[AGENT_NAME]: monitorSummary.hostName,
[ALERT_REASON]: monitorSummary.reason,
[STATE_ID]: monitorSummary.stateId,
Expand Down Expand Up @@ -114,7 +117,9 @@ export const getMonitorSummary = ({
monitorId: monitorInfo.monitor?.id,
monitorName,
monitorType: typeToLabelMap[monitorInfo.monitor?.type] || monitorInfo.monitor?.type,
lastErrorMessage: monitorInfo.error?.message!,
lastErrorMessage: monitorInfo.error?.message,
// done to avoid assigning null to the field
lastErrorStack: monitorInfo.error?.stack_trace ? monitorInfo.error?.stack_trace : undefined,
serviceName: monitorInfo.service?.name,
labels: monitorInfo.labels,
locationName: formattedLocationName,
Expand Down
1 change: 1 addition & 0 deletions x-pack/plugins/observability_solution/synthetics/server/alert_rules/status_rule/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ export interface MonitorSummaryStatusRule {
};
stateId?: string;
lastErrorMessage?: string;
lastErrorStack?: string | null;
timestamp: string;
labels?: Record<string, string>;
}
4 changes: 4 additions & 0 deletions ...ck/plugins/observability_solution/synthetics/server/alert_rules/tls_rule/message_utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ import {
CERT_VALID_NOT_AFTER,
CERT_VALID_NOT_BEFORE,
ERROR_MESSAGE,
ERROR_STACK_TRACE,
MONITOR_ID,
MONITOR_NAME,
MONITOR_TYPE,
Expand Down Expand Up @@ -103,6 +104,7 @@ export const getCertSummary = (cert: Cert, expirationThreshold: number, ageThres
configId: cert.configId,
monitorTags: cert.tags,
errorMessage: cert.errorMessage,
errorStackTrace: cert.errorStackTrace,
labels: cert.labels,
};
};
Expand All @@ -123,6 +125,8 @@ export const getTLSAlertDocument = (cert: Cert, monitorSummary: CertSummary, uui
[OBSERVER_GEO_NAME]: monitorSummary.locationName ? [monitorSummary.locationName] : [],
[OBSERVER_NAME]: monitorSummary.locationId ? [monitorSummary.locationId] : [],
[ERROR_MESSAGE]: monitorSummary.errorMessage,
// done to avoid assigning null to the field
[ERROR_STACK_TRACE]: monitorSummary.errorStackTrace ? monitorSummary.errorStackTrace : undefined,
'location.id': monitorSummary.locationId ? [monitorSummary.locationId] : [],
'location.name': monitorSummary.locationName ? [monitorSummary.locationName] : [],
labels: cert.labels,
Expand Down
9 changes: 9 additions & 0 deletions x-pack/plugins/observability_solution/synthetics/server/alert_rules/translations.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,15 @@ export const commonMonitorStateI18: Array<{
}
),
},
{
name: 'lastErrorStack',
description: i18n.translate(
'xpack.synthetics.alertRules.monitorStatus.actionVariables.state.lastErrorStack',
{
defaultMessage: 'Monitor last error stack trace.',
}
),
},
{
name: 'locationName',
description: i18n.translate(
Expand Down
4 changes: 4 additions & 0 deletions x-pack/plugins/observability_solution/uptime/common/rules/uptime_rule_field_map.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@ export const uptimeRuleFieldMap: FieldMap = {
type: 'text',
required: false,
},
'error.stack_trace': {
type: 'wildcard',
required: false,
},
'agent.name': {
type: 'keyword',
required: false,
Expand Down