docs: update saturation analyzer documentation for v2 collector - #565
Closed
github-actions[bot] wants to merge 1 commit into
Closed
Conversation
- Update file paths from internal/capacity to internal/saturation - Update collector references to use v2 infrastructure - Fix import paths to use internal/engines/saturation/metrics - Update API names: AnalyzeModelCapacity -> AnalyzeModelSaturation - Update API names: CalculateCapacityTargets -> CalculateSaturationTargets - Add details about v2 collector features (staleness filtering, query templates) - Update test paths to internal/saturation/analyzer_test.go - Fix terminology throughout (capacity -> saturation where appropriate) - Remove outdated note about 0.4.0 alignment Related to PR #560 (cleanup: remove collector v1)
lionelvillard
deleted the
docs/update-saturation-analyzer-v2-collector-1767984729-4a04c442e6f1f62f
branch
May 27, 2026 16:47
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.
Summary
Updates the saturation analyzer documentation to reflect the v2 collector infrastructure migration that was completed in PR #560.
Changes Made
File:
docs/saturation-analyzer.mdPath and Import Updates:
internal/capacity/analyzer.go→internal/saturation/analyzer.gointernal/collector/capacity_metrics.go→internal/engines/saturation/metrics/replica_metrics.gointernal/interfaces/capacity_analyzer.go→internal/interfaces/saturation_analyzer.gocollectorv2 "github.com/.../internal/collector/v2"saturationmetrics "github.com/.../internal/engines/saturation/metrics"internal/capacity/analyzer_test.go→internal/saturation/analyzer_test.goAPI Name Updates:
AnalyzeModelCapacity→AnalyzeModelSaturationCalculateCapacityTargets→CalculateSaturationTargetsCapacityScalingConfig→SaturationScalingConfigModelCapacityAnalysis→ModelSaturationAnalysisFeature Documentation:
capacity-scaling-config→saturation-scaling-configTerminology Refinement:
Related Changes
This documentation update corresponds to code changes in PR #560:
internal/capacitytointernal/saturationTesting
Checklist
Impact
Users: This documentation update helps developers understand the current v2 collector architecture and provides accurate examples for using the saturation analyzer.
Breaking Changes: None - this is a documentation-only change that brings docs in sync with code.
Documentation Quality: Treats documentation gaps like failing tests - this PR fixes the "red build" created by the v2 collector migration.