Skip to content

Add os_family, os_platform and os_version to host provider#5941

Merged
belimawr merged 8 commits intoelastic:mainfrom
belimawr:10797-journald-for-system-integration
Nov 12, 2024
Merged

Add os_family, os_platform and os_version to host provider#5941
belimawr merged 8 commits intoelastic:mainfrom
belimawr:10797-journald-for-system-integration

Conversation

@belimawr
Copy link
Copy Markdown
Contributor

@belimawr belimawr commented Nov 5, 2024 •
edited
Loading

What does this PR do?

This commit adds os_family, os_platform and os_version to the host provider, enabling differentiating Linux distributions. This is required to support Debian 12 and other distributions that are moving away from traditional log files in favour of Journald.

Why is it important?

It is required to support Debian 12 and other Linux distributions that are moving away from traditional log files in favour of Journald.

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

Disruptive User Impact

None

How to test this PR locally

  1. Package the Elastic-Agent
  2. Deploy it with any policy, even an empty policy with no monitoring will work
  3. Collect the diagnostics
  4. Look at variables.yml and ensure os_family, os_platform and os_version are populated under host. Here is an example from Debian 11:
      host:
        architecture: x86_64
        id: 9a7aa218396d47b1b17218a99918bae4
        ip:
            - 127.0.0.1/8
            - 10.0.2.15/24
            - ::1/128
            - fe80::a00:27ff:fe8d:c04d/64
        mac:
            - 08:00:27:8d:c0:4d
        name: bullseye
        os_family: debian
        os_platform: debian
        os_version: 11 (bullseye)
        platform: linux

Related issues

Questions to ask yourself

  • How are we going to support this in production?
  • How are we going to measure its adoption?
  • How are we going to debug this?
  • What are the metrics I should take care of?
  • ...

@belimawr belimawr added Team:Elastic-Agent-Data-Plane Label for the Agent Data Plane team skip-it Skips integration tests for a PR skip-ci labels Nov 5, 2024
@belimawr belimawr self-assigned this Nov 5, 2024
@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Nov 5, 2024

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

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

@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Nov 5, 2024

backport-v8.x has been added to help with the transition to the new branch 8.x.
If you don't need it please use backport-skip label and remove the backport-8.x label.

@mergify mergify bot added the backport-8.x Automated backport to the 8.x branch with mergify label Nov 5, 2024
This was referenced Nov 5, 2024
Closed
Merged
@belimawr belimawr force-pushed the 10797-journald-for-system-integration branch from 5daf94a to 7eb75c7 Compare November 6, 2024 21:36
@belimawr belimawr removed skip-it Skips integration tests for a PR skip-ci labels Nov 6, 2024
@belimawr belimawr changed the title [WIP] Add os_version and os_family to host provider Add os_family, os_platform and os_version to host provider Nov 6, 2024
@belimawr belimawr marked this pull request as ready for review November 6, 2024 21:47
@belimawr belimawr requested a review from a team as a code owner November 6, 2024 21:47
@elasticmachine
Copy link
Copy Markdown
Contributor

elasticmachine commented Nov 6, 2024

Pinging @elastic/elastic-agent-data-plane (Team:Elastic-Agent-Data-Plane)

@pkoutsovasilis
Copy link
Copy Markdown
Contributor

pkoutsovasilis commented Nov 7, 2024

@belimawr could you add a changelog fragment? 🙂

mauri870
mauri870 reviewed Nov 7, 2024
View reviewed changes
mauri870
mauri870 reviewed Nov 7, 2024
View reviewed changes
@belimawr @mauri870
Update internal/pkg/composable/providers/host/host_test.go
3a441e2 
Co-authored-by: Mauri de Souza Meneguzzo <mauri870@gmail.com>
AndersonQ
AndersonQ reviewed Nov 7, 2024
View reviewed changes
@belimawr
Merge branch '10797-journald-for-system-integration' of github.com:be…
91dc1b8 
…limawr/elastic-agent into 10797-journald-for-system-integration
@belimawr
Copy link
Copy Markdown
Contributor Author

belimawr commented Nov 7, 2024

@belimawr could you add a changelog fragment? 🙂

Done on 2a789ba

@strawgate
Copy link
Copy Markdown
Contributor

strawgate commented Nov 7, 2024 •
edited
Loading

Per ECS -- https://www.elastic.co/guide/en/ecs/current/ecs-os.html these should be os.family, os.platform, os.version? i.e. os should be an object?

@belimawr
Copy link
Copy Markdown
Contributor Author

belimawr commented Nov 8, 2024

Per ECS -- https://www.elastic.co/guide/en/ecs/current/ecs-os.html these should be os.family, os.platform, os.version? i.e. os should be an object?

That makes sense, thanks @strawgate ! It didn't cross my mind to use ECS because those fields are not stored in ES, they're just information about the host.

I'll make those updates.

@strawgate
Copy link
Copy Markdown
Contributor

strawgate commented Nov 8, 2024

Oh, if these don't end up in metadata for documents then you're right it doesnt need to be ecs

@elastic-sonarqube
Copy link
Copy Markdown

elastic-sonarqube bot commented Nov 8, 2024

Quality Gate passed Quality Gate passed

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube

@belimawr belimawr merged commit d9587c4 into elastic:main Nov 12, 2024
mergify bot pushed a commit that referenced this pull request Nov 12, 2024
@belimawr @mauri870 @mergify
Add os_family, os_platform and os_version to host provider (#5941)
5c83802 
This commit adds `os_family`, `os_platform` and `os_version` to the host provider, enabling differentiating Linux distributions. This is required to support Debian 12 and other distributions that are moving away from traditional log files in favour of Journald.

---------

Co-authored-by: Mauri de Souza Meneguzzo <mauri870@gmail.com>
(cherry picked from commit d9587c4)
@mergify mergify bot mentioned this pull request Nov 12, 2024
Merged
4 tasks
belimawr added a commit that referenced this pull request Nov 18, 2024
@mergify @belimawr
Add os_family, os_platform and os_version to host provider (#5941…
1cd7ab4 
…) (#6005)

This commit adds `os_family`, `os_platform` and `os_version` to the host provider, enabling differentiating Linux distributions. This is required to support Debian 12 and other distributions that are moving away from traditional log files in favour of Journald.

---------

Co-authored-by: Mauri de Souza Meneguzzo <mauri870@gmail.com>
(cherry picked from commit d9587c4)

Co-authored-by: Tiago Queiroz <tiago.queiroz@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@AndersonQ AndersonQ AndersonQ left review comments

@mauri870 mauri870 mauri870 approved these changes

@swiatekm swiatekm swiatekm approved these changes

@pkoutsovasilis pkoutsovasilis Awaiting requested review from pkoutsovasilis pkoutsovasilis is a code owner automatically assigned from elastic/elastic-agent-control-plane

Assignees

@belimawr belimawr

Labels

backport-8.x Automated backport to the 8.x branch with mergify Team:Elastic-Agent-Data-Plane Label for the Agent Data Plane team

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@belimawr @elasticmachine @pkoutsovasilis @strawgate @AndersonQ @mauri870 @swiatekm