-
Notifications
You must be signed in to change notification settings - Fork 6
Tracing #202
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
- Added telemetry configuration sanitization to ensure sensitive data is redacted before transmission. - Updated lifespan management to handle telemetry initialization errors gracefully. - Included a new section in README.md to inform users about telemetry data collection and how to disable it. - Added 'pyyaml' as a dependency in the project.
- Deleted the engine telemetry plan markdown file as it is no longer needed for the project. - This change helps streamline the project structure by removing outdated documentation.
|
| GitGuardian id | GitGuardian status | Secret | Commit | Filename | |
|---|---|---|---|---|---|
| 25048295 | Triggered | Generic High Entropy Secret | 6922370 | libs/idun_agent_engine/src/idun_agent_engine/telemetry/telemetry.py | View secret |
🛠 Guidelines to remediate hardcoded secrets
- Understand the implications of revoking this secret by investigating where it is used in your code.
- Replace and store your secret safely. Learn here the best practices.
- Revoke and rotate this secret.
- If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.
To avoid such incidents in the future consider
- following these best practices for managing and storing secrets including API keys and other credentials
- install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.
🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cursor Bugbot has reviewed your changes and found 2 potential issues.
Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.
This PR is being reviewed by Cursor Bugbot
Details
You are on the Bugbot Free tier. On this plan, Bugbot will review limited PRs each billing cycle.
To receive Bugbot reviews on all of your PRs, visit the Cursor dashboard to activate Pro and start your 14-day free trial.
| """Best-effort flush/shutdown without blocking application shutdown.""" | ||
|
|
||
| executor = self._executor | ||
| client = self._client |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Race condition in telemetry shutdown may skip client cleanup
Low Severity
The shutdown method captures client = self._client at call time (line 225), but _send tasks queued via capture() create the client asynchronously in the worker thread. If shutdown() is called before queued _send tasks execute, client is captured as None. The closure _shutdown_client then uses this stale None value, causing the actual PostHog client (created later by _send) to never be properly shut down. This could result in unflushed telemetry events and resource leaks.
Additional Locations (1)
| telemetry.capture("engine stopped") | ||
| await cleanup_agent(app) | ||
| if telemetry is not None: | ||
| telemetry.shutdown() |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing telemetry cleanup if agent cleanup fails
Low Severity
If cleanup_agent(app) at line 125 raises an exception, telemetry.shutdown() at line 127 is never called. This leaves the ThreadPoolExecutor and PostHog client without proper cleanup. Pending telemetry events won't be flushed, and the executor's worker thread could delay process termination. The shutdown sequence lacks a try/finally block to ensure telemetry cleanup regardless of agent cleanup success.
* Update README and index.md for improved clarity and navigation. Changed Quickstart Guide link to direct to the new URL, added Vertex AI to supported backends, and revised section titles for consistency. Enhanced deployment options with specific self-hosted links for GCP, AWS, and Azure. * Update README to include GitHub Stars badge and Star History chart for enhanced visibility and engagement metrics. * Update README to reflect Python version change from 3.13+ to 3.12 and revise project description for clarity and engagement. * Enhance documentation by adding a YouTube video embed to the README and Quickstart guide for better user engagement. Improved formatting in index.md and added spacing for clarity. * Replace YouTube video embed with a clickable image link in README for improved user experience and engagement. * screen yt * Enhance doc * Remove outdated documentation files including DEBUG_GUIDE.md, DEV_SETUP.md, MVP_RELEASE_CHECKLIST.md, QUICK_RELEASE.md, RELEASE_GUIDE.md, and release-related scripts. Also, delete unused images and test files to streamline the project structure. * Enhance docs + add lancgain tools (#187) * Update documentation links and remove outdated agent framework guides - Changed the roadmap link in mkdocs.yml to point to the correct file. - Updated index.md to include absolute URLs for Quickstart, Architecture overview, and Roadmap links. - Removed outdated ADK and LangGraph agent framework documentation files. - Fixed links in the Quickstart guide to reflect the new paths for agent frameworks. * Refactor documentation structure and remove outdated files - Updated mkdocs.yml to simplify navigation by renaming the SSO/RBAC section to SSO. - Removed several outdated documentation files including changelog.md, contributing.md, faq.md, known-bugs.md, support.md, api.md, cli.md, configuration.md, environment.md, and rest-api.md to streamline the documentation. - Retained the roadmap link in mkdocs.yml for continued access to relevant information. * Update documentation links in index.md for consistency and accuracy - Changed Quickstart, Architecture overview, and Roadmap links to point to their respective directories for improved navigation. * Update documentation links in index.md for improved navigation - Corrected URLs for Quickstart, Architecture overview, and Roadmap to ensure they point to the appropriate sections, enhancing user experience. * Update Quickstart documentation for improved link formatting - Adjusted the formatting of the "Next" section links in the Quickstart guide for better readability and consistency. * Fix typo in Quickstart documentation by correcting "LanGraph" to "LangGraph" for improved accuracy. * Remove outdated links from index.md to streamline navigation and improve user experience. * Enhance documentation and configuration for Idun Agent Platform - Updated mkdocs.yml to include new redirect mappings for canonical URLs, improving navigation and accessibility. - Revised README.md to clarify the platform's purpose and capabilities, including updated links and formatting for better user engagement. - Removed outdated index.html and agent framework documentation files to streamline the project structure. - Improved index.md with new sections for quick access to guides and resources, enhancing user experience. - Adjusted various documentation files for consistency in language and formatting, ensuring clarity across the platform's documentation. * shorten index docs * update guardrails * fix docs * feat: update docs * feat: update docs * feat: update docs * Update Discord links across documentation to reflect new server invite URL * Fix Discord link in README Updated Discord link in README.md * Update Discord link in README to the correct server invite URL * Develop (#195) * Update README and index.md for improved clarity and navigation. Changed Quickstart Guide link to direct to the new URL, added Vertex AI to supported backends, and revised section titles for consistency. Enhanced deployment options with specific self-hosted links for GCP, AWS, and Azure. * Update README to include GitHub Stars badge and Star History chart for enhanced visibility and engagement metrics. * Update README to reflect Python version change from 3.13+ to 3.12 and revise project description for clarity and engagement. * Enhance documentation by adding a YouTube video embed to the README and Quickstart guide for better user engagement. Improved formatting in index.md and added spacing for clarity. * Replace YouTube video embed with a clickable image link in README for improved user experience and engagement. * screen yt * Enhance doc * Remove outdated documentation files including DEBUG_GUIDE.md, DEV_SETUP.md, MVP_RELEASE_CHECKLIST.md, QUICK_RELEASE.md, RELEASE_GUIDE.md, and release-related scripts. Also, delete unused images and test files to streamline the project structure. * Enhance docs + add lancgain tools (#187) * Update documentation links and remove outdated agent framework guides - Changed the roadmap link in mkdocs.yml to point to the correct file. - Updated index.md to include absolute URLs for Quickstart, Architecture overview, and Roadmap links. - Removed outdated ADK and LangGraph agent framework documentation files. - Fixed links in the Quickstart guide to reflect the new paths for agent frameworks. * Refactor documentation structure and remove outdated files - Updated mkdocs.yml to simplify navigation by renaming the SSO/RBAC section to SSO. - Removed several outdated documentation files including changelog.md, contributing.md, faq.md, known-bugs.md, support.md, api.md, cli.md, configuration.md, environment.md, and rest-api.md to streamline the documentation. - Retained the roadmap link in mkdocs.yml for continued access to relevant information. * Update documentation links in index.md for consistency and accuracy - Changed Quickstart, Architecture overview, and Roadmap links to point to their respective directories for improved navigation. * Update documentation links in index.md for improved navigation - Corrected URLs for Quickstart, Architecture overview, and Roadmap to ensure they point to the appropriate sections, enhancing user experience. * Update Quickstart documentation for improved link formatting - Adjusted the formatting of the "Next" section links in the Quickstart guide for better readability and consistency. * Fix typo in Quickstart documentation by correcting "LanGraph" to "LangGraph" for improved accuracy. * Remove outdated links from index.md to streamline navigation and improve user experience. * Enhance documentation and configuration for Idun Agent Platform - Updated mkdocs.yml to include new redirect mappings for canonical URLs, improving navigation and accessibility. - Revised README.md to clarify the platform's purpose and capabilities, including updated links and formatting for better user engagement. - Removed outdated index.html and agent framework documentation files to streamline the project structure. - Improved index.md with new sections for quick access to guides and resources, enhancing user experience. - Adjusted various documentation files for consistency in language and formatting, ensuring clarity across the platform's documentation. * Fix Discord link in README Updated Discord link in README.md * Discord link (#200) * Update Discord links across documentation Replaced outdated Discord server links with the new invite link in README.md, index.md, and various documentation files to ensure users have access to the correct community support channel. * Update Discord link in README.md to the new invite URL for community access * Resolve merge conflicts and standardize Discord link in README.md * Tracing (#202) * plan preparation * add: telemetry first commit * Enhance telemetry functionality and documentation - Added telemetry configuration sanitization to ensure sensitive data is redacted before transmission. - Updated lifespan management to handle telemetry initialization errors gracefully. - Included a new section in README.md to inform users about telemetry data collection and how to disable it. - Added 'pyyaml' as a dependency in the project. * Remove engine telemetry plan file - Deleted the engine telemetry plan markdown file as it is no longer needed for the project. - This change helps streamline the project structure by removing outdated documentation. * Update license link in README.md to point to the correct MIT license URL * Update license from MIT to GPL-3.0-only across project files (#203) - Replaced the MIT license with the GNU General Public License v3 (GPLv3) in LICENSE, pyproject.toml files for the main project and its libraries. - Updated README.md to reflect the new GPL-3.0-only license badge. - Ensured all relevant files and dependencies are aligned with the new licensing terms. * fix: wrong import (#201) * Idun cli (#204) * feat: add tui * feat: add mcp + adk + fixed background process keeps working when server shutdown * refactor: update dependencies and improve package structure - Removed the idun-platform-cli dependency from pyproject.toml. - Updated the textual dependency version in idun_agent_engine's pyproject.toml. - Enhanced the package structure in idun_agent_engine by specifying sources for wheel builds. - Added versioning information to the main application display in the CLI. --------- Co-authored-by: AhmedEnnaifer <ahmedennaifer00@gmail.com> * Update version numbers to 0.4.0 across project files and Docker configurations - Updated Docker images for manager and web services in docker-compose.yml. - Incremented version numbers in pyproject.toml and _version.py for idun-agent-engine and idun-agent-schema. - Updated version in Dockerfile and pyproject.toml for idun-agent-manager. - Adjusted __version__ in __init__.py files for idun-agent-engine and idun-agent-manager. --------- Co-authored-by: AhmedEnnaifer <ahmedennaifer00@gmail.com> Co-authored-by: Wizard <e.yassin@idun-group.com>
Note
Adds anonymous, opt-out telemetry and wires it into the engine lifecycle.
idun_agent_engine.telemetrywithIdunTelemetry(PostHog-backed), non-blocking capture, stabledistinct_idpersisted viaplatformdirs, andsanitize_telemetry_configto redact secrets and truncate values; telemetry is enabled by default and can be disabled withIDUN_TELEMETRY_ENABLED=falseserver/lifespan.pyto captureengine started/engine stoppedevents and perform graceful shutdownREADME.mdwith a Telemetry section and disable flagplatformdirs,posthog,PyYAML; bumps versions (idun-agent-engine0.3.9,idun-agent-schema0.3.9) and refreshes lockfilesWritten by Cursor Bugbot for commit c676d82. This will update automatically on new commits. Configure here.