Add complete flag environment variable to agent metadata by emilioalvap · Pull Request #3190 · elastic/elastic-agent

emilioalvap · 2023-08-04T09:22:12Z

What does this PR do?

Closes elastic/fleet-server#1754. Add environment variable to agent complete image and add it to agent metada.

Why is it important?

We need a mechanism to detect if the agent enrolled is a -complete image in Synthetics to show early warnings which the spec does not provide.

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/fragments using the changelog tool
I have added an integration test or an E2E test

How to test this PR locally

Build agent docker images locally.
Enroll both an elastic-agent and elastic-agent-complete containers on a policy.
Check both agents metadata for complete flag:

//complete
 "local_metadata": {
    "elastic": {
        ...,
        "complete": true,
      }
    },
}
//vs non-complete
 "local_metadata": {
    "elastic": {
      "agent": {
        ...,
        "complete": false,
      }
    },
}

mergify · 2023-08-04T09:23:17Z

This pull request does not have a backport label. Could you fix it @emilioalvap? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

backport-v./d./d./d is the label to automatically backport to the 8./d branch. /d is the digit

NOTE: backport-skip has been added to this pull request.

elasticmachine · 2023-08-04T09:33:46Z

💚 Build Succeeded

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: 2023-08-08T14:17:44.694+0000
Duration: 63 min 42 sec

Test stats 🧪

Test	Results
Failed	0
Passed	6209
Skipped	31
Total	6240

💚 Flaky test report

Tests succeeded.

🤖 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!)

mergify · 2023-08-04T13:12:23Z

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 agent-complete-local-metadata upstream/agent-complete-local-metadata
git merge upstream/main
git push upstream agent-complete-local-metadata

elasticmachine · 2023-08-04T13:20:59Z

🌐 Coverage report

Name	Metrics % (`covered/total`)	Diff
Packages	98.734% (`78/79`)	👍
Files	66.549% (`189/284`)	👍
Classes	65.399% (`344/526`)	👍
Methods	52.233% (`1076/2060`)	👎 -0.025
Lines	38.346% (`12321/32131`)	👎 -0.005
Conditionals	100.0% (`0/0`)	💚

emilioalvap · 2023-08-04T13:25:23Z

/test

emilioalvap · 2023-08-04T15:40:34Z

/test

blakerouse · 2023-08-07T20:05:29Z

changelog/fragments/1691141314-complete-image-metadata.yaml

+kind: enhancement
+
+# Change summary; a 80ish characters long description of the change.
+summary: Add complete image to agent metadata.


When a customer reads the changelog what does this mean to them? Maybe some more information on why this is done would be better.

blakerouse · 2023-08-07T20:06:57Z

internal/pkg/release/version.go

+}
+
 // VersionInfo is structure used by `version --yaml`.
 type VersionInfo struct {


Should this information be added to the VersionInfo? That is the information that is exposed from the elastic-agent version command line. Is that information important to know there? Being that we want to let fleet know seems like its important. That information would then be provided in diagnostics.

I don't think it would make sense to include it from the synthetics pov. For us, this is telling us that a given agent is running inside Docker with synthetics deps bundled. For us having ELASTIC_AGENT_COMPLETE: "true" on the diagnostics file is a direct correlation so no need to display it on the version. But I can add it if you think it'll add value

I agree that it is only for synthetics and inside of a container. How will the information that its a complete image get into the diagnostics zip archive?

Diagnostics includes the agent environment:

env: BEAT_SETUID_AS: elastic-agent ELASTIC_AGENT_COMPLETE: "true"

Okay, sounds good.

blakerouse

Please update the changelog before merging, otherwise looks good!

Add complete flag encironment variable to agent metadata

c97cdae

emilioalvap added enhancement New feature or request Team:Uptime Label for the Uptime team labels Aug 4, 2023

emilioalvap requested a review from cmacknz August 4, 2023 09:22

emilioalvap requested a review from a team as a code owner August 4, 2023 09:22

emilioalvap requested a review from michalpristas August 4, 2023 09:22

mergify bot assigned emilioalvap Aug 4, 2023

mergify bot added the backport-skip label Aug 4, 2023

Add changelog

f8ff28d

Fix fleet unit test

cbbdd56

Manual merge

cff5540

cmacknz requested a review from blakerouse August 4, 2023 20:18

blakerouse reviewed Aug 7, 2023

View reviewed changes

blakerouse approved these changes Aug 8, 2023

View reviewed changes

Fix fragment

7dda7a2

emilioalvap enabled auto-merge (squash) August 8, 2023 14:31

emilioalvap disabled auto-merge August 8, 2023 15:52

emilioalvap merged commit bf0a4da into elastic:main Aug 8, 2023

pkoutsovasilis mentioned this pull request May 2, 2025

Add complete attribute to .fleet-agents docs elastic/elasticsearch#127651

Merged

Conversation

emilioalvap commented Aug 4, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Why is it important?

Checklist

How to test this PR locally

Uh oh!

mergify bot commented Aug 4, 2023

Uh oh!

elasticmachine commented Aug 4, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

💚 Build Succeeded

Build stats

Test stats 🧪

💚 Flaky test report

🤖 GitHub comments

Uh oh!

mergify bot commented Aug 4, 2023

Uh oh!

elasticmachine commented Aug 4, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🌐 Coverage report

Uh oh!

emilioalvap commented Aug 4, 2023

Uh oh!

emilioalvap commented Aug 4, 2023

Uh oh!

blakerouse Aug 7, 2023

Choose a reason for hiding this comment

Uh oh!

blakerouse Aug 7, 2023

Choose a reason for hiding this comment

Uh oh!

emilioalvap Aug 8, 2023

Choose a reason for hiding this comment

Uh oh!

blakerouse Aug 8, 2023

Choose a reason for hiding this comment

Uh oh!

emilioalvap Aug 8, 2023

Choose a reason for hiding this comment

Uh oh!

blakerouse Aug 8, 2023

Choose a reason for hiding this comment

Uh oh!

blakerouse left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

emilioalvap commented Aug 4, 2023 •

edited

Loading

elasticmachine commented Aug 4, 2023 •

edited

Loading

elasticmachine commented Aug 4, 2023 •

edited

Loading