Debugging with apm - fixes and tutorial #127892

lizozom · 2022-03-16T16:12:50Z

Summary

Improve the APM-Kibana setup and documentation.

Use values from kibana.dev.yml instead of apm.dev.js on local environments
Omit the secretToken from the configurations sent to the client (APM RUM doesn't need it)
Read process.env.ELASTIC_APM_SERVER_URL in packages/kbn-apm-config-loader/src/config.ts for consistency
Added jest tests
Added instructions for enabling APM on a local dev environment.

Checklist

Delete any items that are not applicable to this PR.

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios
Any UI touched in this PR is usable by keyboard only (learn more about keyboard accessibility)
Any UI touched in this PR does not create any new axe failures (run axe in browser: FF, Chrome)
If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list
This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)
This was checked for cross-browser compatibility

Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release.

When forming the risk matrix, consider some of the following examples and how they may potentially impact the change:

Risk	Probability	Severity	Mitigation/Notes
Multiple Spaces—unexpected behavior in non-default Kibana Space.	Low	High	Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces.
Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks.	High	Low	Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure.
Code should gracefully handle cases when feature X or plugin Y are disabled.	Medium	High	Unit tests will verify that any feature flag or plugin combination still results in our service operational.
See more potential risk examples

For maintainers

This was checked for breaking API changes and was labeled appropriately

Add config tests

…ng-with-apm

lizozom · 2022-03-17T16:23:27Z

packages/kbn-apm-config-loader/src/utils/get_config_file_paths.ts

+  const configPath = getConfigPath();
+
+  // Pick up settings from dev.yml as well
+  return [configPath, configPath.replace('kibana.yml', 'kibana.dev.yml')];


If anyone has a better idea how to get configs from kibana.dev.yml in a package, I'm open to it!

lizozom · 2022-03-17T16:23:50Z

src/core/server/http_resources/get_apm_config.ts

 import { getConfiguration, shouldInstrumentClient } from '@kbn/apm-config-loader';

+const OMIT_APM_CONFIG: Array<keyof AgentConfigOptions> = ['secretToken'];


Potential simple solution for #118505

lizozom · 2022-03-17T16:24:29Z

packages/kbn-apm-config-loader/src/config.ts

