mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 09:48:58 -04:00
c50ea8c2ba
# Backport This will backport the following commits from `main` to `8.7`: - [[DOCS] Describe how to use Elastic Agent to monitor Kibana (#152634)](https://github.com/elastic/kibana/pull/152634) <!--- Backport version: 8.9.7 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"DeDe Morton","email":"dede.morton@elastic.co"},"sourceCommit":{"committedDate":"2023-03-23T18:00:13Z","message":"[DOCS] Describe how to use Elastic Agent to monitor Kibana (#152634)\n\n## Summary\r\n\r\nAdd Elastic Agent as another way to collect monitoring data.\r\n\r\nThis work is tracked by\r\nhttps://github.com/elastic/observability-docs/issues/2602.\r\n\r\nThere will be additional PRs to address changes required to monitoring\r\ndocs for other stack components. TBH, it pains me a bit to see how many\r\nplaces users need to go to find info about stack monitoring, but fixing\r\nthat problem is not in scope for these updates unfortunately. :-/\r\n\r\nPlease respond to questions addressed to reviewers.\r\n\r\n### Checklist\r\n\r\nDelete any items that are not applicable to this PR.\r\n\r\n- [x] Any text added follows [EUI's writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing), uses\r\nsentence case text and includes [i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\r\n\r\n### To Do before merging\r\n\r\n- [x] Remove questions to reviewers.\r\n\r\n---------\r\n\r\nCo-authored-by: Kevin Lacabane <klacabane@gmail.com>","sha":"9ff847dec75a5a562cc46d121cbec57c45da177d","branchLabelMapping":{"^v8.8.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","auto-backport-next","v8.7.0","v8.8.0"],"number":152634,"url":"https://github.com/elastic/kibana/pull/152634","mergeCommit":{"message":"[DOCS] Describe how to use Elastic Agent to monitor Kibana (#152634)\n\n## Summary\r\n\r\nAdd Elastic Agent as another way to collect monitoring data.\r\n\r\nThis work is tracked by\r\nhttps://github.com/elastic/observability-docs/issues/2602.\r\n\r\nThere will be additional PRs to address changes required to monitoring\r\ndocs for other stack components. TBH, it pains me a bit to see how many\r\nplaces users need to go to find info about stack monitoring, but fixing\r\nthat problem is not in scope for these updates unfortunately. :-/\r\n\r\nPlease respond to questions addressed to reviewers.\r\n\r\n### Checklist\r\n\r\nDelete any items that are not applicable to this PR.\r\n\r\n- [x] Any text added follows [EUI's writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing), uses\r\nsentence case text and includes [i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\r\n\r\n### To Do before merging\r\n\r\n- [x] Remove questions to reviewers.\r\n\r\n---------\r\n\r\nCo-authored-by: Kevin Lacabane <klacabane@gmail.com>","sha":"9ff847dec75a5a562cc46d121cbec57c45da177d"}},"sourceBranch":"main","suggestedTargetBranches":["8.7"],"targetPullRequestStates":[{"branch":"8.7","label":"v8.7.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.8.0","labelRegex":"^v8.8.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/152634","number":152634,"mergeCommit":{"message":"[DOCS] Describe how to use Elastic Agent to monitor Kibana (#152634)\n\n## Summary\r\n\r\nAdd Elastic Agent as another way to collect monitoring data.\r\n\r\nThis work is tracked by\r\nhttps://github.com/elastic/observability-docs/issues/2602.\r\n\r\nThere will be additional PRs to address changes required to monitoring\r\ndocs for other stack components. TBH, it pains me a bit to see how many\r\nplaces users need to go to find info about stack monitoring, but fixing\r\nthat problem is not in scope for these updates unfortunately. :-/\r\n\r\nPlease respond to questions addressed to reviewers.\r\n\r\n### Checklist\r\n\r\nDelete any items that are not applicable to this PR.\r\n\r\n- [x] Any text added follows [EUI's writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing), uses\r\nsentence case text and includes [i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\r\n\r\n### To Do before merging\r\n\r\n- [x] Remove questions to reviewers.\r\n\r\n---------\r\n\r\nCo-authored-by: Kevin Lacabane <klacabane@gmail.com>","sha":"9ff847dec75a5a562cc46d121cbec57c45da177d"}}]}] BACKPORT--> Co-authored-by: DeDe Morton <dede.morton@elastic.co>
75 lines
2.5 KiB
Text
75 lines
2.5 KiB
Text
[[setup]]
|
|
= Set up
|
|
|
|
[partintro]
|
|
--
|
|
This section includes information on how to setup Kibana and get it running,
|
|
including:
|
|
|
|
* Downloading
|
|
* Installing
|
|
* Starting
|
|
* Configuring
|
|
* Upgrading
|
|
|
|
[[supported-platforms]]
|
|
[float]
|
|
== Supported platforms
|
|
|
|
Packages of Kibana are provided for and tested against Linux, Darwin, and
|
|
Windows. Since Kibana runs on Node.js, we include the necessary Node.js
|
|
binaries for these platforms. Running Kibana against a separately maintained
|
|
version of Node.js is not supported.
|
|
|
|
[float]
|
|
[[elasticsearch-version]]
|
|
== Elasticsearch version
|
|
|
|
Kibana should be configured to run against an Elasticsearch node of the same
|
|
version. This is the officially supported configuration.
|
|
|
|
Running different major version releases of Kibana and Elasticsearch (e.g.
|
|
Kibana 5.x and Elasticsearch 2.x) is not supported, nor is running a minor
|
|
version of Kibana that is newer than the version of Elasticsearch (e.g. Kibana
|
|
5.1 and Elasticsearch 5.0).
|
|
|
|
Running a minor version of Elasticsearch that is higher than Kibana will
|
|
generally work in order to facilitate an upgrade process where Elasticsearch
|
|
is upgraded first (e.g. Kibana 5.0 and Elasticsearch 5.1). In this
|
|
configuration, a warning will be logged on Kibana server startup, so it's only
|
|
meant to be temporary until Kibana is upgraded to the same version as
|
|
Elasticsearch.
|
|
|
|
Running different patch version releases of Kibana and Elasticsearch (e.g.
|
|
Kibana 5.0.0 and Elasticsearch 5.0.1) is generally supported, though we
|
|
encourage users to run the same versions of Kibana and Elasticsearch down to
|
|
the patch version.
|
|
--
|
|
|
|
include::{kib-repo-dir}/setup/install.asciidoc[]
|
|
|
|
include::{kib-repo-dir}/setup/settings.asciidoc[]
|
|
|
|
include::{kib-repo-dir}/setup/start-stop.asciidoc[]
|
|
|
|
include::{kib-repo-dir}/setup/access.asciidoc[]
|
|
|
|
include::security/tutorials/how-to-secure-access-to-kibana.asciidoc[]
|
|
|
|
include::{kib-repo-dir}/setup/connect-to-elasticsearch.asciidoc[]
|
|
|
|
include::{kib-repo-dir}/setup/upgrade.asciidoc[]
|
|
|
|
include::security/securing-kibana.asciidoc[]
|
|
|
|
include::{kib-repo-dir}/setup/configuring-reporting.asciidoc[]
|
|
|
|
include::{kib-repo-dir}/setup/configuring-logging.asciidoc[]
|
|
|
|
include::monitoring/configuring-monitoring.asciidoc[leveloffset=+1]
|
|
include::monitoring/monitoring-elastic-agent.asciidoc[leveloffset=+2]
|
|
include::monitoring/monitoring-metricbeat.asciidoc[leveloffset=+2]
|
|
include::monitoring/viewing-metrics.asciidoc[leveloffset=+2]
|
|
include::monitoring/monitoring-kibana.asciidoc[leveloffset=+2]
|
|
|
|
include::commands/cli-commands.asciidoc[]
|