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.

Sign up for GitHub

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

Jump to bottom

Report current heap usage on Merlin response #1717

Merged
merged 4 commits into from
Dec 13, 2023
Merged

Report current heap usage on Merlin response #1717

merged 4 commits into from
Dec 13, 2023

Conversation

abbysmal
Copy link
Contributor

@abbysmal abbysmal commented Dec 5, 2023

This PR is a first step toward completing #1680

It enriches Merlin's responses with a new heap_mbytes field, that contains the total major heap size (in megabytes) after completing the request.

The implementation relies on using the heap_words field from Gc.stat.

This PR should be covering enough ground to satisfy the motivations 1 and 3 of the aforementined issue.
Motivation 2 maybe needs a finer grained solution with better granularity (ie. not only at the end of a request).

Let me know if there any refinement required, or if we need to add other fields, or if this is providing enough data as it is.

voodoos
voodoos approved these changes Dec 11, 2023
View reviewed changes
Copy link
Collaborator

@voodoos voodoos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The changes looks good to me. I guess the call to Gc.quick_stat is quite fast ?

Could you add a changelog entry ? Thank you !

@abbysmal
Copy link
Contributor Author

Done: is it ok?

@voodoos
Copy link
Collaborator

voodoos commented Dec 12, 2023

Done: is it ok?

It won't be after a rebase 🙂, I made a release yesterday so there is a new section to create in the changelog.

@abbysmal abbysmal force-pushed the heap_usage_on_response branch from 815aab5 to ece0ca9 Compare December 12, 2023 16:13
@voodoos
Copy link
Collaborator

voodoos commented Dec 12, 2023

❤️

