Fix class names in the codebase, cgroup, metrics and Kafka docs - #9156
Merged
Merged
Conversation
The docs name six classes under names the code does not have: - Structure-of-the-codebase.md links org.apache.storm.daemon.DrpcServer, removed in ea44062 (STORM-2217); the DRPC server is org.apache.storm.daemon.drpc.DRPCServer in storm-webapp. - cgroups_in_storm.md calls the CPU metric CGroupCPU; the class is org.apache.storm.metrics2.cgroup.CGroupCpu and it registers CGroupCpu.user-ms and CGroupCpu.sys-ms. - metrics_v2.md names the filter interface StormMetricFilter; it is StormMetricsFilter, as the code block below that sentence shows. - storm-kafka-client.md names TridentState, TridentStateFactory and TridentKafkaUpdater in org.apache.storm.kafka.trident; the classes are TridentKafkaState, TridentKafkaStateFactory and TridentKafkaStateUpdater.
Contributor
|
Thanks for this PR! |
reiabreu
approved these changes
Oct 3, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What is the purpose of the change
A few pages under
docs/use class names the code doesn't have anymore:Structure-of-the-codebase.mdlinksorg.apache.storm.daemon.DrpcServer, which went away back in 2016 (STORM-2217). The DRPC server isorg.apache.storm.daemon.drpc.DRPCServerin storm-webapp now, so the entry and link point there.cgroups_in_storm.mdsaysCGroupCPU, but the class isCGroupCpu, and so are the gauge names (CGroupCpu.user-ms,CGroupCpu.sys-ms).metrics_v2.mdcalls the filter interfaceStormMetricFilter. It'sStormMetricsFilter, like the code block right under it shows.storm-kafka-client.mdlistsTridentStateFactoryandTridentKafkaUpdaterinorg.apache.storm.kafka.trident. That package hasTridentKafkaStateFactoryandTridentKafkaStateUpdaterinstead.TridentStateon the same line is reallyTridentKafkaState, so I fixed that one too.How was the change tested
Docs only, didn't build the site. I checked each new name against the source on master.
Found these with Striff, a tool I'm working on that checks docs against the code (storm's report if you're curious).