-   * Get the configuration from the apm.dev.js file, supersedes config
-   * from the --config file, disabled when running the distributable
-   */
-  private getDevConfig(): AgentConfigOptions {


Using kibana.dev.yml is a more standard and intuitive way.

We knew we'd be changing where we read the config from eventually, just didn't have support for config in kibana.dev.yml at the time the package was added.

lizozom · 2022-03-17T16:27:21Z

packages/kbn-apm-config-loader/src/config.ts

@@ -136,6 +136,10 @@ export class ApmConfiguration {
      config.serverUrl = process.env.ELASTIC_APM_SERVER_URL;
    }

+    if (process.env.ELASTIC_APM_SECRET_TOKEN) {


All these environemnt values are also picked up automatically by apm-node-agent.
However, we should be consistent, so I added this one here (ELASTIC_APM_SERVER_URL was passed in but ELASTIC_APM_SECRET_TOKEN was fetched by the agent)

…ng-with-apm

lizozom · 2022-03-21T15:00:28Z

packages/kbn-apm-config-loader/src/config.ts

@@ -24,7 +24,7 @@ const DEFAULT_CONFIG: AgentConfigOptions = {
  globalLabels: {},
 };

-const CENTRALIZED_SERVICE_BASE_CONFIG: AgentConfigOptions | RUMAgentConfigOptions = {
+export const CENTRALIZED_SERVICE_BASE_CONFIG: AgentConfigOptions | RUMAgentConfigOptions = {


exported for tests

vigneshshanmugam

LGTM on the APM side.

stacey-gammon · 2022-03-21T17:05:58Z

I don't know what is going on with GitHub, but I can't seem to find the place to LGTM! Doc changes look good.

stacey-gammon

Found it. Doc changes LGTM

lizozom · 2022-03-21T17:39:18Z

@elasticmachine merge upstream

TinaHeiligers

LGTM,
Thanks for the tutorial and docs update.

TinaHeiligers · 2022-03-21T22:02:46Z

packages/kbn-apm-config-loader/src/config.ts

-   * Get the configuration from the apm.dev.js file, supersedes config
-   * from the --config file, disabled when running the distributable
-   */
-  private getDevConfig(): AgentConfigOptions {


We knew we'd be changing where we read the config from eventually, just didn't have support for config in kibana.dev.yml at the time the package was added.

danielmitterdorfer

Looks fine overall, I've suggested a few changes to the docs.

dev_docs/tutorials/debugging.mdx

… debugging-with-apm

…ebugging-with-apm

danielmitterdorfer

I pointed out two new typos but apart from that the changes look good to me. Please feel free to merge without another review round after addressing the changes.

danielmitterdorfer · 2022-03-22T12:30:16Z

dev_docs/tutorials/debugging.mdx

+
+Frontend (APM RUM): 
+ * `http-request`- tracks all outgoing API requests
+ * `page-load` - tracks the inidial loading time of kibana


Nit - typo: inidial -> initial

dev_docs/tutorials/debugging.mdx

kibana-ci · 2022-03-22T12:56:07Z

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

💚 Build #32322 succeeded 721ec25
💚 Build #32225 succeeded f7fd66e
💔 Build #31520 failed 5542796
💔 Build #31459 failed 6b4cdef
💔 Build #31021 failed 11a2f5a

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @lizozom

* fixes + tutorial * cors config * omit secretToken so its not sent to FE Add config tests * lint * empty * swallow errors when parsing configs * read config test adjustment * apm docs review * new line * doc review Co-authored-by: Kibana Machine <[email protected]> (cherry picked from commit c97bfc8)

kibanamachine · 2022-03-22T13:05:04Z

💔 Some backports could not be created

Status	Branch	Result
❌	8.3	The branch "8.3" is invalid or doesn't exist
✅	8.1

Manual backport

To create the backport manually run:

node scripts/backport --pr 127892

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

* fixes + tutorial * cors config * omit secretToken so its not sent to FE Add config tests * lint * empty * swallow errors when parsing configs * read config test adjustment * apm docs review * new line * doc review Co-authored-by: Kibana Machine <[email protected]> (cherry picked from commit c97bfc8) Co-authored-by: Liza Katz <[email protected]>

mshustov · 2022-03-22T15:11:20Z

dev_docs/tutorials/debugging.mdx

+
+ 1. Create a secondary monitoring deployment to collect APM data. The easiest option is to use [Elastic Cloud](https://cloud.elastic.co/deployments) to create a new deployment.
+ 2. Open Kibana, go to `Integrations` and enable the Elastic APM integration.
+ 3. Scroll down and copy the server URL and secret token. You may also find them in your cloud console under APM & Fleet.


Could you attach some screenshots to help identify them in UI?

mshustov · 2022-03-22T15:12:58Z

dev_docs/tutorials/debugging.mdx

+
+ * ELASTIC_APM_ACTIVE
+ * ELASTIC_APM_SERVER_URL
+ * ELASTIC_APM_SECRET_TOKEN


could you add an example? ELASTIC_APM_ACTIVE=true; yarn start;...?

mshustov · 2022-03-22T15:15:37Z

packages/kbn-apm-config-loader/src/utils/read_config.ts

+const readYaml = (path: string) => {
+  try {
+    return safeLoad(readFileSync(path, 'utf8'));
+  } catch (e) {


I guess safeLoad function shouldn't throw an exception :D

* fixes + tutorial * cors config * omit secretToken so its not sent to FE Add config tests * lint * empty * swallow errors when parsing configs * read config test adjustment * apm docs review * new line * doc review Co-authored-by: Kibana Machine <[email protected]> (cherry picked from commit c97bfc8) # Conflicts: # packages/kbn-apm-config-loader/src/config.test.ts # packages/kbn-apm-config-loader/src/config.ts # src/core/server/http_resources/get_apm_config.ts

* Debugging with apm - fixes and tutorial (#127892) * fixes + tutorial * cors config * omit secretToken so its not sent to FE Add config tests * lint * empty * swallow errors when parsing configs * read config test adjustment * apm docs review * new line * doc review Co-authored-by: Kibana Machine <[email protected]> (cherry picked from commit c97bfc8) # Conflicts: # packages/kbn-apm-config-loader/src/config.test.ts # packages/kbn-apm-config-loader/src/config.ts # src/core/server/http_resources/get_apm_config.ts * fix merge

This automatically sets up APM in any Elasticsearch instance that Kibana starts through @elastic/kbn-es. This includes integration and e2e tests. It respects the same configuration as kibana and can be locally overridden in kibana.dev.yml as per elastic#127892. It will bootstrap `secret_token` and `api_key` in the local Elasticsearch secret store but as this appears to be broken for now these are passed directly to Elasticsearch as well.

lizozom added 6 commits March 16, 2022 18:10

fixes + tutorial

3c8bd0a

cors config

11a2f5a

omit secretToken so its not sent to FE

78167a5

Add config tests

Merge branch 'main' of https://github.com/elastic/kibana into debuggi…

5f4e287

…ng-with-apm

lint

29aa046

empty

6b4cdef

lizozom mentioned this pull request Mar 17, 2022

APM agent configuration #118505

Closed

lizozom commented Mar 17, 2022

View reviewed changes

lizozom added 3 commits March 17, 2022 19:35

swallow errors when parsing configs

5542796

Merge branch 'main' of https://github.com/elastic/kibana into debuggi…

f4d8203

…ng-with-apm

read config test adjustment

735f393

lizozom marked this pull request as ready for review March 21, 2022 14:22

lizozom requested review from a team and vigneshshanmugam as code owners March 21, 2022 14:22

lizozom added 2 commits March 21, 2022 16:58

apm docs review

306266d

new line

f7fd66e

lizozom commented Mar 21, 2022

View reviewed changes

lizozom added release_note:skip Skip the PR/issue when compiling release notes v8.2.0 v8.3.0 v8.1.2 DevDocs labels Mar 21, 2022

lizozom self-assigned this Mar 21, 2022

vigneshshanmugam approved these changes Mar 21, 2022

View reviewed changes

stacey-gammon approved these changes Mar 21, 2022

View reviewed changes

Merge branch 'main' into debugging-with-apm

721ec25

TinaHeiligers approved these changes Mar 21, 2022

View reviewed changes

danielmitterdorfer reviewed Mar 22, 2022

View reviewed changes

lizozom added 3 commits March 22, 2022 13:28

doc review

4a1979f

git pushMerge branch 'main' of https://github.com/elastic/kibana into…

45827a0

… debugging-with-apm

Merge branch 'debugging-with-apm' of github.com:lizozom/kibana into d…

be470b9

…ebugging-with-apm

danielmitterdorfer approved these changes Mar 22, 2022

View reviewed changes

lizozom merged commit c97bfc8 into elastic:main Mar 22, 2022

lizozom added the auto-backport Deprecated - use backport:version if exact versions are needed label Mar 22, 2022

kibanamachine mentioned this pull request Mar 22, 2022

[8.1] Debugging with apm - fixes and tutorial (#127892) #128256

Merged

lizozom removed the v8.3.0 label Mar 22, 2022

mshustov reviewed Mar 22, 2022

View reviewed changes

lizozom mentioned this pull request Apr 6, 2022

[7.17] Debugging with apm - fixes and tutorial (#127892) #129600

Merged

jportner added the v7.17.3 label Apr 7, 2022

lizozom mentioned this pull request Apr 18, 2022

Upgrade elastic.apm.* configuration to "beta" #99328

Closed

7 tasks

This was referenced Aug 9, 2022

[APM Agent] Replace support for apm.dev.js with support for kibana.dev.yml in apm-config-loader #79490

Closed

[Tracing] Add Elasticsearch instrumentation support to @elastic/kbn-es #138418

Closed

Mpdreamz mentioned this pull request Sep 6, 2022

[Tracing] Add Elasticsearch instrumentation support to @elastic/kbn-es #140121

Closed

trentm mentioned this pull request Mar 7, 2023

Updating debugging docs: replacing apm.dev.js configuration references with kibana.dev.yml #152237

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Debugging with apm - fixes and tutorial #127892

Debugging with apm - fixes and tutorial #127892

lizozom commented Mar 16, 2022 •

edited

Loading

lizozom Mar 17, 2022

lizozom Mar 17, 2022

lizozom Mar 17, 2022

TinaHeiligers Mar 21, 2022

lizozom Mar 17, 2022

lizozom Mar 21, 2022

vigneshshanmugam left a comment

stacey-gammon commented Mar 21, 2022

stacey-gammon left a comment

lizozom commented Mar 21, 2022

TinaHeiligers left a comment

TinaHeiligers Mar 21, 2022

danielmitterdorfer left a comment

danielmitterdorfer left a comment

danielmitterdorfer Mar 22, 2022

kibana-ci commented Mar 22, 2022

kibanamachine commented Mar 22, 2022

mshustov Mar 22, 2022

mshustov Mar 22, 2022

mshustov Mar 22, 2022

		import { getConfiguration, shouldInstrumentClient } from '@kbn/apm-config-loader';

		const OMIT_APM_CONFIG: Array<keyof AgentConfigOptions> = ['secretToken'];

Debugging with apm - fixes and tutorial #127892

Debugging with apm - fixes and tutorial #127892

Conversation

lizozom commented Mar 16, 2022 • edited Loading

Summary

Checklist

Risk Matrix

For maintainers

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vigneshshanmugam left a comment

Choose a reason for hiding this comment

stacey-gammon commented Mar 21, 2022

stacey-gammon left a comment

Choose a reason for hiding this comment

lizozom commented Mar 21, 2022

TinaHeiligers left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

danielmitterdorfer left a comment

Choose a reason for hiding this comment

danielmitterdorfer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kibana-ci commented Mar 22, 2022

💚 Build Succeeded

Metrics [docs]

History

kibanamachine commented Mar 22, 2022

💔 Some backports could not be created

Manual backport

Questions ?

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lizozom commented Mar 16, 2022 •

edited

Loading