Skip to content

Add health_status field to status change logs data stream #15852

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
+389 −17
Open

Add health_status field to status change logs data stream #15852

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
349ea80
Add health_status field to status change logs data stream
MichelLosier Nov 3, 2025
e7960f1
Add processor for health_status field in status_change_logs data stream
MichelLosier Nov 3, 2025
5fea05b
Add pipeline tests
MichelLosier Nov 3, 2025
e3ed12c
Add agent status alert rules
MichelLosier Nov 3, 2025
551368a
Remove extra line
MichelLosier Nov 3, 2025
067ae45
Update package version
MichelLosier Nov 4, 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
5 changes: 5 additions & 0 deletions packages/elastic_agent/changelog.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# newer versions go on top
- version: "2.6.8"
changes:
- description: Adds processor for health_status field to status change logs data stream
type: enhancement
link: https://github.com/elastic/integrations/pull/15852
- version: "2.6.7"
changes:
- description: Add mapping for error fields for beats logs.
Expand Down
116 changes: 116 additions & 0 deletions ...s/elastic_agent/data_stream/status_change_logs/_dev/test/pipeline/test-health-status.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
{
"events": [
{
"@timestamp": "2024-01-15T10:30:00.000Z",
"data_stream": {
"type": "logs",
"dataset": "elastic_agent.status_change",
"namespace": "default"
},
"agent": {
"id": "f2b3c4d5-e6f7-8a9b-b0c1-d2e3f4g5h6i7"
},
"status": "online",
"policy_id": "test-policy",
"agentless": false,
"space_id": "default",
"hostname": "test-host"
},
{
"@timestamp": "2024-01-15T10:30:00.000Z",
"data_stream": {
"type": "logs",
"dataset": "elastic_agent.status_change",
"namespace": "default"
},
"agent": {
"id": "f2b3c4d5-e6f7-8a9b-b0c1-d2e3f4g5h6i7"
},
"status": "offline",
"policy_id": "test-policy",
"agentless": false,
"space_id": "default",
"hostname": "test-host"
},
{
"@timestamp": "2024-01-15T10:30:00.000Z",
"data_stream": {
"type": "logs",
"dataset": "elastic_agent.status_change",
"namespace": "default"
},
"agent": {
"id": "f2b3c4d5-e6f7-8a9b-b0c1-d2e3f4g5h6i7"
},
"status": "error",
"policy_id": "test-policy",
"agentless": false,
"space_id": "default",
"hostname": "test-host"
},
{
"@timestamp": "2024-01-15T10:30:00.000Z",
"data_stream": {
"type": "logs",
"dataset": "elastic_agent.status_change",
"namespace": "default"
},
"agent": {
"id": "f2b3c4d5-e6f7-8a9b-b0c1-d2e3f4g5h6i7"
},
"status": "degraded",
"policy_id": "test-policy",
"agentless": false,
"space_id": "default",
"hostname": "test-host"
},
{
"@timestamp": "2024-01-15T10:30:00.000Z",
"data_stream": {
"type": "logs",
"dataset": "elastic_agent.status_change",
"namespace": "default"
},
"agent": {
"id": "f2b3c4d5-e6f7-8a9b-b0c1-d2e3f4g5h6i7"
},
"status": "updating",
"policy_id": "test-policy",
"agentless": false,
"space_id": "default",
"hostname": "test-host"
},
{
"@timestamp": "2024-01-15T10:30:00.000Z",
"data_stream": {
"type": "logs",
"dataset": "elastic_agent.status_change",
"namespace": "default"
},
"agent": {
"id": "f2b3c4d5-e6f7-8a9b-b0c1-d2e3f4g5h6i7"
},
"status": "enrolling",
"policy_id": "test-policy",
"agentless": false,
"space_id": "default",
"hostname": "test-host"
},
{
"@timestamp": "2024-01-15T10:30:00.000Z",
"data_stream": {
"type": "logs",
"dataset": "elastic_agent.status_change",
"namespace": "default"
},
"agent": {
"id": "f2b3c4d5-e6f7-8a9b-b0c1-d2e3f4g5h6i7"
},
"status": "unenrolling",
"policy_id": "test-policy",
"agentless": false,
"space_id": "default",
"hostname": "test-host"
}
]
}
123 changes: 123 additions & 0 deletions ...t/data_stream/status_change_logs/_dev/test/pipeline/test-health-status.json-expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
{
"expected": [
{
"@timestamp": "2024-01-15T10:30:00.000Z",
"data_stream": {
"type": "logs",
"dataset": "elastic_agent.status_change",
"namespace": "default"
},
"agent": {
"id": "f2b3c4d5-e6f7-8a9b-b0c1-d2e3f4g5h6i7"
},
"status": "online",
"health_status": "healthy",
"policy_id": "test-policy",
"agentless": false,
"space_id": "default",
"hostname": "test-host"
},
{
"@timestamp": "2024-01-15T10:30:00.000Z",
"data_stream": {
"type": "logs",
"dataset": "elastic_agent.status_change",
"namespace": "default"
},
"agent": {
"id": "f2b3c4d5-e6f7-8a9b-b0c1-d2e3f4g5h6i7"
},
"status": "offline",
"health_status": "offline",
"policy_id": "test-policy",
"agentless": false,
"space_id": "default",
"hostname": "test-host"
},
{
"@timestamp": "2024-01-15T10:30:00.000Z",
"data_stream": {
"type": "logs",
"dataset": "elastic_agent.status_change",
"namespace": "default"
},
"agent": {
"id": "f2b3c4d5-e6f7-8a9b-b0c1-d2e3f4g5h6i7"
},
"status": "error",
"health_status": "unhealthy",
"policy_id": "test-policy",
"agentless": false,
"space_id": "default",
"hostname": "test-host"
},
{
"@timestamp": "2024-01-15T10:30:00.000Z",
"data_stream": {
"type": "logs",
"dataset": "elastic_agent.status_change",
"namespace": "default"
},
"agent": {
"id": "f2b3c4d5-e6f7-8a9b-b0c1-d2e3f4g5h6i7"
},
"status": "degraded",
"health_status": "unhealthy",
"policy_id": "test-policy",
"agentless": false,
"space_id": "default",
"hostname": "test-host"
},
{
"@timestamp": "2024-01-15T10:30:00.000Z",
"data_stream": {
"type": "logs",
"dataset": "elastic_agent.status_change",
"namespace": "default"
},
"agent": {
"id": "f2b3c4d5-e6f7-8a9b-b0c1-d2e3f4g5h6i7"
},
"status": "updating",
"health_status": "updating",
"policy_id": "test-policy",
"agentless": false,
"space_id": "default",
"hostname": "test-host"
},
{
"@timestamp": "2024-01-15T10:30:00.000Z",
"data_stream": {
"type": "logs",
"dataset": "elastic_agent.status_change",
"namespace": "default"
},
"agent": {
"id": "f2b3c4d5-e6f7-8a9b-b0c1-d2e3f4g5h6i7"
},
"status": "enrolling",
"health_status": "updating",
"policy_id": "test-policy",
"agentless": false,
"space_id": "default",
"hostname": "test-host"
},
{
"@timestamp": "2024-01-15T10:30:00.000Z",
"data_stream": {
"type": "logs",
"dataset": "elastic_agent.status_change",
"namespace": "default"
},
"agent": {
"id": "f2b3c4d5-e6f7-8a9b-b0c1-d2e3f4g5h6i7"
},
"status": "unenrolling",
"health_status": "updating",
"policy_id": "test-policy",
"agentless": false,
"space_id": "default",
"hostname": "test-host"
}
]
}
23 changes: 23 additions & 0 deletions ...es/elastic_agent/data_stream/status_change_logs/elasticsearch/ingest_pipeline/default.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
description: Pipeline for Elastic Agent status change logs.
processors:
- script:
description: Derive health_status from status field
if: ctx.status != null
lang: painless
source: |
String status = ctx.status;
String healthStatus;

