Instrument Kibana with APM RUM agent #44281

vigneshshanmugam · 2019-08-28T16:05:02Z

Summary

Instruments Kibana and other X-Pack Plugins(APM UI) with Elastic APM RUM JS agent. The agent is code is bundled on the client side and initialised based on ELASTIC_APM_ACTIVE env flag.

For now, this is meant as a useful internal tool for Kibana developers and will not be distributed with
the Kibana distrubution.

Checklist

Use ~~strikethroughs~~ to remove checklist items you don't feel are applicable to this PR.

For maintainers

This was checked for breaking API changes and was labeled appropriately
This includes a feature addition or change that requires a release note and was labeled appropriately

package.json

x-pack/legacy/plugins/apm/typings/apm-rum-react.d copy.ts

spalger · 2019-08-28T18:52:14Z

retest

elasticmachine · 2019-08-28T20:16:19Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-08-29T11:00:38Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-08-29T17:16:45Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

spalger · 2019-08-29T18:26:32Z

Looks like the xpack functional tests are failing because Cannot read property 'toJSON' of undefined

spalger

Please request review from @elastic/kibana-operations once the tests are passing

vigneshshanmugam · 2019-08-29T19:20:00Z

@spalger Sure, would have to wait for Node agent PR to get merged before we merge this one.

elasticmachine · 2019-08-30T10:49:38Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

src/legacy/ui/apm/index.js

elasticmachine · 2019-09-04T11:46:24Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-10-08T14:08:31Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request
Commit: 937cdb0

elasticmachine · 2019-12-06T15:27:14Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request
Commit: 768283d

vigneshshanmugam · 2019-12-09T12:52:01Z

@elastic/kibana-operations Can i get review on this PR? Thanks in advance.

watson · 2019-12-09T16:10:10Z

@vigneshshanmugam What's the idea behind the isKibanaDistributable flag as opposed to only looking at the active config option? Is that as to have an extra guard against accidentally using this in a production environment? If this is a requirement, did you consider also letting the Node.js agent take this into account?

vigneshshanmugam · 2019-12-09T16:15:48Z

@watson It's an extra guard and considered it only for RUM at the moment, since we don't want to ship RUM agent JavaScript bundle to the client even if the flag is set to true by accident. Wont be applicable for the Node.js agent since its we require it anyway in the server.

watson

Now that you no longer use the configFile config option, but manually load the config file. You could make the code a little bit simpler by refactoring the way src/apm.js loads config/apm.js which in turn loads config/apm.dev.js. You could just move the logic of config/apm.js into the getConfig function of src/apm.js and so there's only a need for one config file: config/apm.dev.js. What do you think of that?

src/apm.js

vigneshshanmugam · 2019-12-10T09:34:44Z

I agree with you that it would be simpler and we won't have two config files, But would it be easier for the devs to look at APM specific config inside config/apm.js instead of where the config is loaded? Personally I am okay with removing config/apm.js and move the logic inside src/apm.js

watson · 2019-12-10T10:27:19Z

I don't think there's a big need for people to know the default config current set inside the config/apm.js file. If they are very curious for some reason, src/apm.js isn't hard to find anyway. So feel free to remove config/apm.js 👍

mistic · 2019-12-17T16:20:31Z

@elasticmachine merge upstream

mistic · 2019-12-17T17:56:18Z

@elasticmachine merge upstream

spalger · 2019-12-17T21:30:34Z

@elasticmachine merge upstream

watson

I haven't run this locally, but looking at the code, it all seems perfect 👍

pgayvallet

LGTM for platform changes

Could you please open an issue for the integration in new platform and ping the team on it?

pgayvallet · 2019-12-18T10:22:00Z

src/legacy/ui/ui_render/ui_render_mixin.js

+
+        apm: getApmConfig(legacyMetadata.app),


ping @eliperelman Will need to reintegrate this in renderer PR

pgayvallet · 2019-12-18T10:31:42Z

src/core/public/injected_metadata/injected_metadata_service.ts

+    apm: {
+      [key: string]: unknown;
+    };


Quick note on this: injectedMetadata are more or less already deprecated and might be removed at some point in NP. You have to keep in mind that you need to migrate this to an asynchronous way to access and use this data at some point.

pgayvallet · 2019-12-18T10:39:40Z