@voodoos voodoos merged commit d989b6b into ocaml:master Dec 13, 2023
@pitag-ha pitag-ha mentioned this pull request Jan 29, 2024
Closed
3 tasks
voodoos added a commit to voodoos/merlin that referenced this pull request Feb 20, 2024
@voodoos
[B] Report current heap usage on Merlin response (ocaml#1717)
539347e 
from Engil/heap_usage_on_response
voodoos added a commit to voodoos/opam-repository that referenced this pull request Feb 22, 2024
@voodoos
[new release] merlin (3 packages) (4.14-414)
1e53e68 
CHANGES:

Thu Feb 22 14:00:42 CET 2024

  + merlin binary
    - Add a "heap_mbytes" field to Merlin server responses to report heap usage (ocaml/merlin#1717)
    - Add cache stats to telemetry (ocaml/merlin#1711)
    - Add new SyntaxDocument command to find information about the node under the cursor (ocaml/merlin#1706)
    - Fix `FLG -pp ppx.exe -as-pp/-dump-ast` use of invalid shell redirection when
    direct process launch on Windows. (ocaml/merlin#1723, fixes ocaml/merlin#1722)
    - Add a query_num field to the `ocamlmerlin` responses to detect server crashes (ocaml/merlin#1716)
    - Jump to cases within a match statement (ocaml/merlin#1726)
    - Jump to `module-type` (ocaml/merlin#1728, partially fixes ocaml/merlin#1656)
    - Exposes stable functions for configuration handling and pattern variable
      destruction. (ocaml/merlin#1730)
  + editor modes
    - vim: load merlin under the ocamlinterface and ocamllex filetypes (ocaml/merlin#1340)
    - Fix merlinpp not using binary file open (ocaml/merlin#1725, fixes ocaml/merlin#1724)
voodoos added a commit to voodoos/opam-repository that referenced this pull request Feb 22, 2024
@voodoos
[new release] merlin, merlin-lib and dot-merlin-reader (4.14-500)
7905af8 
CHANGES:

Thu Feb 22 14:00:42 CET 2024

  + merlin binary
    - Add a "heap_mbytes" field to Merlin server responses to report heap usage (ocaml/merlin#1717)
    - Add cache stats to telemetry (ocaml/merlin#1711)
    - Add new SyntaxDocument command to find information about the node under the cursor (ocaml/merlin#1706)
    - Fix `FLG -pp ppx.exe -as-pp/-dump-ast` use of invalid shell redirection when
    direct process launch on Windows. (ocaml/merlin#1723, fixes ocaml/merlin#1722)
    - Add a query_num field to the `ocamlmerlin` responses to detect server crashes (ocaml/merlin#1716)
    - Jump to cases within a match statement (ocaml/merlin#1726)
    - Jump to `module-type` (ocaml/merlin#1728, partially fixes ocaml/merlin#1656)
    - Exposes stable functions for configuration handling and pattern variable
      destruction. (ocaml/merlin#1730)
  + editor modes
    - vim: load merlin under the ocamlinterface and ocamllex filetypes (ocaml/merlin#1340)
    - Fix merlinpp not using binary file open (ocaml/merlin#1725, fixes ocaml/merlin#1724)
voodoos added a commit to voodoos/opam-repository that referenced this pull request Feb 22, 2024
@voodoos
[new release] merlin (3 packages) (4.14-501)
613d86e 
CHANGES:

Thu Feb 22 14:00:42 CET 2024

  + merlin binary
    - Add a "heap_mbytes" field to Merlin server responses to report heap usage (ocaml/merlin#1717)
    - Add cache stats to telemetry (ocaml/merlin#1711)
    - Add new SyntaxDocument command to find information about the node under the cursor (ocaml/merlin#1706)
    - Fix `FLG -pp ppx.exe -as-pp/-dump-ast` use of invalid shell redirection when
    direct process launch on Windows. (ocaml/merlin#1723, fixes ocaml/merlin#1722)
    - Add a query_num field to the `ocamlmerlin` responses to detect server crashes (ocaml/merlin#1716)
    - Jump to cases within a match statement (ocaml/merlin#1726)
    - Jump to `module-type` (ocaml/merlin#1728, partially fixes ocaml/merlin#1656)
    - Exposes stable functions for configuration handling and pattern variable
      destruction. (ocaml/merlin#1730)
  + editor modes
    - vim: load merlin under the ocamlinterface and ocamllex filetypes (ocaml/merlin#1340)
    - Fix merlinpp not using binary file open (ocaml/merlin#1725, fixes ocaml/merlin#1724)
voodoos added a commit to voodoos/opam-repository that referenced this pull request Feb 22, 2024
@voodoos
[new release] merlin-lib, merlin (4.14-501/500/414)
6b881a5 
CHANGES:

Thu Feb 22 14:00:42 CET 2024

  + merlin binary
    - Add a "heap_mbytes" field to Merlin server responses to report heap usage (ocaml/merlin#1717)
    - Add cache stats to telemetry (ocaml/merlin#1711)
    - Add new SyntaxDocument command to find information about the node under the cursor (ocaml/merlin#1706)
    - Fix `FLG -pp ppx.exe -as-pp/-dump-ast` use of invalid shell redirection when
    direct process launch on Windows. (ocaml/merlin#1723, fixes ocaml/merlin#1722)
    - Add a query_num field to the `ocamlmerlin` responses to detect server crashes (ocaml/merlin#1716)
    - Jump to cases within a match statement (ocaml/merlin#1726)
    - Jump to `module-type` (ocaml/merlin#1728, partially fixes ocaml/merlin#1656)
    - Exposes stable functions for configuration handling and pattern variable
      destruction. (ocaml/merlin#1730)
  + editor modes
    - vim: load merlin under the ocamlinterface and ocamllex filetypes (ocaml/merlin#1340)
    - Fix merlinpp not using binary file open (ocaml/merlin#1725, fixes ocaml/merlin#1724)
@voodoos voodoos mentioned this pull request Feb 22, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@voodoos voodoos voodoos approved these changes

Assignees
No one assigned
Labels
None yet
Projects
Backport to 501
Status: 4.14-500
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@abbysmal @voodoos