Skip to content

Commit

Permalink
Adding missing fields in the status metricset of the kibana integrati…
Browse files Browse the repository at this point in the history
…on (#10944)

* Adding missing fields in kibana integration

elastic/beats#40275 added some new fields to the `status` metricset of the `kibana` module, but they are missing in the `kibana` integration

* Modified changelog for #10944

* Bump kibana integration version to 2.5.4

* Modified documentation to add new kibana status fields

* Updated sample kibana status event

* Update kibana status docs

* Fix typos in kibana status integration fields

* Fix alphabetical order in kibana status docs

* Fix typos in kibana status integration fields
  • Loading branch information
consulthys authored Aug 30, 2024
1 parent bcf92a4 commit ae4affb
Show file tree
Hide file tree
Showing 5 changed files with 65 additions and 4 deletions.
5 changes: 5 additions & 0 deletions packages/kibana/changelog.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# newer versions go on top
- version: "2.5.4"
changes:
- description: Adding missing fields in the Kibana status metricset
type: enhancement
link: https://github.com/elastic/integrations/pull/10944
- version: "2.5.3"
changes:
- description: Remove documentation about xpack.enabled settings
Expand Down
24 changes: 24 additions & 0 deletions packages/kibana/data_stream/status/fields/fields.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,30 @@
type: keyword
description: |
Kibana overall state.
- name: status.overall.level
type: keyword
description: >
Kibana overall level (v8 format).
- name: status.overall.summary
type: text
description: >
Kibana overall state in a human-readable format.
- name: status.core.elasticsearch.level
type: keyword
description: >
Kibana Elasticsearch client's status.
- name: status.core.elasticsearch.summary
type: text
description: >
Kibana Elasticsearch client's status in a human-readable format.
- name: status.core.savedObjects.level
type: keyword
description: >
Kibana Saved Objects client's status.
- name: status.core.savedObjects.summary
type: text
description: >
Kibana Saved Objects client's status in a human-readable format.
- name: metrics
type: group
fields:
Expand Down
17 changes: 15 additions & 2 deletions packages/kibana/data_stream/status/sample_event.json
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,20 @@
},
"name": "kibana",
"status": {
"overall": {}
"overall": {
"level": "available",
"summary": "All services and plugins are available"
},
"core": {
"elasticsearch": {
"level": "available",
"summary": "Elasticsearch is available"
},
"savedObjects": {
"level": "available",
"summary": "SavedObjects service has completed migrations and is available"
}
}
}
}
},
Expand All @@ -75,4 +88,4 @@
"type": "kibana",
"version": "8.5.0"
}
}
}
21 changes: 20 additions & 1 deletion packages/kibana/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -791,7 +791,13 @@ This status endpoint is available in 6.0 by default and can be enabled in Kibana
| kibana.status.metrics.requests.disconnects | Total number of disconnected connections. | long |
| kibana.status.metrics.requests.total | Total number of connections. | long |
| kibana.status.name | Kibana instance name. | keyword |
| kibana.status.status.core.elasticsearch.level | Kibana Elasticsearch client's status. | keyword |
| kibana.status.status.core.elasticsearch.summary | Kibana Elasticsearch client's status in a human-readable format. | text |
| kibana.status.status.core.savedObjects.level | Kibana Saved Objects client's status. | keyword |
| kibana.status.status.core.savedObjects.summary | Kibana Saved Objects client's status in a human-readable format. | text |
| kibana.status.status.overall.level | Kibana overall level (v8 format). | keyword |
| kibana.status.status.overall.state | Kibana overall state. | keyword |
| kibana.status.status.overall.summary | Kibana overall state in a human-readable format. | text |
| service.address | Address where data about this service was collected from. | keyword |
| service.id | Unique identifier of the running service. If the service is comprised of many nodes, the `service.id` should be the same for all nodes. This id should uniquely identify the service. This makes it possible to correlate logs and metrics for one specific service, no matter which particular node emitted the event. Note that if you need to see the events from one specific host of the service, you should filter on that `host.name` or `host.id` instead. | keyword |
| service.name | Name of the service data is collected from. The name of the service is normally user given. This allows for distributed services that run on multiple hosts to correlate the related instances based on the name. In the case of Elasticsearch the `service.name` could contain the cluster name. For Beats the `service.name` is by default a copy of the `service.type` field if no name is specified. | keyword |
Expand Down Expand Up @@ -864,7 +870,20 @@ An example event for `status` looks as following:
},
"name": "kibana",
"status": {
"overall": {}
"overall": {
"level": "available",
"summary": "All services and plugins are available"
},
"core": {
"elasticsearch": {
"level": "available",
"summary": "Elasticsearch is available"
},
"savedObjects": {
"level": "available",
"summary": "SavedObjects service has completed migrations and is available"
}
}
}
}
},
Expand Down
2 changes: 1 addition & 1 deletion packages/kibana/manifest.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: kibana
title: Kibana
version: 2.5.3
version: 2.5.4
description: Collect logs and metrics from Kibana with Elastic Agent.
type: integration
icons:
Expand Down

0 comments on commit ae4affb

Please sign in to comment.