[KP] instrument platform server-side code with apm agent

[mshustov]

Summary

Adds tracking for setup & start lifecycles of Kibana server + SO migration operation.

How to test locally:

• clone https://github.com/elastic/apm-integration-testing
• cd apm-integration-testing
• ./scripts/compose.py start master --no-kibana
• cd ../kibana
• you might need to change elasticsearch credentials (I used admin/changeme)
• make sure APM agent is active and points to the local APM server https://github.com/elastic/kibana/blob/master/packages/kbn-apm-config-loader/src/config.ts#L36-L37
  set active: true, serverUrl: 'http://127.0.0.1:8200'
• run Kibana: ELASTIC_APM_ACTIVE=true yarn start
• you can see transactions in the APM app
• stop Kibana, stop agents: ./scripts/compose.py stop

For maintainers

• This was checked for breaking API changes and was labeled appropriately

[elasticmachine]

Pinging @elastic/kibana-platform (Team:Platform)

[mshustov]

@vigneshshanmugam Will we be able to see the added APM metrics in the Cloud? Or additional setup required?

[vigneshshanmugam]

@restrry Are you referring to Metrics captured by the Node.js agent? You would be able to see them under Metrics tab in API UI.

[mshustov]

@vigneshshanmugam yeah, I tested it locally. I'm wondering when I can see them in APM for Cloud Dev env?

[vigneshshanmugam]

@restrry Ah, got it. Seems like the clod is on 7.7 version, I will ask the team to update to the latest stack and you should be able to see it.

[pgayvallet]

NIT: migrationSpan?.end(); (multiple occurences)

[mshustov]

for this, we need to turn off eslint/no-unused-expressions and use @typescript-eslint/no-unused-expressions instead.
typescript-eslint/typescript-eslint#1220

[pgayvallet]

Tested locally. Found the added transactions and spans, seems to be working as intended.

Remark:

apm.startSpan('saved_objects', 'migration'); seems to be creating a span with name saved_objects and type migration:

Just want to be sure that it really is what we want.

Question:

Are plugins supposed to be able to open a transaction during their setup or start phase? If so, are nested transactions a thing, as we already have a higher level transaction for core's setup and start.

[mshustov]

Are plugins supposed to be able to open a transaction during their setup or start phase? If so, are nested transactions a thing, as we already have a higher level transaction for core's setup and start.

I'd expect so, because Transactions are a special kind of span that have additional attributes associated with them.

seems to be creating a span with name saved_objects and type migration:

I didn't test this after the change. I will roll it back to apm.startSpan('saved_objects.migration', 'migration');

[pgayvallet]

LGTM

[mshustov]

@elasticmachine merge upstream

[joshdover]

@restrry could we get this in for 7.10? I'd love to include these metrics in our first iteration of APM on Cloud

[mshustov]

@joshdover sure, I will update the branch

[mshustov]

updated

[mshustov]

@elasticmachine merge upstream

[mshustov]

@elasticmachine merge upstream

[mistic]

@elasticmachine merge upstream

[mshustov]

@elasticmachine merge upstream

[kibanamachine]

💚 Build Succeeded

• continuous-integration/kibana-ci/pull-request
• Commit: 32c8fd2

Metrics [docs]

✅ unchanged

History

• 💚 Build #78430 succeeded af896d4
• 💔 Build #78332 failed 14e54aa
• 💔 Build #78256 failed 83b7dbe
• 💔 Build #78175 failed b463255
• 💔 Build #77865 failed 0b091a5

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