03 - Spacetime apm api shared by cauemarcondes · Pull Request #268992 · elastic/kibana

cauemarcondes · 2026-05-12T19:24:58Z

Summary

Creates the @kbn/apm-api-shared package (x-pack/platform/packages/shared/kbn-apm-api-shared) and defines all APM route definitions as typed contracts.

This introduces:

A defineRoute utility and shared default API types (kueryRt, rangeRt, probabilityRt, etc.)
Typed route definitions for all APM API endpoints organized by domain: agent configuration, agent explorer, agent keys, alerts, anomaly detection, assistant functions, correlations, custom dashboards, custom links, data views, debug telemetry, dependencies, diagnostics, environments, errors, fallback to transactions, fleet, infrastructure, latency distribution, metrics, mobile, profiling, service groups, service map, services, source maps, span links, storage explorer, suggestions, time range metadata, traces, and transactions
callApi and createCallApmApi client utilities for type-safe API consumption

This is the third PR in a stack:

PR 1: 01 - Spacetime apm types
PR 2: 02 - Spacetime apm common
PR 3 (this): Create @kbn/apm-api-shared with APM route definitions
PR 4: 04 - Spacetime apm changes

## Summary Extracts agent configuration definitions from the `apm` plugin into the `@kbn/apm-common` package (`x-pack/platform/packages/shared/kbn-apm-common`). This moves agent configuration types, constants, runtime types (duration, bytes, boolean, integer, capture body, etc.), setting definitions (general, Java, mobile, eDOT SDK), and related tests out of `x-pack/solutions/observability/plugins/apm/common/agent_configuration/` into the shared platform package. The APM plugin files now re-export from `@kbn/apm-common` to maintain backwards compatibility. The package is placed under `x-pack/` since its only consumer is the APM plugin, which is already in x-pack. This is the second PR in a stack: - **PR 1:** [01 - Spacetime apm types](#268981) - **PR 2 (this):** Move agent configuration definitions to `@kbn/apm-common` - **PR 3:** [03 - Spacetime apm api shared](#268992) --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>

## Summary Extracts agent configuration definitions from the `apm` plugin into the `@kbn/apm-common` package (`x-pack/platform/packages/shared/kbn-apm-common`). This moves agent configuration types, constants, runtime types (duration, bytes, boolean, integer, capture body, etc.), setting definitions (general, Java, mobile, eDOT SDK), and related tests out of `x-pack/solutions/observability/plugins/apm/common/agent_configuration/` into the shared platform package. The APM plugin files now re-export from `@kbn/apm-common` to maintain backwards compatibility. The package is placed under `x-pack/` since its only consumer is the APM plugin, which is already in x-pack. This is the second PR in a stack: - **PR 1:** [01 - Spacetime apm types](elastic#268981) - **PR 2 (this):** Move agent configuration definitions to `@kbn/apm-common` - **PR 3:** [03 - Spacetime apm api shared](elastic#268992) --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>

…ally, or add an exception to src/dev/yarn_deduplicate/index.ts and then commit the changes and push to your branch

kibanamachine · 2026-05-28T19:46:16Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: 96def99
Build duration: 56 mins

Failed CI Steps

FTR Configs #99

Test Failures

[job] [logs] FTR Configs #99 / Serverless Common UI - Home Page Sample data in serverless Sample data loads

Metrics [docs]

✅ unchanged

History

💔 Build #449294 failed 9afaa37

lucaslopezf

LGTM! Just a few comments to take into account just in case, but I'll compare every file with the original in part 04.
Note for other reviewer: you might think some options, security-related metadata, etc, are missing, but they're addressed in part 04. For example source_maps/route.ts#L61-L75. I’m saying this because at first I left comments referring to these points, but when I saw part 04, I realized they were already addressed there

lucaslopezf · 2026-05-29T10:53:13Z

