[Fleet] Remove deprecated APIs for agents endpoints #198313

nchaulet · 2024-10-30T12:24:11Z

Summary

Related to #189746

Remove API endpoints

POST /service-tokens in favor of POST /service_tokens
GET /agent-status in favor GET /agent_status
PUT /agents/:agentid/reassign in favor of POST /agents/:agentid/reassign

Remove deprecated parameters or response

Remove total from GET /agent_status response
Remove list from GET /agents response

Our UI was still consuming the total field in some places, I made the changes to not use anymore, this could cause some errors during the upgrade if two kibana version are running but it seems code handle that missing field well.

To keep those removal PR readable and easy to review I will do separate similar PR for epm endpoints and enrollment api keys endpoints

Did some manual testing of Fleet, nothing seems to be broken and looking at telemetry those deletions seems relatively safe.

…t --include-path /api/status --include-path /api/alerting/rule/ --include-path /api/alerting/rules --include-path /api/actions --include-path /api/security/role --include-path /api/spaces --include-path /api/fleet --update'

…kibana into feature-remove-deprecated-apis

elasticmachine · 2024-10-30T18:09:12Z

Pinging @elastic/fleet (Team:Fleet)

…deprecated-apis

…t --include-path /api/status --include-path /api/alerting/rule/ --include-path /api/alerting/rules --include-path /api/actions --include-path /api/security/role --include-path /api/spaces --include-path /api/fleet --update'

nchaulet · 2024-10-31T00:43:37Z

@criamico @juliaElastic it seems observability-perf is relying a lot on calling GET /agent_status with a kuery parameter I am wondering if it really make sense to remove that API parameter?

gergoabraham

@elastic/security-defend-workflows relevant changes: active is used instead of the now removed total from the response of GET /agent_status, and based on the code snippet below, they are the same, so the related changes look good! thanks for updating the code 🙌

kibana/x-pack/plugins/fleet/server/services/agents/status.ts

Lines 166 to 177 in 7dea07f

    
           const allActive = allStatuses - combinedStatuses.unenrolled - combinedStatuses.inactive; 
        
           return { 
        
             ...combinedStatuses, 
        
             all: allStatuses, 
        
             active: allActive, 
        
             /* @deprecated no agents will have other status */ 
        
             other: 0, 
        
             /* @deprecated Agent events do not exists anymore */ 
        
             events: 0, 
        
             /* @deprecated use active instead */ 
        
             total: allActive, 
        
           };

…t --include-path /api/status --include-path /api/alerting/rule/ --include-path /api/alerting/rules --include-path /api/actions --include-path /api/security/role --include-path /api/spaces --include-path /api/fleet --update'

criamico · 2024-10-31T15:06:54Z

it seems observability-perf is relying a lot on calling GET /agent_status with a kuery parameter I am wondering if it really make sense to remove that API parameter?

As discussed in slack, this deprecation was firstly introduced as preliminary work for #161064, but it was then decided to keep the kuery parameter, as highlighted in the PR description. This deprecation was then mistakenly kept, but seeing that it's still used and useful I think it's ok to keep it.

nchaulet · 2024-10-31T15:48:56Z

@elasticmachine merge upstream

criamico · 2024-10-31T16:09:53Z

...et/public/applications/fleet/sections/agents/agent_list_page/hooks/use_fetch_agents_data.tsx

@@ -218,8 +217,10 @@ export function useFetchAgentsData() {
              getStatusSummary: true,
              withMetrics: displayAgentMetrics,
            }),
