Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Diagnostics: rename components-actual.yaml to components-observed.yaml #2419

Open
ycombinator opened this issue Mar 30, 2023 · 5 comments
Open
Labels
enhancement New feature or request Team:Elastic-Agent Label for the Agent team Team:Elastic-Agent-Control-Plane Label for the Agent Control Plane team

Comments

@ycombinator
Copy link
Contributor

Follow up to #2139.

Now that #2139 has been implemented, elastic-agent diagnostics will create an archive containing the following files (only those relevant to this discussion are shown below):

  • components-expected.yaml
  • components-actual.yaml

From my understanding after chatting with @pchila:

  • components-expected.yaml represents the expected state of the components, as is sent by the Agent to it's components via the CheckinExpected message.
  • components-actual.yaml represents the observed state of the components, as is sent by the components to the Agent via the CheckinObserved message.

Assuming my understanding above is correct, then I propose renaming components-actual.yaml to components-observed.yaml so the filenames are consistent with the names of their corresponding protocol messages. This will avoid unnecessary confusion about what exactly compnents-actual.yaml might represent and whether it's the same or slightly different that the observed state of the components, as is sent by the components to the Agent via the CheckinObserved message.

@ycombinator ycombinator added enhancement New feature or request Team:Elastic-Agent Label for the Agent team labels Mar 30, 2023
@ycombinator ycombinator changed the title Rename components-actual.yaml to components-observed.yaml Diagnostics: rename components-actual.yaml to components-observed.yaml Mar 30, 2023
@cmacknz
Copy link
Member

cmacknz commented Mar 30, 2023

I suggested the original name and this change is fine with me. We haven't released this yet so there's no reason to avoid changing it.

@pierrehilbert
Copy link
Contributor

Now it has been released, what is your opinion @cmacknz ?

@cmacknz
Copy link
Member

cmacknz commented Jun 3, 2024

We can still change it, subject to updating documentation.

I don't personally look at these two files often, I'm not sure how much value there is doing the rename now. I'll defer to @ycombinator to close or prioritize as needed.

@pierrehilbert pierrehilbert added the Team:Elastic-Agent-Control-Plane Label for the Agent Control Plane team label Jun 3, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/elastic-agent-control-plane (Team:Elastic-Agent-Control-Plane)

@ycombinator
Copy link
Contributor Author

I think it's worth changing the name (and associated documentation) but the current naming hasn't been problematic so I will deprioritize this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request Team:Elastic-Agent Label for the Agent team Team:Elastic-Agent-Control-Plane Label for the Agent Control Plane team
Projects
None yet
Development

No branches or pull requests

4 participants