Skip to content

Commit d3c2741

Browse files
committed
Updating debugging docs: replacing apm.dev.js configuration references with kibana.dev.yml (elastic#152237)
## Summary Updating the Debugging Kibana documentation: 1. Adding Python as additional pre-requisite technology 2. Replacing apm.dev.js configuration with updated kibana.dev.yml approach Similar to recent discussion in issue elastic#79490, I've found that the `apm.dev.js` approach is no longer working. ### Checklist Delete any items that are not applicable to this PR. - [X] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials ### Risk Matrix N/A ### For maintainers - [ ] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) (cherry picked from commit 867c906)
1 parent 9428e82 commit d3c2741

File tree

1 file changed

+19
-18
lines changed

1 file changed

+19
-18
lines changed

docs/developer/getting-started/debugging.asciidoc

+19-18
Original file line numberDiff line numberDiff line change
@@ -38,15 +38,15 @@ https://www.elastic.co/guide/en/apm/agent/nodejs/current/configuration.html#acti
3838
APM config option.
3939

4040
All config options can be set by
41-
creating an appropriate config file under `config/apm.dev.js`.
41+
creating an appropriate config file under `config/kibana.dev.yml`.
4242

43-
Example `config/apm.dev.js` file:
43+
Example `config/kibana.dev.yml` file:
4444

45-
[source,js]
45+
[source,yaml]
4646
----
47-
module.exports = {
48-
active: true,
49-
};
47+
elastic:
48+
apm:
49+
active: true
5050
----
5151

5252
APM
@@ -68,7 +68,7 @@ UI in {kib}.
6868
[discrete]
6969
=== Running Kibana with the APM Agent Locally
7070

71-
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.
71+
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.
7272

7373
[discrete]
7474
==== Quick start guide
@@ -88,6 +88,7 @@ cd apm-integration-testing
8888
./scripts/compose.py start master --no-kibana
8989
----
9090

91+
. Clone the https://github.com/elastic/kibana[elastic/kibana] repo.
9192
. Change into the {kib} repo:
9293
+
9394
[source,bash]
@@ -96,20 +97,20 @@ cd ../kibana
9697
----
9798

9899
. 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).
99-
. 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`:
100+
. 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`:
100101
+
101-
Example `config/apm.dev.js` file:
102+
Example `config/kibana.dev.yml` file:
102103
+
103-
[source,js]
104+
[source,yaml]
104105
----
105-
module.exports = {
106-
active: true,
107-
serverUrl: 'http://127.0.0.1:8200', // supports `http://localhost:8200`
108-
centralConfig: false,
109-
breakdownMetrics: false,
110-
transactionSampleRate: 0.1,
111-
metricsInterval: '120s'
112-
};
106+
elastic:
107+
apm:
108+
active: true
109+
serverUrl: http://localhost:8200
110+
secretToken: very_secret
111+
centralConfig: true
112+
breakdownMetrics: true
113+
transactionSampleRate: 0.1
113114
----
114115

115116
. Start Kibana with APM active using:

0 commit comments

Comments
 (0)