HYBIM-898 Update migration tool README

[ridhima-splunk]

Updated migration guide with domain entity renames (Metrics → Evaluators, Log Streams → Agent Streams)

• Added §3.3 Metric / Evaluator class rename table: GalileoMetric → SplunkAOEvaluator, GalileoMetrics → SplunkAOEvaluators, and lower-level renames

Metric → Evaluator, LlmMetric → LlmEvaluator, LocalMetric → LocalEvaluator, CodeMetric →     
 CodeEvaluator, BuiltInMetrics → BuiltInEvaluators, MetricSpec → EvaluatorSpec, LocalMetricConfig → LocalEvaluatorConfig

with import diff examples

• Added §3.3a Log Stream / Agent Stream rename table: LogStream → AgentStream, LogStreams → AgentStreams, method renames on AgentStream (get_metrics(), enable_metrics()) and Project (create_log_stream(), list_log_streams(), .logstreams), with import and usage diff examples
• Updated §2.2 sub-module imports: galileo.metric → splunk_ao.evaluator
• Updated checklist with all new rename items

Note:

• §5.3 on-disk config path (~/.galileo/ → ~/.splunk/) will be addressed in PR#221

[github-actions]

All contributors have signed the CLA ✍️ ✅
_{Posted by the CLA Assistant Lite bot.}

[ridhima-splunk]

I have read the CLA Document and I hereby sign the CLA

[ridhima-splunk]

recheck

[fercor-cisco]

🤖 This review was generated by the Astra agent (claude-opus-5). It may contain mistakes.

Verdict: request_changes — Four of the newly added rename rows do not match the shipped SDK (MetricSpec/LocalMetricConfig were never renamed; AgentStream.get_metrics()/enable_metrics() are misattributed), so users following the guide will hit ImportError/AttributeError.

General Comments

• 🟠 major (documentation): The rename tables added here were not cross-checked against the shipped API, and four rows are factually wrong (MetricSpec → EvaluatorSpec, LocalMetricConfig → LocalEvaluatorConfig, AgentStream.get_metrics() → get_evaluators(), AgentStream.enable_metrics() → enable_evaluators()). EvaluatorSpec and LocalEvaluatorConfig do not exist anywhere in the repo, and splunk_ao.AgentStream (from src/splunk_ao/agent_stream.py, the class exported in __init__.py) still has get_metrics()/set_metrics() and has neither get_evaluators() nor enable_evaluators(). A migration guide is executable-by-hand instructions; a wrong row costs a user a debugging session.

This repo already carries the authoritative record of the HYBIM-730 rename in docs/domain-entity-rename.md, including a "Quick find-and-replace reference" that states exactly:

Metric → Evaluator      (OO class, not schema model)
log_stream.enable_metrics(…)  →  agent_stream.set_metrics(…)
enable_metrics(…)             →  enable_evaluators(…)   (AgentStreams service / module-level only)
get_metrics(…)                →  get_evaluators(…)

and explicitly notes splunk_ao.schema.metrics.Metric is not renamed. Please rebuild §3.3/§3.3a and the checklist from that document plus src/splunk_ao/__init__.py, and verify each "New" symbol is actually importable before merge.

Follow-ups

Suggested follow-up work that could be tracked as Jira tickets:

• splunk-ao-migration-tool/README.md:1-1: Nothing verifies this guide against the SDK, which is how the incorrect rename rows got in. Consider a small test (e.g. tests/test_migration_guide.py) that parses the "New" column of the rename tables in splunk-ao-migration-tool/README.md and asserts each symbol is importable from splunk_ao or the stated submodule via importlib/getattr. That turns future rename drift into a CI failure instead of a user-facing bug report.
• src/splunk_ao/agent_stream.py:409-496: Terminology inconsistency in the SDK itself (pre-existing, not introduced by this PR): after the Metrics → Evaluators rename, the public AgentStream still exposes get_metrics()/set_metrics(), while the sibling AgentStream class in agent_streams.py:23 exposes enable_evaluators(). Two same-named classes with different evaluator APIs is what made this guide easy to get wrong. Consider adding get_evaluators()/set_evaluators() as the canonical names on the public class (keeping the old ones as aliases for compatibility), and/or renaming the internal agent_streams.AgentStream response wrapper to something distinct.
• src/splunk_ao/agent_stream.py:484-490: The set_metrics() docstring example uses Evaluator.metrics.correctness. The HYBIM-730 commit message claimed Evaluator.evaluators as the canonical accessor, but evaluator.py:145 only defines metrics = BuiltInEvaluators(). Worth confirming which accessor is intended as public and aligning the docstrings (and docs/domain-entity-rename.md, which documents Evaluator.metrics) so the published API reference is unambiguous.

[ridhima-splunk]

@fercor-cisco jira for follow-ups: https://splunk.atlassian.net/browse/HYBIM-994