-            sendGetAgentStatus({
+            sendGetAgents({


As we are not going to deprecate usage of kuery in agent_status, is this change still needed? Or you prefer to change it anyway?

I will remove those changes 👍

criamico · 2024-10-31T16:10:29Z

...ins/fleet/public/applications/fleet/sections/agents/components/agent_upgrade_modal/index.tsx

@@ -135,10 +135,11 @@ export const AgentUpgradeAgentModal: React.FunctionComponent<AgentUpgradeAgentMo

      // if selection is a query, do an api call to get updating agents
      try {
-        const res = await sendGetAgentStatus({
+        const res = await sendGetAgentsQuery({


Same as above

maxcold

cloud_defend and cloud_security_posture changes lgtm

criamico

LGTM 🚀

…t --include-path /api/status --include-path /api/alerting/rule/ --include-path /api/alerting/rules --include-path /api/actions --include-path /api/security/role --include-path /api/spaces --include-path /api/fleet --update'

…deprecated-apis

nchaulet · 2024-10-31T22:49:26Z

@elasticmachine merge upstream

elasticmachine · 2024-11-01T00:49:27Z

💚 Build Succeeded

Buildkite Build
Commit: 579ca1b

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`fleet`	1301	1300	-1

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`fleet`	1.7MB	1.7MB	+6.0B
`securitySolution`	21.0MB	21.0MB	+1.0B
total			+7.0B

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`fleet`	173.1KB	173.0KB	-110.0B

Unknown metric groups

API count

id	before	after	diff
`fleet`	1426	1423	-3

ESLint disabled line counts

id	before	after	diff
`fleet`	48	47	-1

Total ESLint disabled count

id	before	after	diff
`fleet`	60	59	-1

History

💛 Build #247616 was flaky eef3ee2
💔 Build #247584 failed 86c884c
💔 Build #247465 failed c09e839
💔 Build #247305 failed 0cb5503
💔 Build #247295 failed 6a25257
💔 Build #247237 failed c46937c

cc @nchaulet

nchaulet and others added 5 commits October 29, 2024 17:26

POST /service-tokens

390065b

remove GET /agent-status

da75520

Remove PUT /agents/:agentid/reassign

b85daf4

remve GET agent_status total and kuery

2513809

nchaulet self-assigned this Oct 30, 2024

nchaulet added release_note:breaking backport:skip This commit does not require backporting labels Oct 30, 2024

nchaulet changed the title ~~[Fleet] Remove deprecated APIs~~ [Fleet] Remove deprecated APIs for agents endpoints Oct 30, 2024

nchaulet and others added 3 commits October 30, 2024 10:30

remove usage of total in other plugins

89b1931

remove list from GET agents response

26bdd2d

nchaulet mentioned this pull request Oct 30, 2024

[Fleet] Remove deprecated APIs, parameters, and response properties from Fleet API #189746

Closed

kibanamachine and others added 3 commits October 30, 2024 16:03

[CI] Auto-commit changed files from 'make api-docs'

f060705

fix tests

26faa4f

Merge branch 'feature-remove-deprecated-apis' of github.com:nchaulet/…

e8afe38

…kibana into feature-remove-deprecated-apis

nchaulet marked this pull request as ready for review October 30, 2024 17:55

nchaulet requested review from a team as code owners October 30, 2024 17:55

nchaulet requested review from joeypoon and gergoabraham October 30, 2024 17:55

fix types

0862679

botelastic bot added the Team:Fleet Team label for Observability Data Collection Fleet team label Oct 30, 2024

nchaulet and others added 5 commits October 30, 2024 15:04

fix types

c46937c

Merge branch 'main' of github.com:elastic/kibana into feature-remove-…

b941f49

…deprecated-apis

fix tests

8e49c7f

[CI] Auto-commit changed files from 'make api-docs'

6a25257

fix agent status tests

0cb5503

gergoabraham approved these changes Oct 31, 2024

View reviewed changes

nchaulet and others added 4 commits October 31, 2024 08:47

fix api integration tests

7daa311

Reintroduce agent status kuery parameter

88089a4

[CI] Auto-commit changed files from 'make api-docs'

c09e839

nchaulet requested a review from criamico October 31, 2024 14:07

fix tests

371dd47

Merge branch 'main' into feature-remove-deprecated-apis

30560e0

criamico reviewed Oct 31, 2024

View reviewed changes

maxcold approved these changes Oct 31, 2024

View reviewed changes

criamico approved these changes Oct 31, 2024

View reviewed changes

nchaulet and others added 5 commits October 31, 2024 12:29

fix after review

fd65ce0

[CI] Auto-commit changed files from 'make api-docs'

86c884c

fix tests

d821cb0

Merge branch 'main' of github.com:elastic/kibana into feature-remove-…

eef3ee2

…deprecated-apis

Merge branch 'main' into feature-remove-deprecated-apis

579ca1b

nchaulet merged commit 115dbec into elastic:main Nov 1, 2024
55 checks passed

nchaulet deleted the feature-remove-deprecated-apis branch November 1, 2024 12:00

kibanamachine added the v9.0.0 label Nov 1, 2024

nreese pushed a commit to nreese/kibana that referenced this pull request Nov 1, 2024

[Fleet] Remove deprecated APIs for agents endpoints (elastic#198313)

6ac4d92

mrodm mentioned this pull request Nov 20, 2024

Fix deprecated Kibana APIs elastic/elastic-package#2236

Merged

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Fleet] Remove deprecated APIs for agents endpoints #198313

[Fleet] Remove deprecated APIs for agents endpoints #198313

nchaulet commented Oct 30, 2024 •

edited

Loading

elasticmachine commented Oct 30, 2024

nchaulet commented Oct 31, 2024 •

edited

Loading

gergoabraham left a comment

criamico commented Oct 31, 2024

nchaulet commented Oct 31, 2024

criamico Oct 31, 2024

nchaulet Oct 31, 2024

criamico Oct 31, 2024

maxcold left a comment

criamico left a comment

nchaulet commented Oct 31, 2024

elasticmachine commented Nov 1, 2024

API count

ESLint disabled line counts

Total ESLint disabled count

	const allActive = allStatuses - combinedStatuses.unenrolled - combinedStatuses.inactive;
	return {
	...combinedStatuses,
	all: allStatuses,
	active: allActive,
	/* @deprecated no agents will have other status */
	other: 0,
	/* @deprecated Agent events do not exists anymore */
	events: 0,
	/* @deprecated use active instead */
	total: allActive,
	};

[Fleet] Remove deprecated APIs for agents endpoints #198313

[Fleet] Remove deprecated APIs for agents endpoints #198313

Conversation

nchaulet commented Oct 30, 2024 • edited Loading

Summary

Remove API endpoints

Remove deprecated parameters or response

elasticmachine commented Oct 30, 2024

nchaulet commented Oct 31, 2024 • edited Loading

gergoabraham left a comment

Choose a reason for hiding this comment

criamico commented Oct 31, 2024

nchaulet commented Oct 31, 2024

criamico Oct 31, 2024

Choose a reason for hiding this comment

nchaulet Oct 31, 2024

Choose a reason for hiding this comment

criamico Oct 31, 2024

Choose a reason for hiding this comment

maxcold left a comment

Choose a reason for hiding this comment

criamico left a comment

Choose a reason for hiding this comment

nchaulet commented Oct 31, 2024

elasticmachine commented Nov 1, 2024

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

Async chunks

Page load bundle

API count

ESLint disabled line counts

Total ESLint disabled count

History

nchaulet commented Oct 30, 2024 •

edited

Loading

nchaulet commented Oct 31, 2024 •

edited

Loading