feat: add update check, machine-readable output formats, and latency metrics#18
Merged
feat: add update check, machine-readable output formats, and latency metrics#18
Conversation
Overview
Labels (2 changes)
-org.opencontainers.image.created=2026-01-10T12:32:02.121Z
+org.opencontainers.image.created=2026-01-11T11:20:19.894Z
org.opencontainers.image.description=A disk benchmarking tool for Docker
org.opencontainers.image.licenses=Apache-2.0
org.opencontainers.image.revision=
org.opencontainers.image.source=https://github.com/e7db/docker-diskmark
org.opencontainers.image.title=docker-diskmark
org.opencontainers.image.url=https://github.com/e7db/docker-diskmark
-org.opencontainers.image.version=1.1.0
+org.opencontainers.image.version=pr-18 |
e735a56 to
5819860
Compare
Overview
Labels (2 changes)
-org.opencontainers.image.created=2026-01-10T12:32:02.121Z
+org.opencontainers.image.created=2026-01-11T11:47:02.777Z
org.opencontainers.image.description=A disk benchmarking tool for Docker
org.opencontainers.image.licenses=Apache-2.0
org.opencontainers.image.revision=
org.opencontainers.image.source=https://github.com/e7db/docker-diskmark
org.opencontainers.image.title=docker-diskmark
org.opencontainers.image.url=https://github.com/e7db/docker-diskmark
-org.opencontainers.image.version=1.1.0
+org.opencontainers.image.version=pr-18 |
5819860 to
9bc1151
Compare
…metrics - Add UPDATE_CHECK option to notify users of new versions at startup - Add FORMAT option for machine-readable output (json, yaml, xml) - Add latency metrics (avg ms) to benchmark results - Add version injection via Docker build arg - Add GitHub badges for tag, CodeQL, Tests, Docker Image workflows - Improve test workflow with continue-on-error for per-step visibility - Add tests for UPDATE_CHECK and FORMAT validation - Update README with new options and sample outputs
9bc1151 to
d013a4a
Compare
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.
This PR introduces several enhancements to improve user experience, automation capabilities, and benchmark insights.
🆕 New Features
Update Check (
UPDATE_CHECK)UPDATE_CHECK=0|1(default:1)Machine-Readable Output (
FORMAT)FORMATenvironment variable supportsjson,yaml, andxmloutputconfigurationandresultsobjectsLatency Metrics
X.XXmsin human-readable outputlatency_msfield in structured outputsclat_ns.mean(completion latency) for accurate measurementVersion Injection
/etc/diskmark-version🔧 Improvements
CI/CD
continue-on-error: truepattern for per-step failure visibilityUPDATE_CHECKandFORMATvalidationDockerfile
wgetandssl_clientbinaries for HTTPS update checking/distto/diskmarkfor clarity📖 Documentation
UPDATE_CHECKandFORMAToptions📊 Sample Output
Human-readable:
JSON:
{ "configuration": { ... }, "results": [ {"name": "SEQ1MQ8T1", "status": "success", "read": {"bandwidth_mb": 524, "iops": 499, "latency_ms": 2.15}, "write": {"bandwidth_mb": 498, "iops": 475, "latency_ms": 1.89}} ] }✅ Testing
UPDATE_CHECK(valid/invalid values)FORMAT(valid/invalid values)🔄 Breaking Changes
None. All new features are opt-in or backward compatible.