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

[8.x](backport #42663) Improve the wmi beats module 42650 #43856

Open
wants to merge 1 commit into
base: 8.x
Choose a base branch
from

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Apr 11, 2025

Proposed commit message

Improve the WMI Module Documentation
Add the domain parameter

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.

Disruptive User Impact

Author's Checklist

How to test this PR locally

Related issues

Use cases

Screenshots

Logs
This is an automatic backport of pull request #42663 done by Mergify.

* Add the Domain parameter. Remove reference to the IP address

* Add the domain to the wmi data

* Improve the documentation of the WMI module

- Add [float] to the internal sections
- Mention all parameters
- Make sure the examples has two queries and one of them uses where and
  namespace
- Show an example of how to convert an WQL query into a YAML
  Configuration

* Update metricbeat/module/windows/wmi/_meta/docs.asciidoc

Co-authored-by: Ishleen Kaur <102962586+ishleenk17@users.noreply.github.com>

* Update metricbeat/module/windows/wmi/_meta/docs.asciidoc

Co-authored-by: Ishleen Kaur <102962586+ishleenk17@users.noreply.github.com>

* Add wmi.namespace and rewrite the Configuration section

* Add section about best-practice and about Arbitrator

* Improve phrasing of the best practices section

* Fix the convertDateTime function and add a test for the dates with timezone

* Refactor replace fields with properties to be compliant with WMI documentation

* Refactor the wmi.include_null and wmi.include_empty_string to a more explicit wmi.include_null_properties and wmi.include_empty_string

* Run make update

* Make the warning more accurate

* Fix typo

* Fix linting error

* fix the example of the documentation + reorder the parameter definition to be the same of the example

* remove reference to fields that should have been removed with the refactoring

* fix typos and make sure the period is 10 minutes in our examples

* Fix the name of the test

* Hide the Remote WMI parameters

* Remove remote wmi logic from wmi.go. This can be reactivated by need

* Get rid of unicode import that was causing issues with the CI/CD pipeline

* Double check the return value of getVariantValue to please CI and avoid panic

* Port documentation from Asciidoc to Markdown

* Using bold instead of title to make the doc fit one page

* Revert "Using bold instead of title to make the doc fit one page"

This reverts commit 7ff2b08.

* Revert "Port documentation from Asciidoc to Markdown"

This reverts commit 926588b.

* Porting Documentation changes into markdown

* Improve markdown documentation

---------

Co-authored-by: Ishleen Kaur <102962586+ishleenk17@users.noreply.github.com>
(cherry picked from commit ab1a0e0)

# Conflicts:
#	docs/reference/metricbeat/metricbeat-metricset-windows-wmi.md
@mergify mergify bot requested a review from a team as a code owner April 11, 2025 09:05
@mergify mergify bot added backport conflicts There is a conflict in the backported pull request labels Apr 11, 2025
@mergify mergify bot requested review from a team as code owners April 11, 2025 09:05
@mergify mergify bot requested review from mauri870 and faec and removed request for a team April 11, 2025 09:05
Copy link
Contributor Author

mergify bot commented Apr 11, 2025

Cherry-pick of ab1a0e0 has failed:

On branch mergify/bp/8.x/pr-42663
Your branch is up to date with 'origin/8.x'.

You are currently cherry-picking commit ab1a0e0d5.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   metricbeat/docs/modules/windows.asciidoc
	modified:   metricbeat/metricbeat.reference.yml
	modified:   metricbeat/module/windows/_meta/config.reference.yml
	modified:   metricbeat/module/windows/_meta/config.yml
	modified:   metricbeat/module/windows/wmi/_meta/data.json
	modified:   metricbeat/module/windows/wmi/_meta/docs.asciidoc
	modified:   metricbeat/module/windows/wmi/config.go
	modified:   metricbeat/module/windows/wmi/config_test.go
	modified:   metricbeat/module/windows/wmi/utils.go
	modified:   metricbeat/module/windows/wmi/utils_test.go
	modified:   metricbeat/module/windows/wmi/wmi.go
	modified:   metricbeat/module/windows/wmi/wmi_test.go
	modified:   metricbeat/modules.d/windows.yml.disabled
	modified:   x-pack/metricbeat/metricbeat.reference.yml

Unmerged paths:
  (use "git add/rm <file>..." as appropriate to mark resolution)
	deleted by us:   docs/reference/metricbeat/metricbeat-metricset-windows-wmi.md

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

@botelastic botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Apr 11, 2025
@github-actions github-actions bot added Team:Elastic-Agent-Data-Plane Label for the Agent Data Plane team Team:Obs-InfraObs Label for the Observability Infrastructure Monitoring team labels Apr 11, 2025
@botelastic botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Apr 11, 2025
@elasticmachine
Copy link
Collaborator

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

@herrBez
Copy link
Contributor

herrBez commented Apr 11, 2025

Hi there, what I am supposed to do? Did mergify fix the issue on its own? I'd like to avoid breaking the 8.x branch :)

@pierrehilbert
Copy link
Collaborator

It looks like everything has been resolved but I would prefer to get a confirmation from @faec or someone else in the team.

@pierrehilbert pierrehilbert requested review from rdner and removed request for mauri870 April 11, 2025 10:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport conflicts There is a conflict in the backported pull request Team:Elastic-Agent-Data-Plane Label for the Agent Data Plane team Team:Obs-InfraObs Label for the Observability Infrastructure Monitoring team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants