feat: add comprehensive cache statistics functionality for upstream zones #16
Conversation
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
…ones - Create new cache_stats module with VtsCacheStats and CacheStatsManager - Support all nginx cache statuses (HIT, MISS, BYPASS, EXPIRED, STALE, UPDATING, REVALIDATED, SCARCE) - Add cache size tracking with max/used size and utilization percentage - Implement Prometheus metrics formatting for cache statistics: - nginx_vts_cache_requests_total: cache requests by status - nginx_vts_cache_size_bytes: cache size statistics - nginx_vts_cache_hit_ratio: cache hit ratio percentage - Integrate cache metrics into VTS status output - Add comprehensive test coverage with 6 new cache-specific tests - All 48 tests pass with full clippy compliance and proper formatting Based on nginx-module-vts cache implementation patterns for compatibility. Enables cache monitoring for upstream zones as requested. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive cache statistics functionality to the nginx-vts-rust module, enabling monitoring of cache performance and resource utilization across different cache zones.
- Implements cache status tracking for all 8 nginx cache states (HIT, MISS, BYPASS, EXPIRED, STALE, UPDATING, REVALIDATED, SCARCE)
- Adds cache size monitoring with utilization percentage calculation
- Integrates cache metrics into Prometheus output with proper labeling and formatting
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/cache_stats.rs | Implements core cache statistics data structures and management |
| src/lib.rs | Adds cache manager integration and public API functions |
| src/prometheus.rs | Extends Prometheus formatter with cache metrics support |
| test_cache_stats.rs | Provides comprehensive test coverage for cache functionality |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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.
Summary
Features
Metrics Added
nginx_vts_cache_requests_total{zone, status}: Cache requests by statusnginx_vts_cache_size_bytes{zone, type}: Cache size statistics (max/used)nginx_vts_cache_hit_ratio{zone}: Cache hit ratio percentageTest Plan
Based on nginx-module-vts implementation patterns for upstream compatibility.
Addresses the requirement for cache status functionality in upstream zones.
🤖 Generated with Claude Code