V2 agent diagnostics action #1631

michel-laterman · 2022-10-27T23:47:01Z

What does this PR do?

Add a diagnostics action type and handler to the agent.
The diagnostics action will upload the resulting archive to fleet-server using the new file-upload API (added as a part of the fleetapi module)
Move the archive (zip) assembly from cmd/diagnostics.go into the diagnostics module so that running diagnostics as a command and as an action will produce the same binary.
Changed diagnostics hooks and providers; providers now provide a callback function that can be used to dynamically generate a list of hooks. This was done so that log collection can be provided as hooks when the control server receives the request.
Changed the hook function to return []byte, time.Time so that file mod times can be provided when reading logs.

Why is it important?

In order to make it easier for customers to debug deployments we are adding the ability to gather diagnostics bundles in the fleet UI in Kibana.

Checklist

My code follows the style guidelines of this project
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
I have made corresponding change to the default configuration files
I have added tests that prove my fix is effective or that my feature works
I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

Author's Checklist

[ ]

How to test this PR locally

Related issues

Relates [Fleet] Support new "request diagnostics" action type fleet-server#1883

Use cases

Screenshots

Logs

Add a diagnostics action handler to the agent. This will allow a user to collect a diagnostics bundle from the fleet-ui. Change log collection from being done in the cmd/diagnostics.go file to dynamically generated hooks. Change the control server from accepting a list of hooks to a varadic list of callback functions that return hooks. This is to allow the agent to dynamically generate a hook for each log (and service log file) when the diagnostics action is triggered from an action or the command line. Add a ZipArchive function to the diagnostics package that will write the zip to the passed writer so that the archive can be created by a command line invokation or from an action.

Change the Hook function from returning a []byte to a []byte, time.Time so that the file mod times collected through diagnostics hooks can be returned from the same filesystem interaction. Add the start of a specific retrier for the fleetapi/uploader that will resend requests if a 429 is recieved.

mergify · 2022-10-27T23:47:34Z

This pull request is now in conflicts. Could you fix it? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b v2-agent-diagnostics-action upstream/v2-agent-diagnostics-action
git merge upstream/feature-arch-v2
git push upstream v2-agent-diagnostics-action

michel-laterman · 2022-10-27T23:48:38Z

File upload PR is being worked on here: elastic/fleet-server#1902
The API may change so I will likely need to update this PR to reflect that

cc @pzl

elasticmachine · 2022-10-28T17:08:13Z

💔 Build Failed

the below badges are clickable and redirect to their specific view in the CI or DOCS

Expand to view the summary

Build stats

Start Time: 2022-10-31T17:15:17.680+0000
Duration: 13 min 38 sec

Steps errors

Expand to view the steps failures

`Go build`

Took 1 min 53 sec . View more details here
Description: mage build

`Go build`

Took 1 min 4 sec . View more details here
Description: mage build

`Go build`

Took 1 min 14 sec . View more details here
Description: mage build

`Go build`

Took 1 min 17 sec . View more details here
Description: mage build

❕ Flaky test report

No test was executed to be analysed.

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

/test : Re-trigger the build.
/package : Generate the packages.
run integration tests : Run the Elastic Agent Integration tests.
run end-to-end tests : Generate the packages and run the E2E Tests.
run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

juliaElastic · 2022-11-01T14:51:16Z

@michel-laterman Can we make sure to add the diagnostics file ID to the ActionResult data that is sent back on ack and saved to .fleet-action-results? We need that to query the file that corresponds to the triggering action on Fleet UI.

Something like this would be great:

{ "action_id": "<action_id>", "data": { "file_id": "<file_id>" }, ... }

blakerouse · 2022-11-04T14:23:53Z

internal/pkg/agent/application/actions/handlers/handler_action_diagnostics.go

+			Err:         diag.Err,
+			Results:     files,
+		})
+	}


This whole code block looks to be a duplicate of what is in the control server code. We should place this code in a common place instead of copying it.

mergify · 2022-11-08T03:07:00Z

This pull request is now in conflicts. Could you fix it? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b v2-agent-diagnostics-action upstream/v2-agent-diagnostics-action
git merge upstream/feature-arch-v2
git push upstream v2-agent-diagnostics-action

michel-laterman added 3 commits October 24, 2022 13:18

Add tests

2a281e9

michel-laterman added enhancement New feature or request Team:Elastic-Agent-Control-Plane Label for the Agent Control Plane team labels Oct 27, 2022

mergify bot assigned michel-laterman Oct 27, 2022

Merge branch 'feature-arch-v2' into v2-agent-diagnostics-action

fe206ee

michel-laterman added 2 commits October 28, 2022 13:18

linter fixes

5125724

linter fixes

a50f098

jlind23 linked an issue Nov 3, 2022 that may be closed by this pull request

[Fleet] Support new "request diagnostics" action type elastic/fleet-server#1883

Closed

9 tasks

blakerouse reviewed Nov 4, 2022

View reviewed changes

juliaElastic mentioned this pull request Nov 8, 2022

[Fleet] Request diagnostics elastic/kibana#142369

Merged

2 tasks

blakerouse deleted the branch elastic:feature-arch-v2 November 9, 2022 16:42

blakerouse closed this Nov 9, 2022

michel-laterman mentioned this pull request Nov 9, 2022

Add agent diagnostics action #1703

Merged

6 tasks

michel-laterman deleted the v2-agent-diagnostics-action branch April 12, 2023 19:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

V2 agent diagnostics action #1631

V2 agent diagnostics action #1631

michel-laterman commented Oct 27, 2022 •

edited by juliaElastic

Loading

mergify bot commented Oct 27, 2022

michel-laterman commented Oct 27, 2022

elasticmachine commented Oct 28, 2022 •

edited

Loading

Build stats

`Go build`

`Go build`

`Go build`

`Go build`

juliaElastic commented Nov 1, 2022 •

edited

Loading

blakerouse Nov 4, 2022

mergify bot commented Nov 8, 2022

V2 agent diagnostics action #1631

V2 agent diagnostics action #1631

Conversation

michel-laterman commented Oct 27, 2022 • edited by juliaElastic Loading

What does this PR do?

Why is it important?

Checklist

Author's Checklist

How to test this PR locally

Related issues

Use cases

Screenshots

Logs

mergify bot commented Oct 27, 2022

michel-laterman commented Oct 27, 2022

elasticmachine commented Oct 28, 2022 • edited Loading

💔 Build Failed

Build stats

Steps errors

Go build

Go build

Go build

Go build

❕ Flaky test report

🤖 GitHub comments

juliaElastic commented Nov 1, 2022 • edited Loading

blakerouse Nov 4, 2022

Choose a reason for hiding this comment

mergify bot commented Nov 8, 2022

michel-laterman commented Oct 27, 2022 •

edited by juliaElastic

Loading

elasticmachine commented Oct 28, 2022 •

edited

Loading

`Go build`

`Go build`

`Go build`

`Go build`

juliaElastic commented Nov 1, 2022 •

edited

Loading