feat(config): rename GALILEO_* env vars to SPLUNK_AO_* (HYBIM-713, 727) [DO NOT MERGE]#597
feat(config): rename GALILEO_* env vars to SPLUNK_AO_* (HYBIM-713, 727) [DO NOT MERGE]#597adityamehra wants to merge 5 commits into
Conversation
…6, 727) Hard cut-over: all GALILEO_* environment variables consumed by this SDK are renamed to SPLUNK_AO_* as part of the Splunk Agent Observability rebrand. Changes: - configuration.py: 14 ConfigKey.env_var fields updated - config.py: auth validation + _bridge_env_vars() for galileo-core compat - utils/env_helpers.py: os.getenv() calls updated - utils/decorators/telemetry_toggle.py: GALILEO_LOGGING_DISABLED renamed - logger/logger.py: GALILEO_INGEST_BETA_DISABLED renamed - Remaining src files: docstrings/error strings updated - tests/**: all GALILEO_* references renamed to SPLUNK_AO_* - docs/SPLUNK_AO_ENV_RENAME.md: spec document added Compatibility: _bridge_env_vars() temporarily maps SPLUNK_AO_* -> GALILEO_* so that the galileo-core dependency (still reading GALILEO_*) continues to work until it is updated separately. Out of scope: GALILEO_HEADER_PREFIX (tracked in HYBIM-729). DO NOT MERGE — will be re-targeted to signalfx/splunk-ao-python once that repository is created. Co-authored-by: Cursor <cursoragent@cursor.com>
| name="galileo_api_key", | ||
| env_var="GALILEO_API_KEY", | ||
| description="API key for authenticating with Galileo", | ||
| env_var="SPLUNK_AO_API_KEY", | ||
| description="API key for authenticating with Splunk Agent Observability", | ||
| required=True, | ||
| sensitive=True, |
There was a problem hiding this comment.
Configuration now reads galileo_api_key from SPLUNK_AO_API_KEY only, so the published GALILEO_* docs/examples will break Configuration.galileo_api_key/connect() after upgrade — should we update those in the same release or keep a temporary alias?
Want Baz to fix this for you? Activate Fixer
Other fix methods
Prompt for AI Agents
Before applying, verify this suggestion against the current code. In
src/galileo/configuration.py around lines 72-79 where _CONFIGURATION_KEYS defines the
ConfigKey for galileo_api_key (currently env_var="SPLUNK_AO_API_KEY"), add backward
compatibility so Configuration.galileo_api_key also falls back to the legacy
GALILEO_API_KEY environment variable when SPLUNK_AO_API_KEY is not set. Implement this
by extending the lookup logic in ConfigurationMeta.__getattribute__ (around lines
192-235) or by updating the ConfigKey metadata to support multiple env var candidates,
and ensure type/sensitive handling stays the same. Also update connect() around lines
385-392 to mention both environment variable names (and/or the migration timeline) in
the error message. If the repo’s published README/examples/templates can’t be
updated in this patch, this alias should be the primary fix to prevent immediate
breaking upgrades.
There was a problem hiding this comment.
Commit e7bffdc addressed this comment by updating the published docs and examples to use SPLUNK_AO_* names, including the API client README and the configuration error message. That makes the same-release migration explicit instead of leaving the old GALILEO_* references in the updated docs.
|
|
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
…|| '2.1.4') Co-authored-by: Cursor <cursoragent@cursor.com>
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## main #597 +/- ##
==========================================
+ Coverage 83.31% 83.33% +0.01%
==========================================
Files 125 125
Lines 10659 10666 +7
==========================================
+ Hits 8881 8888 +7
Misses 1778 1778 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
a8526d0 to
fb029b5
Compare
User description
This PR is opened for early review only.
Summary
Renames all
GALILEO_*environment variables toSPLUNK_AO_*as part of theSplunk Agent Observability rebrand.
Jira tickets: HYBIM-713 · HYBIM-727
Spec doc:
docs/SPLUNK_AO_ENV_RENAME.mdVariable mapping
GALILEO_API_KEYSPLUNK_AO_API_KEYGALILEO_CONSOLE_URLSPLUNK_AO_CONSOLE_URLGALILEO_PROJECTSPLUNK_AO_PROJECTGALILEO_PROJECT_IDSPLUNK_AO_PROJECT_IDGALILEO_LOG_STREAMSPLUNK_AO_LOG_STREAMGALILEO_LOG_STREAM_IDSPLUNK_AO_LOG_STREAM_IDGALILEO_JWT_TOKENSPLUNK_AO_JWT_TOKENGALILEO_SSO_ID_TOKENSPLUNK_AO_SSO_ID_TOKENGALILEO_SSO_PROVIDERSPLUNK_AO_SSO_PROVIDERGALILEO_USERNAMESPLUNK_AO_USERNAMEGALILEO_PASSWORDSPLUNK_AO_PASSWORDGALILEO_MODESPLUNK_AO_MODEGALILEO_LOGGING_DISABLEDSPLUNK_AO_LOGGING_DISABLEDGALILEO_INGEST_BETA_DISABLEDSPLUNK_AO_INGEST_BETA_DISABLEDKey design decisions
galileo-corebridge —GalileoPythonConfig._bridge_env_vars()transparently copiesSPLUNK_AO_*→GALILEO_*at startup so the privategalileo-coredependency continues towork until it is updated separately.
GALILEO_HEADER_PREFIXexcluded — tracked in HYBIM-729.Test plan
poetry run pytest— 2015 passed, 5 skippede2e-testing/py-sdk-and-ui) — targeted tests passedlangchain-agentexample — runs end-to-end, exit 0strands-agentsexample — runs end-to-end, exit 0Made with Cursor
Generated description
Below is a concise technical summary of the changes proposed in this PR:
Rebrand env var surfaces to Splunk AO names across configuration metadata, helpers, endpoints, docs, and the test suite so the SDK, logger, experiments, prompts, and telemetry toggles only refer to
SPLUNK_AO_*names. Add theGalileoPythonConfigcompatibility bridge plus CI resilience sogalileo-corecan keep reading legacy names until it migrates, and highlight the updated auth guidance everywhere.SPLUNK_AO_*variables instead of the oldGALILEO_*prefixes so the Splunk AO rebrand is reflected end-to-end.Modified files (40)
Latest Contributors(0)
SPLUNK_AO_*inputs into legacyGALILEO_*vars insideGalileoPythonConfig, refresh auth/error messaging, and tweak CI tooling so the privategalileo-coredependency continues to authenticate during the hard cut-over while the build flow stays robust.Modified files (3)
Latest Contributors(0)