+  params: t.type({
+    body: t.type({
+      name: t.string,
+      privileges: t.array(t.union([t.literal('event:write'), t.literal('config_agent:read')])),


Should we use this file?

lucaslopezf · 2026-05-29T13:22:52Z

+
+export const fieldValueStatsTransactionsRoute = defineRoute<FieldValueStatsTransactionsResponse>()({
+  endpoint: 'GET /internal/apm/correlations/field_value_stats/transactions',
+  params: t.type({


Why these params are different to the original?

lucaslopezf · 2026-05-29T13:57:36Z

+  endpoint: 'GET /internal/apm/service-map',
+  params: t.type({
+    query: t.intersection([
+      t.partial({


We are losing this field

lucaslopezf · 2026-05-29T14:06:15Z

+      service_name: t.string,
+      service_version: t.string,
+      bundle_filepath: t.string,
+      sourcemap: t.union([t.string, t.any]).pipe(jsonRt).pipe(sourceMapRt),


This is different from the original just take in account for the next PR

lucaslopezf · 2026-05-29T14:08:18Z

@@ -0,0 +1,86 @@
+/*


If C and me checked well, we are missing the nexts routes:

https://github.com/elastic/kibana/blob/main/x-pack/solutions/observability/plugins/apm/server/routes/services/route.ts#L311-L319

https://github.com/elastic/kibana/blob/main/x-pack/solutions/observability/plugins/apm/server/routes/services/route.ts#L946-L984

https://github.com/elastic/kibana/blob/main/x-pack/solutions/observability/plugins/apm/server/routes/services/route.ts#L447-L520

Is it dead code?

cauemarcondes force-pushed the spacetime-03-apm-api-shared branch 3 times, most recently from b5c54f8 to e94edf6 Compare May 12, 2026 20:12

cauemarcondes added release_note:skip Skip the PR/issue when compiling release notes backport:skip This PR does not require backporting v9.5.0 labels May 12, 2026

cauemarcondes force-pushed the spacetime-03-apm-api-shared branch 3 times, most recently from 87ada6d to 8d12376 Compare May 13, 2026 12:13

This was referenced May 13, 2026

02 - Spacetime apm common #268991

Merged

04 - Spacetime apm changes #268999

Draft

cauemarcondes force-pushed the spacetime-02-apm-common branch from 4512b55 to 46b7d51 Compare May 14, 2026 18:00

cauemarcondes force-pushed the spacetime-03-apm-api-shared branch from f13e396 to 7c59999 Compare May 14, 2026 18:01

cauemarcondes force-pushed the spacetime-02-apm-common branch from 46b7d51 to fb27ffa Compare May 19, 2026 17:56

cauemarcondes force-pushed the spacetime-03-apm-api-shared branch from 7c59999 to b45fed3 Compare May 19, 2026 18:01

cauemarcondes force-pushed the spacetime-02-apm-common branch from fb27ffa to 3288f6e Compare May 19, 2026 18:35

cauemarcondes changed the base branch from spacetime-02-apm-common to main May 27, 2026 18:20

cauemarcondes and others added 11 commits May 27, 2026 14:26

moving APM types to apm-types pkg

2040c6f

re-exporting

68c4d95

ficing ci

7d660c8

Changes from node scripts/lint_ts_projects --fix

a527d26

Changes from node scripts/regenerate_moon_projects.js --update

6478813

limits

8624ac6

TO FIX: Run node 'scripts/yarn_deduplicate && yarn kbn bootstrap' loc…

f70b61f

…ally, or add an exception to src/dev/yarn_deduplicate/index.ts and then commit the changes and push to your branch

Changes from node scripts/lint_ts_projects --fix

2327957

Changes from node scripts/regenerate_moon_projects.js --update

f9ad718

event outcome

d41f7ab

fixing ebt

e843995

cauemarcondes added 9 commits May 27, 2026 14:34

fixing export

841a0fd

moving env definitions

261e387

moving stuff around

dfc0f63

refactoring

11e3e48

moving env definitions

4b1ed12

apm-api-shared

6818d92

import fixes

aadda4f

updating imports

eaf1a7d

updating license

1de363c

cauemarcondes force-pushed the spacetime-03-apm-api-shared branch from b45fed3 to 1de363c Compare May 27, 2026 18:35

cauemarcondes added 5 commits May 27, 2026 14:56

apm-common merging problem

e422a0c

fixing apm-common

000eb83

fixing merge problem

9681d5d

reverting env

5ef4927

relocating

b79e376

cauemarcondes marked this pull request as ready for review May 27, 2026 23:16

kibanamachine and others added 11 commits May 27, 2026 23:22

Changes from node scripts/lint.js --fix

5094b8a

Changes from node scripts/lint_ts_projects --fix

270190c

Changes from node scripts/generate codeowners

6cebe24

Changes from node scripts/regenerate_moon_projects.js --update

9afaa37

renaming package

c4120be

removing data_view route

83ecc61

removing diagnostics

a67bbdf

Changes from node scripts/lint.js --fix

9ddc1cd

Changes from node scripts/lint_ts_projects --fix

e3f6514

Changes from node scripts/generate codeowners

c80230b

Changes from node scripts/regenerate_moon_projects.js --update

96def99

lucaslopezf self-requested a review May 29, 2026 09:42

lucaslopezf approved these changes May 29, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

03 - Spacetime apm api shared#268992

03 - Spacetime apm api shared#268992
cauemarcondes wants to merge 45 commits into
elastic:mainfrom
cauemarcondes:spacetime-03-apm-api-shared

cauemarcondes commented May 12, 2026 •

edited

Loading

Uh oh!

kibanamachine commented May 28, 2026

Uh oh!

lucaslopezf left a comment

Uh oh!

lucaslopezf May 29, 2026

Uh oh!

lucaslopezf May 29, 2026

Uh oh!

lucaslopezf May 29, 2026

Uh oh!

lucaslopezf May 29, 2026

Uh oh!

lucaslopezf May 29, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

cauemarcondes commented May 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Uh oh!

kibanamachine commented May 28, 2026

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

Metrics [docs]

History

Uh oh!

lucaslopezf left a comment

Choose a reason for hiding this comment

Uh oh!

lucaslopezf May 29, 2026

Choose a reason for hiding this comment

Uh oh!

lucaslopezf May 29, 2026

Choose a reason for hiding this comment

Uh oh!

lucaslopezf May 29, 2026

Choose a reason for hiding this comment

Uh oh!

lucaslopezf May 29, 2026

Choose a reason for hiding this comment

Uh oh!

lucaslopezf May 29, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

cauemarcondes commented May 12, 2026 •

edited

Loading