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

Update documentation for system.process.memory fields to include clarification on Windows memory terminology #17268

Merged
merged 4 commits into from
Mar 27, 2020

Conversation

narph
Copy link
Contributor

@narph narph commented Mar 26, 2020

What does this PR do?

Updates the description of the system/process memory fields.

Why is it important?

Related to #8345
Windows users are confused about the values reflected in the system.process.memory.rss.bytes and system.process.memory.size since the description and naming are not clear enough on the type of memory used/allocated etc.

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.

Related issues

@narph narph self-assigned this Mar 26, 2020
@narph narph added the Team:Integrations Label for the Integrations team label Mar 26, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/integrations (Team:Integrations)

@narph narph changed the title Update documentation for cpu.process.memory fields to include clarification on Windows os's Update documentation for system.process.memory fields to include clarification on Windows os's Mar 26, 2020
@blakerouse
Copy link
Contributor

Maybe it would be better detailed description to add this for each supported OS? This way makes it seem like information for Linux or Mac is just missing.

Maybe just on On Windows, this because On Windows os's seems weird as Windows is generally used to represent all versions of Windows as an overall type.

@narph
Copy link
Contributor Author

narph commented Mar 26, 2020

@blakerouse ,

Maybe it would be better detailed description to add this for each supported OS? This way makes it seem like information for Linux or Mac is just missing.

I think users will read it as .. This is what this metric represents but on Windows it means the following... So not missing information but an added clarification on the Windows side.

Maybe just on On Windows, this because On Windows os's seems weird as Windows is generally used to represent all versions of Windows as an overall type.

Agree.

@narph narph changed the title Update documentation for system.process.memory fields to include clarification on Windows os's Update documentation for system.process.memory fields to include clarification on Windows memory terminology Mar 26, 2020
@narph narph added the needs_backport PR is waiting to be backported to other branches. label Mar 27, 2020
@narph narph merged commit 66f23dc into elastic:master Mar 27, 2020
@narph narph deleted the win-memory branch March 27, 2020 12:28
narph added a commit to narph/beats that referenced this pull request Mar 27, 2020
…ification on Windows memory terminology (elastic#17268)

* update field description

* update changelog

* fix naming

* update

(cherry picked from commit 66f23dc)
@narph narph added the v7.7.0 label Mar 27, 2020
narph added a commit to narph/beats that referenced this pull request Mar 27, 2020
…ification on Windows memory terminology (elastic#17268)

* update field description

* update changelog

* fix naming

* update

(cherry picked from commit 66f23dc)
narph added a commit that referenced this pull request Mar 27, 2020
…ification on Windows memory terminology (#17268) (#17287)

* update field description

* update changelog

* fix naming

* update

(cherry picked from commit 66f23dc)
narph added a commit that referenced this pull request Mar 27, 2020
…mory fields to include clarification on Windows memory terminology (#17288)

* Update documentation for system.process.memory fields to include clarification on Windows memory terminology (#17268)

* update field description

* update changelog

* fix naming

* update

(cherry picked from commit 66f23dc)

* fix changelog
leweafan pushed a commit to leweafan/beats that referenced this pull request Apr 28, 2023
…cess.memory fields to include clarification on Windows memory terminology (elastic#17288)

* Update documentation for system.process.memory fields to include clarification on Windows memory terminology (elastic#17268)

* update field description

* update changelog

* fix naming

* update

(cherry picked from commit 2c68ca4)

* fix changelog
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Metricbeat Metricbeat needs_backport PR is waiting to be backported to other branches. Team:Integrations Label for the Integrations team v7.7.0 :Windows
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants