Skip to content

Add counter for total loaded classes #3561

Closed

Description

@lenin-jaganathan

Describe the bug
Currently, the JVM class unloading metric is being registered as a Function counter. The description says "The total number of classes unloaded since the Java virtual machine has started execution" which will not be true when this metric is used in a Step Meter Registry.

Environment

  • Micrometer version - Any version
  • Micrometer registry - Any Step Registry can be used
  • OS: Any
  • Java version: Any

To Reproduce
How to reproduce the bug:
Start the java application with the micrometer JVM binder enabled. Use any step registry to register these metrics. After one step is completed, the unloaded class becomes zero.

Expected behavior
jvm.classes.unloaded - should represent the total number of classes unloaded since the Java virtual machine has started execution

Activity

  1. lenin-jaganathan commented on Dec 9, 2022

    @lenin-jaganathan
    ContributorAuthor

    I am not sure such behavior was created. But ideally, using the below snippet for class unloading will help solve this issue.

    I see that jvm.classes.loaded metric is the number of classes that are loaded currently and this being a gauge makes sense.

    jvm.classes.unloaded - is the total number of classes unloaded since the JVM has started, so this should not be a gauge but rather a counter.

    Will it be informational to also expose "the total number of classes loaded" by the JVM?

  2. patpatpat123 commented on Dec 22, 2023

    @patpatpat123

    Upvoting this

  3. marcingrzejszczak commented on Dec 27, 2023

    @marcingrzejszczak
    Contributor

    Some questions:

    • jvm.classes.loaded is a gauge
    • jvm.classes.unloaded is a counter not a gauge, right?

    So is this issue about adding the "the total number of classes loaded" ? Are you upvoting this @patpatpat123 ?

  4. patpatpat123 commented on Dec 30, 2023

    @patpatpat123

    Hello @marcingrzejszczak ,

    Thank you for your input.

    First of all, you are correct about the two metrics:

    jvm_classes_loaded	        metric_type=gauge	        statistic=value
    jvm_classes_unloaded	metric_type=counter	statistic=count
    
    

    And yes, it would be great to have metrics unifying those, to allow building visuals such as a loaded vs. unloaded counter.

  5. github-actions commented on Jan 7, 2024

    @github-actions

    If you would like us to look at this issue, please provide the requested information. If the information is not provided within the next 7 days this issue will be closed.

  6. lenin-jaganathan commented on Jan 8, 2024

    @lenin-jaganathan
    ContributorAuthor

    I am voting for the below 2 things,

    • Update the description of jvm.classes.unloaded to make the statement valid for Step registries. Currently, it says "classes loaded from JVM start" but this will not be true for a StepRegistry.
    • Add a metric to report total classes loaded from ClassLoadingMXBean#getTotalLoadedClassCount. Ideally, this metric should be named "jvm.classes.loaded" but we already have a metric with the same name. We need to sort that out.
  7. marcingrzejszczak commented on Jan 10, 2024

    @marcingrzejszczak
    Contributor

    Thanks for the update. Are you willing to file a PR for this @lenin-jaganathan ?

  8. lenin-jaganathan commented on Jan 12, 2024

    @lenin-jaganathan
    ContributorAuthor

    I think there is an open question on how we handle the names,

    • jvm.classes.unloaded - is a sorted thing.
      The opposite of this metric would be jvm.classes.loaded using info from ClassLoadingMXBean#getTotalLoadedClassCount but that name is already taken.

    Today, we already have a metric named jvm.classes.loaded which reports the number of classes loaded currently. Ideally, this should have been jvm.classes.count or jvm.classes.current.count. I am not sure how will be able to handle this change. This will be a breaking change but in metric space emitting a metric with the same name but representing different info would be very dangerous.

    Also see what OTEL does in this space.

  9. marcingrzejszczak commented on Jan 12, 2024

    @marcingrzejszczak
    Contributor

    We could do sth like this

    • jvm.classes.unloaded for a counter of total unloaded classes
    • jvm.classes.loaded would be the number of classes currently loaded
    • jvm.classes.loaded.count could be the counter of total loaded classes

    Now if someone wants to be OTel compliant they can create a MeterFilter and rename the metrics. If we decide one day that we want to migrate that will also mean that we would have to provide such a MeterFilter and give users a couple of minor versions to migrate to it and then change the names in core and deprecate the MeterFilter.

    WDYT @shakuzen @jonatan-ivanov ?

  10. 24 remaining items

  11. modified the milestones: 1.16.0-M1, , , 1.16.0-M2 on Jul 14, 2025
  12. modified the milestones: 1.16.x, 1.16.0-M3 on Sep 9, 2025
  13. shakuzen commented on Sep 9, 2025

    @shakuzen
    Member

    This has been resolved by #6682 (comment)

  14. patpatpat123 commented on Sep 9, 2025

    @patpatpat123

    Many thanks for all of you.

    To test this, I need to wait for this to be released right?

    Image
  15. shakuzen commented on Sep 9, 2025

    @shakuzen
    Member

    After it is merged, snapshots are published for each commit, but the M3 release was made shortly after the mentioned PR was merged, so the milestone is already available.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementA general enhancementinstrumentationAn issue that is related to instrumenting a componentmodule: micrometer-coreAn issue that is related to our core module

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions