-
Notifications
You must be signed in to change notification settings - Fork 12
feat: add backend caching for AMT API endpoints #768
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
nmgaston
wants to merge
16
commits into
device-management-toolkit:main
Choose a base branch
from
nmgaston:backendCaching
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
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
f0b4549 to
4a97c60
Compare
- Add thread-safe cache implementation with TTL support - Cache power state (5s TTL) with invalidation on power actions - Cache features and KVM displays (30s TTL) - Reduces backend API calls by ~67% for typical usage - Improves response times by 15-53x for repeated requests
Add GET /api/v1/admin/kvm/init/{guid} endpoint that combines:
- Display settings (GetKVMScreenSettings)
- Power state (GetPowerState)
- Redirection status (hardcoded for now)
- AMT features (GetFeatures)
This reduces 4 separate API calls during KVM initialization to just 1,
significantly improving page load time and reducing network latency.
Changes:
- Add KVMInitResponse DTO that combines all required data
- Add GetKVMInitData usecase method with caching (30s TTL)
- Add cache key for KVM init data
- Register endpoint in both v1 and OpenAPI routers
- Add HTTP handler for the new endpoint
Add monitoring stack with: - Prometheus for metrics collection from /metrics endpoint - Grafana for visualization and dashboards - Persistent volumes for both services
- Add GetKVMInitData method to ws/v1 Feature interface - Add SetLinkPreference method to ws/v1 Feature interface - Regenerate all mock files with updated interface signatures - Update gomock import paths from github.com/golang/mock to go.uber.org/mock
- Generate prometheus.yml dynamically in GitHub Actions workflow - Fixes CI error where prometheus.yml mount fails - Keep prometheus.yml in .gitignore for local development
- Specify vault, postgres, app services explicitly in docker compose up - Removes need for prometheus.yml in CI environment - Keeps all prometheus-related config out of repository
- Remove prometheus and grafana services from docker-compose.yml - Remove prometheus-data and grafana-data volumes - Revert api-test.yml to original since services are removed - Keeps monitoring configuration separate from main compose file
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
Adds backend caching for AMT API endpoints to dramatically reduce latency and backend load for repeated requests within short time windows.
Problem
When users interact with the KVM interface or monitor device status, the frontend makes repeated API calls to fetch power state, features, and KVM display settings. Each call requires a round-trip to the AMT firmware, adding 150-500ms latency per request.
Solution
Implements a thread-safe in-memory cache with TTL-based expiration:
Performance Impact
Testing with realistic human interaction patterns (5-10 second intervals):
Implementation Details
sync.RWMutexfor concurrent accessTesting