docs(HYBIM-840): add galileo → splunk-ao migration guide#71
Open
adityamehra wants to merge 1 commit into
Open
Conversation
Adds docs/MIGRATION_GUIDE.md covering all breaking changes customers must make when migrating from the Galileo Python SDK to splunk-ao: - Package install: not yet on PyPI — GitHub install (Option A) and local editable clone (Option B) documented - Python floor bump: 3.10 → 3.11 - Import path rename: galileo → splunk_ao - Class/symbol renames (10 public symbols: GalileoLogger, GalileoDecorator, galileo_context, exception classes, metric classes, handler/middleware classes, ADK classes) - Satellite package renames: galileo-a2a → splunk-ao-a2a, galileo-adk → splunk-ao-adk - 19 environment variable renames: GALILEO_* → SPLUNK_AO_* - HTTP tracing header renames: X-Galileo-* → Splunk-AO-* - Protect feature legacy status (removed from splunk-ao) - GalileoScorers removal (use SplunkAOMetrics) - Before/after code examples and a full migration checklist - "What you do NOT need to change" section Covers tickets: HYBIM-713, HYBIM-716, HYBIM-717, HYBIM-718, HYBIM-719, HYBIM-725, HYBIM-727, HYBIM-728, HYBIM-800, HYBIM-804, HYBIM-807, HYBIM-823. Co-authored-by: Cursor <cursoragent@cursor.com>
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
1 participant
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
docs/MIGRATION_GUIDE.md— a comprehensive customer-facing migration guide for moving Python applications from the Galileo SDK (galileo) to Splunk Agent Observability (splunk-ao)mainsplunk-aois not yet on PyPIChanges
New file:
docs/MIGRATION_GUIDE.mdSections:
from galileo import …→from splunk_ao import …GALILEO_*→SPLUNK_AO_*renames with bridge explanationGalileoScorersX-Galileo-*→Splunk-AO-*galileo_coreimports,@log,TracingMiddleware, on-disk config, default URLsJira
HYBIM-840
Test plan
docs/MIGRATION_GUIDE.mdfor accuracy against currentmainsrc/splunk_ao/__init__.pyexportssrc/splunk_ao/config.pybridge tablepip install "splunk-ao @ git+https://github.com/splunk/splunk-ao-python.git"Made with Cursor