src/legacy/ui/public/routes/route_manager.js

+       * In Kibana app, this logic would run after the boostrap js files gets
+       * downloaded and get associated with the page-load transaction
+       */
+      $rootScope.$on('$routeChangeStart', (_, nextRoute) => {


in NP this will probably need to be hooked into ApplicationService.navigateToApp, However NP does not yet exposes that kind of hooks

vigneshshanmugam · 2019-12-18T11:15:31Z

@pgayvallet Thanks for the review,I have opened an issue and added the label for the same #53466

* Instrument Kibana with APM RUM agent * make route-change transaction work with properl url * extract page-load transaction url from app link * check if app is hidden and set active:false * make distributed tracing work and merge config * remove config/apm.js and address review * address review comments * add apm.js to build tassks * move apm from dev to src * add @types/hoist-non-react-statics which is required by react rum * apply changes correctly from master

* Instrument Kibana with APM RUM agent (#44281) * Instrument Kibana with APM RUM agent * make route-change transaction work with properl url * extract page-load transaction url from app link * check if app is hidden and set active:false * make distributed tracing work and merge config * remove config/apm.js and address review * address review comments * add apm.js to build tassks * move apm from dev to src * add @types/hoist-non-react-statics which is required by react rum * apply changes correctly from master * Remove unneded changes * fix apminit Co-authored-by: Vignesh Shanmugam <vignesh.shanmugam22@gmail.com>

* Instrument Kibana with APM RUM agent (#44281) * Instrument Kibana with APM RUM agent * make route-change transaction work with properl url * extract page-load transaction url from app link * check if app is hidden and set active:false * make distributed tracing work and merge config * remove config/apm.js and address review * address review comments * add apm.js to build tassks * move apm from dev to src * add @types/hoist-non-react-statics which is required by react rum * apply changes correctly from master * Suggested fixes Co-authored-by: Vignesh Shanmugam <vignesh.shanmugam22@gmail.com> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

kibanamachine · 2020-07-15T20:29:18Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request
Commit: a7ff3b3

History

💚 Build #16261 succeeded a7ff3b3
💚 Build #16189 succeeded 1bafe3c
💔 Build #16156 failed 2320cf8
💔 Build #16061 failed 55b49d6
💔 Build #16033 failed bd7efad

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

vigneshshanmugam requested review from a team as code owners August 28, 2019 16:05

sorenlouv reviewed Aug 28, 2019

View reviewed changes

package.json Outdated Show resolved Hide resolved

sorenlouv reviewed Aug 28, 2019

View reviewed changes

x-pack/legacy/plugins/apm/typings/apm-rum-react.d copy.ts Outdated Show resolved Hide resolved

sorenlouv added the release_note:skip Skip the PR/issue when compiling release notes label Aug 28, 2019

vigneshshanmugam added the WIP Work in progress label Aug 28, 2019

vigneshshanmugam requested a review from a team as a code owner August 29, 2019 15:40

spalger reviewed Aug 29, 2019

View reviewed changes

vigneshshanmugam commented Sep 4, 2019

View reviewed changes

src/legacy/ui/apm/index.js Outdated Show resolved Hide resolved

vigneshshanmugam self-assigned this Sep 4, 2019

vigneshshanmugam mentioned this pull request Dec 6, 2019

Instrument kibana with APM RUM agent elastic/apm-agent-rum-js#519

Closed

vigneshshanmugam removed the WIP Work in progress label Dec 6, 2019

watson added v7.6.0 v8.0.0 labels Dec 9, 2019

watson reviewed Dec 9, 2019

View reviewed changes

src/apm.js Outdated Show resolved Hide resolved

src/apm.js Outdated Show resolved Hide resolved

vigneshshanmugam added 11 commits December 17, 2019 21:03

Instrument Kibana with APM RUM agent

588fa90

make route-change transaction work with properl url

e7fa67c

extract page-load transaction url from app link

0a1f473

check if app is hidden and set active:false

f13e53b

make distributed tracing work and merge config

2f6cda7

remove config/apm.js and address review

7bddbef

address review comments

793882b

add apm.js to build tassks

cb4b3fa

move apm from dev to src

2a15ae9

add @types/hoist-non-react-statics which is required by react rum

41cb72a

apply changes correctly from master

1b27050

Merge branch 'master' into apm-rum

a7ff3b3

watson approved these changes Dec 18, 2019

View reviewed changes

pgayvallet approved these changes Dec 18, 2019

View reviewed changes

vigneshshanmugam mentioned this pull request Dec 18, 2019

Integration of the APM RUM instrumentation on New Platform. #53466

Closed

vigneshshanmugam merged commit 254b18c into elastic:master Dec 18, 2019

vigneshshanmugam deleted the apm-rum branch December 18, 2019 11:16

smith mentioned this pull request Apr 3, 2020

[7.x] Instrument Kibana with APM RUM agent (#44281) #62482

Merged

smith mentioned this pull request Apr 3, 2020

[7.7] Instrument Kibana with APM RUM agent (#44281) #62484

Merged

elastic deleted a comment from elasticmachine Jul 15, 2020

andreymyssak mentioned this pull request Apr 4, 2023

[Tech Debt] Update js-yaml dependency to >= 4 opensearch-project/OpenSearch-Dashboards#3659

Open

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Instrument Kibana with APM RUM agent #44281

Instrument Kibana with APM RUM agent #44281

vigneshshanmugam commented Aug 28, 2019 •

edited by srinichilak

Loading

spalger commented Aug 28, 2019

elasticmachine commented Aug 28, 2019

elasticmachine commented Aug 29, 2019

elasticmachine commented Aug 29, 2019

spalger commented Aug 29, 2019

spalger left a comment

vigneshshanmugam commented Aug 29, 2019

elasticmachine commented Aug 30, 2019

elasticmachine commented Sep 4, 2019

elasticmachine commented Oct 8, 2019

elasticmachine commented Dec 6, 2019

vigneshshanmugam commented Dec 9, 2019

watson commented Dec 9, 2019

vigneshshanmugam commented Dec 9, 2019

watson left a comment

vigneshshanmugam commented Dec 10, 2019

watson commented Dec 10, 2019

mistic commented Dec 17, 2019

mistic commented Dec 17, 2019

spalger commented Dec 17, 2019

watson left a comment

pgayvallet left a comment

pgayvallet Dec 18, 2019

pgayvallet Dec 18, 2019

pgayvallet Dec 18, 2019

vigneshshanmugam commented Dec 18, 2019

kibanamachine commented Jul 15, 2020

Instrument Kibana with APM RUM agent #44281

Instrument Kibana with APM RUM agent #44281

Conversation

vigneshshanmugam commented Aug 28, 2019 • edited by srinichilak Loading

Summary

Checklist

For maintainers

spalger commented Aug 28, 2019

elasticmachine commented Aug 28, 2019

💚 Build Succeeded

elasticmachine commented Aug 29, 2019

💚 Build Succeeded

elasticmachine commented Aug 29, 2019

💔 Build Failed

spalger commented Aug 29, 2019

spalger left a comment

Choose a reason for hiding this comment

vigneshshanmugam commented Aug 29, 2019

elasticmachine commented Aug 30, 2019

💚 Build Succeeded

elasticmachine commented Sep 4, 2019

💔 Build Failed

elasticmachine commented Oct 8, 2019

💔 Build Failed

elasticmachine commented Dec 6, 2019

💔 Build Failed

vigneshshanmugam commented Dec 9, 2019

watson commented Dec 9, 2019

vigneshshanmugam commented Dec 9, 2019

watson left a comment

Choose a reason for hiding this comment

vigneshshanmugam commented Dec 10, 2019

watson commented Dec 10, 2019

mistic commented Dec 17, 2019

mistic commented Dec 17, 2019

spalger commented Dec 17, 2019

watson left a comment

Choose a reason for hiding this comment

pgayvallet left a comment

Choose a reason for hiding this comment

pgayvallet Dec 18, 2019

Choose a reason for hiding this comment

pgayvallet Dec 18, 2019

Choose a reason for hiding this comment

pgayvallet Dec 18, 2019

Choose a reason for hiding this comment

vigneshshanmugam commented Dec 18, 2019

kibanamachine commented Jul 15, 2020

💔 Build Failed

History

vigneshshanmugam commented Aug 28, 2019 •

edited by srinichilak

Loading