github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 09:48:58 -04:00
Code Issues Projects Releases Packages Wiki Activity

[8.7] Updating debugging docs: replacing apm.dev.js configuration references with kibana.dev.yml (#152237) (#152914)

Browse source 
# Backport

This will backport the following commits from `main` to `8.7`:
- [Updating debugging docs: replacing apm.dev.js configuration
references with kibana.dev.yml
(#152237)](https://github.com/elastic/kibana/pull/152237)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Carly
Richmond","email":"74931905+carlyrichmond@users.noreply.github.com"},"sourceCommit":{"committedDate":"2023-03-08T14:43:34Z","message":"Updating
debugging docs: replacing apm.dev.js configuration references with
kibana.dev.yml (#152237)\n\n## Summary\r\n\r\nUpdating the Debugging
Kibana documentation:\r\n\r\n1. Adding Python as additional
pre-requisite technology\r\n2. Replacing apm.dev.js configuration with
updated kibana.dev.yml\r\napproach\r\n\r\nSimilar to recent discussion
in issue #79490, I've found that the\r\n`apm.dev.js` approach is no
longer working.\r\n\r\n\r\n### Checklist\r\n\r\nDelete any items that
are not applicable to this PR.\r\n\r\n-
[X]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas
added for features that require explanation or tutorials\r\n\r\n### Risk
Matrix\r\n\r\nN/A\r\n\r\n### For maintainers\r\n\r\n- [ ] This was
checked for breaking API changes and was
[labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)","sha":"867c906f6c872357b5e2e6335c5145d1f58e3730","branchLabelMapping":{"^v8.8.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:fix","💝community","backport-v8.0.0","v8.7.0","v8.8.0","v8.7.1"],"number":152237,"url":"https://github.com/elastic/kibana/pull/152237","mergeCommit":{"message":"Updating
debugging docs: replacing apm.dev.js configuration references with
kibana.dev.yml (#152237)\n\n## Summary\r\n\r\nUpdating the Debugging
Kibana documentation:\r\n\r\n1. Adding Python as additional
pre-requisite technology\r\n2. Replacing apm.dev.js configuration with
updated kibana.dev.yml\r\napproach\r\n\r\nSimilar to recent discussion
in issue #79490, I've found that the\r\n`apm.dev.js` approach is no
longer working.\r\n\r\n\r\n### Checklist\r\n\r\nDelete any items that
are not applicable to this PR.\r\n\r\n-
[X]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas
added for features that require explanation or tutorials\r\n\r\n### Risk
Matrix\r\n\r\nN/A\r\n\r\n### For maintainers\r\n\r\n- [ ] This was
checked for breaking API changes and was
[labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)","sha":"867c906f6c872357b5e2e6335c5145d1f58e3730"}},"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/152237","number":152237,"mergeCommit":{"message":"Updating
debugging docs: replacing apm.dev.js configuration references with
kibana.dev.yml (#152237)\n\n## Summary\r\n\r\nUpdating the Debugging
Kibana documentation:\r\n\r\n1. Adding Python as additional
pre-requisite technology\r\n2. Replacing apm.dev.js configuration with
updated kibana.dev.yml\r\napproach\r\n\r\nSimilar to recent discussion
in issue #79490, I've found that the\r\n`apm.dev.js` approach is no
longer working.\r\n\r\n\r\n### Checklist\r\n\r\nDelete any items that
are not applicable to this PR.\r\n\r\n-
[X]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas
added for features that require explanation or tutorials\r\n\r\n### Risk
Matrix\r\n\r\nN/A\r\n\r\n### For maintainers\r\n\r\n- [ ] This was
checked for breaking API changes and was
[labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)","sha":"867c906f6c872357b5e2e6335c5145d1f58e3730"}}]}]
BACKPORT-->

Co-authored-by: Carly Richmond <74931905+carlyrichmond@users.noreply.github.com>
This commit is contained in:
Kibana Machine 2023-03-08 10:03:22 -05:00 • committed by GitHub
parent 44300c29db
commit cd23ef9cbc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

37
docs/developer/getting-started/debugging.asciidoc
View file

@ -38,15 +38,15 @@ https://www.elastic.co/guide/en/apm/agent/nodejs/current/configuration.html#acti
APM config option.
All config options can be set by
creating an appropriate config file under `config/apm.dev.js`.
creating an appropriate config file under `config/kibana.dev.yml`.
Example `config/apm.dev.js` file:
Example `config/kibana.dev.yml` file:
[source,js]
[source,yaml]
----
module.exports = {
active: true,
};
elastic:
apm:
active: true
----
APM
@ -68,7 +68,7 @@ UI in {kib}.
[discrete]
=== Running Kibana with the APM Agent Locally
The easiest and recommended way of running Kibana with the APM agent locally is to use the solution provided by the https://github.com/elastic/apm-integration-testing[apm-integration-testing] repo. You’ll need https://www.docker.com/community-edition[Docker] and https://docs.docker.com/compose/install/[Docker Compose] to use the tool.
The easiest and recommended way of running Kibana with the APM agent locally is to use the solution provided by the https://github.com/elastic/apm-integration-testing[apm-integration-testing] repo. You’ll need https://www.docker.com/community-edition[Docker], https://docs.docker.com/compose/install/[Docker Compose] and https://www.python.org/downloads[Python (version 3 preferred)] to use the tool.
[discrete]
==== Quick start guide
@ -88,6 +88,7 @@ cd apm-integration-testing
./scripts/compose.py start master --no-kibana
----
. Clone the https://github.com/elastic/kibana[elastic/kibana] repo.
. Change into the {kib} repo:
+
[source,bash]
@ -96,20 +97,20 @@ cd ../kibana
----
. Change the elasticsearch credentials in your `kibana.yml` configuration file to match those needed by elasticsearch and the APM server (see the apm-integration-testing repo's https://github.com/elastic/apm-integration-testing#logging-in[README] for users provided to test different scenarios).
. Make sure that the APM agent is active and points to the local APM server by adding the following configuration settings to a config file under `config/apm.dev.js`:
. Make sure that the APM agent is active and points to the local APM server by adding the following configuration settings to a config file under `config/kibana.dev.yml`:
+
Example `config/apm.dev.js` file:
Example `config/kibana.dev.yml` file:
+
[source,js]
[source,yaml]
----
module.exports = {
active: true,
serverUrl: 'http://127.0.0.1:8200', // supports `http://localhost:8200`
centralConfig: false,
breakdownMetrics: false,
transactionSampleRate: 0.1,
metricsInterval: '120s'
};
elastic:
apm:
active: true
serverUrl: http://localhost:8200
secretToken: very_secret
centralConfig: true
breakdownMetrics: true
transactionSampleRate: 0.1
----
. Start Kibana with APM active using: