AgentOps-AI / agentops

Python SDK for agent monitoring, LLM cost tracking, benchmarking, and more. Integrates with most LLMs and agent frameworks like CrewAI, Langchain, and Autogen
https://agentops.ai
MIT License
1.22k stars 97 forks source link

Docs overhaul #226

Closed HowieG closed 1 month ago

HowieG commented 1 month ago

Resolves ENG-411

gitguardian[bot] commented 1 month ago

⚠️ GitGuardian has uncovered 2 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secrets in your pull request
| GitGuardian id | GitGuardian status | Secret | Commit | Filename | | | -------------- | ------------------ | ------------------------------ | ---------------- | --------------- | -------------------- | | [10824647](https://dashboard.gitguardian.com/workspace/514623/incidents/10824647?occurrence=135733288) | Triggered | Generic High Entropy Secret | e03df8e8fc1e38365814f89e3e1a396dadf19bd2 | docs/mint.json | [View secret](https://github.com/AgentOps-AI/agentops/commit/e03df8e8fc1e38365814f89e3e1a396dadf19bd2#diff-c91a604899dfef4b2494c317f4fd39a7f22b79986095f580399347293d534debL97) | | [10824647](https://dashboard.gitguardian.com/workspace/514623/incidents/10824647?occurrence=135733400) | Triggered | Generic High Entropy Secret | e937c85723cfdedd0080b582fbc73b437051db7b | docs/mint.json | [View secret](https://github.com/AgentOps-AI/agentops/commit/e937c85723cfdedd0080b582fbc73b437051db7b#diff-c91a604899dfef4b2494c317f4fd39a7f22b79986095f580399347293d534debL101) |
🛠 Guidelines to remediate hardcoded secrets
1. Understand the implications of revoking this secret by investigating where it is used in your code. 2. Replace and store your secrets safely. [Learn here](https://blog.gitguardian.com/secrets-api-management?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) the best practices. 3. Revoke and [rotate these secrets](https://docs.gitguardian.com/secrets-detection/secrets-detection-engine/detectors/generics/generic_high_entropy_secret#revoke-the-secret?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment). 4. If possible, [rewrite git history](https://blog.gitguardian.com/rewriting-git-history-cheatsheet?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment). 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](https://blog.gitguardian.com/secrets-api-management/?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) for managing and storing secrets including API keys and other credentials - install [secret detection on pre-commit](https://docs.gitguardian.com/ggshield-docs/integrations/git-hooks/pre-commit?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) 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.

HowieG commented 1 month ago

@bboynton97 I needed to xlr8

HowieG commented 1 month ago

@bboynton97 but forreal I did one big PR bc I think it would've taken 3x as long to make branches for each and not have them conflict etc and the corresponding dip in motivation. Felt lower risk than code changes

HowieG commented 1 month ago

@bboynton97 otherwise yes I always try to keep my PRs modular