refactor: name the actuator endpoint after Storm rather than the SQL log - #522
Merged
Conversation
An actuator endpoint named stormsqllog describes the one subject it happens to carry today. Boot's own library endpoints are named after the library instead, flyway and liquibase and quartz, and the payload is already sectioned per subject, so claiming storm now costs nothing and lets anything else Storm learns to be told at runtime arrive as another section rather than as a second endpoint next to a first one that only does SQL logging. The class follows: StormEndpoint, not StormSqlLogEndpoint. The two published skills still named the flat key that moved under performance, which is what a reader would have copied into an application. They also now mention the slow statement log, which had no place in them at all.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
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.
Follow-up to #521, on the endpoint's name and on two files that PR missed.
The endpoint is Storm's, not the SQL log's
stormsqllognames the one subject the endpoint happens to carry today. Boot's own library endpoints are named after the library instead —flyway,liquibase,quartz,integrationgraph— and/actuator/stormreads like those, where/actuator/stormsqllogreads like a compound noun nobody remembers.The payload is already sectioned per subject:
{ "slowStatement": { "active": true, "threshold": "PT0.2S", "limit": 5 }, "performance": { "request": { ... }, "entry-point": { ... } } }so claiming
stormnow costs nothing and lets anything else Storm learns to be told at runtime arrive as another section, rather than as a second endpoint standing next to a first one that only does SQL logging. Splitting later would be the expensive move.StormSqlLogEndpointbecomesStormEndpointso the type matches the umbrella rather than naming one section of it. The write parameters are unchanged.Two files #521 missed
website/static/skills/storm-repository-kotlin.mdandstorm-repository-java.mdstill told readers to setstorm.sql-log.call-sites: true, which no longer binds to anything. These are the skills applications vendor, so a stale key there is the one most likely to be copied into a real configuration. Both now namestorm.sql-log.performance.call-sitesand the threshold underperformance, and both gained a sentence on the slow statement log, which they never mentioned at all.The
website/versioned_docs/version-1.13.*copies keep the flat keys deliberately: they document 1.13, where those keys were correct.Verification
storm-spring113 tests pass, spotless clean.