if (status == 'online') {
healthStatus = 'healthy';
} else if (status == 'error' || status == 'degraded') {
healthStatus = 'unhealthy';
} else if (status == 'updating' || status == 'enrolling' || status == 'unenrolling') {
healthStatus = 'updating';
} else {
healthStatus = status;
}

ctx.health_status = healthStatus;
ignore_failure: true
2 changes: 2 additions & 0 deletions packages/elastic_agent/data_stream/status_change_logs/fields/fields.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
- name: status
type: keyword
- name: health_status
type: keyword
- name: policy_id
type: keyword
- name: agentless
Expand Down
31 changes: 16 additions & 15 deletions packages/elastic_agent/data_stream/status_change_logs/sample_event.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
{
"@timestamp": 1576280412771,
"data_stream": {
"type": "logs",
"dataset": "elastic_agent.status_change",
"namespace": "default"
},
"agent": {
"id": "f2b3c4d5-e6f7-8a9b-b0c1-d2e3f4g5h6i7"
},
"status": "HEALTHY",
"policy_id": "test-policy",
"agentless": false,
"space_id": "default",
"hostname": "test-host"
}
"@timestamp": 1576280412771,
"data_stream": {
"type": "logs",
"dataset": "elastic_agent.status_change",
"namespace": "default"
},
"agent": {
"id": "f2b3c4d5-e6f7-8a9b-b0c1-d2e3f4g5h6i7"
},
"status": "online",
"health_status": "healthy",
"policy_id": "test-policy",
"agentless": false,
"space_id": "default",
"hostname": "test-host"
}
34 changes: 34 additions & 0 deletions packages/elastic_agent/kibana/alerting_rule_template/elastic-agent-offline-status.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{
"id": "elastic-agent-offline-status",
"type": "alerting_rule_template",
"attributes": {
"name": "[Elastic Agent] Offline status",
"tags": ["Elastic Agent"],
"ruleTypeId": ".es-query",
"schedule": {
"interval": "1m"
},
"params": {
"searchType": "esqlQuery",
"timeWindowSize": 5,
"timeWindowUnit": "m",
"threshold": [0],
"thresholdComparator": ">",
"size": 100,
"esqlQuery": {
"esql": "FROM logs-elastic_agent.status_change-default, *:logs-elastic_agent.status_change-default\n| WHERE data_stream.dataset == \"elastic_agent.status_change\" and agentless == false and health_status == \"offline\""
},
"aggType": "count",
"groupBy": "row",
"termSize": 5,
"sourceFields": [],
"timeField": "@timestamp",
"excludeHitsFromPreviousRun": true
},
"alertDelay": {
"active": 1
}
},
"coreMigrationVersion": "8.8.0",
"typeMigrationVersion": "10.1.0"
}
34 changes: 34 additions & 0 deletions packages/elastic_agent/kibana/alerting_rule_template/elastic-agent-unenrolled-status.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{
"id": "elastic-agent-unenrolled-status",
"type": "alerting_rule_template",
"attributes": {
"name": "[Elastic Agent] Unenrolled status",
"tags": ["Elastic Agent"],
"ruleTypeId": ".es-query",
"schedule": {
"interval": "1m"
},
"params": {
"searchType": "esqlQuery",
"timeWindowSize": 5,
"timeWindowUnit": "m",
"threshold": [0],
"thresholdComparator": ">",
"size": 100,
"esqlQuery": {
"esql": "FROM logs-elastic_agent.status_change-default, *:logs-elastic_agent.status_change-default\n| WHERE data_stream.dataset == \"elastic_agent.status_change\" and agentless == false and health_status == \"unenrolled\""
},
"aggType": "count",
"groupBy": "row",
"termSize": 5,
"sourceFields": [],
"timeField": "@timestamp",
"excludeHitsFromPreviousRun": true
},
"alertDelay": {
"active": 1
}
},
"coreMigrationVersion": "8.8.0",
"typeMigrationVersion": "10.1.0"
}
2 changes: 1 addition & 1 deletion packages/elastic_agent/kibana/alerting_rule_template/elastic-agent-unhealthy-status.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"thresholdComparator": ">",
"size": 100,
"esqlQuery": {
"esql": "FROM logs-elastic_agent.status_change-default, *:logs-elastic_agent.status_change-default\n| WHERE data_stream.dataset == \"elastic_agent.status_change\" and agentless == false and status in (\"error\", \"degraded\")"
"esql": "FROM logs-elastic_agent.status_change-default, *:logs-elastic_agent.status_change-default\n| WHERE data_stream.dataset == \"elastic_agent.status_change\" and agentless == false and health_status == \"unhealthy\""
},
"aggType": "count",
"groupBy": "row",
Expand Down
Loading