Skip to content

refactor: name the actuator endpoint after Storm rather than the SQL log - #522

Merged
zantvoort merged 1 commit into
mainfrom
storm-actuator-endpoint
Aug 22, 2026
Merged

refactor: name the actuator endpoint after Storm rather than the SQL log#522
zantvoort merged 1 commit into
mainfrom
storm-actuator-endpoint

Conversation

@zantvoort

Copy link
Copy Markdown
Collaborator

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

stormsqllog names 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/storm reads like those, where /actuator/stormsqllog reads 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 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 standing next to a first one that only does SQL logging. Splitting later would be the expensive move.

StormSqlLogEndpoint becomes StormEndpoint so 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.md and storm-repository-java.md still told readers to set storm.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 name storm.sql-log.performance.call-sites and the threshold under performance, 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-spring 113 tests pass, spotless clean.

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.
@zantvoort
zantvoort merged commit 14570e2 into main Aug 22, 2026
7 of 9 checks passed
@zantvoort
zantvoort deleted the storm-actuator-endpoint branch August 22, 2026 11:57
@codecov

codecov Bot commented Aug 22, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant