Skip to content

docs: update saturation analyzer documentation for v2 collector - #565

Closed
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/update-saturation-analyzer-v2-collector-1767984729-4a04c442e6f1f62f
Closed

docs: update saturation analyzer documentation for v2 collector#565
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/update-saturation-analyzer-v2-collector-1767984729-4a04c442e6f1f62f

Conversation

@github-actions

@github-actions github-actions Bot commented Jan 9, 2026

Copy link
Copy Markdown
Contributor

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.md

Path and Import Updates:

  • ✅ Updated analyzer path: internal/capacity/analyzer.gointernal/saturation/analyzer.go
  • ✅ Updated collector path: internal/collector/capacity_metrics.gointernal/engines/saturation/metrics/replica_metrics.go
  • ✅ Updated interfaces path: internal/interfaces/capacity_analyzer.gointernal/interfaces/saturation_analyzer.go
  • ✅ Fixed import statements to use v2 collector infrastructure:
    • Added collectorv2 "github.com/.../internal/collector/v2"
    • Added saturationmetrics "github.com/.../internal/engines/saturation/metrics"
  • ✅ Updated test path: internal/capacity/analyzer_test.gointernal/saturation/analyzer_test.go

API Name Updates:

  • AnalyzeModelCapacityAnalyzeModelSaturation
  • CalculateCapacityTargetsCalculateSaturationTargets
  • CapacityScalingConfigSaturationScalingConfig
  • ModelCapacityAnalysisModelSaturationAnalysis

Feature Documentation:

  • ✅ Added details about v2 collector features:
    • Uses registered query templates
    • Implements staleness filtering (2-minute default threshold)
    • Filters metrics from terminated pods
  • ✅ Updated code examples to use correct v2 APIs
  • ✅ Fixed ConfigMap name: capacity-scaling-configsaturation-scaling-config
  • ✅ Removed outdated "NOTE: we are currently updating..." header

Terminology Refinement:

  • ✅ Consistently uses "saturation" instead of "capacity" where appropriate
  • ✅ Updated log messages and observability examples
  • ✅ Fixed all cross-references and inline documentation

Related Changes

This documentation update corresponds to code changes in PR #560:

  • Removed collector v1 implementation
  • Migrated to v2 collector infrastructure with source registry
  • Moved analyzer from internal/capacity to internal/saturation

Testing

  • ✅ Verified all file paths exist in the current codebase
  • ✅ Checked that all referenced functions and types match actual implementation
  • ✅ Validated import paths against current package structure
  • ✅ Confirmed code examples compile conceptually with current APIs

Checklist

  • Documentation reflects current code structure
  • All file paths are accurate
  • Import statements use correct v2 collector packages
  • API names match actual function signatures
  • Code examples demonstrate correct usage patterns
  • Terminology is consistent throughout
  • Cross-references are valid

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.

AI generated by Update Docs

- 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
lionelvillard deleted the docs/update-saturation-analyzer-v2-collector-1767984729-4a04c442e6f1f62f branch May 27, 2026 16:47
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