docs: add Highflame observability integration#6099
Conversation
Adds a Highflame page under Observability — runtime AI security guardrails (prompt injection, PII/DLP, content safety) for CrewAI via Highflame Shield, using the BaseEventListener-based HighflameCrewHooks. Registers the page in the Observability nav across tabs/locales. Note: ar/ko/pt-BR pages are English pending translation. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
📝 WalkthroughWalkthroughThis PR introduces Highflame Shield integration documentation for CrewAI across four languages. It adds English documentation with setup instructions, code examples using ChangesHighflame Integration Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment Warning |
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/ar/observability/highflame.mdx (1)
1-76:⚠️ Potential issue | 🟠 Major | 🏗️ Heavy liftTranslation files contain English content instead of translated text.
All three translation files (Arabic, Korean, Portuguese-Brazil) currently contain identical English content. According to the contributing guidelines, translations must maintain parity by translating natural language text while preserving code blocks, URLs, and MDX/JSX syntax unchanged. These files should not be merged until properly translated, as they will serve broken content to non-English speaking users.
Required changes for each file:
- Translate frontmatter fields (
title,description)- Translate all body text (headings, paragraphs, table content, note text)
- Keep code blocks, URLs, and MDX components (
<Steps>,<Step>,<Note>) unchangedAs per coding guidelines: "Update translations in
docs/{ar,ko,pt-BR}/to maintain parity" and "Keep all MDX/JSX syntax, code blocks, and URLs unchanged in translations."🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/ar/observability/highflame.mdx` around lines 1 - 76, The Arabic translation file docs/ar/observability/highflame.mdx currently contains the original English content; update the file to provide a proper Arabic translation while preserving all MDX/JSX, code blocks, URLs and component tags. Specifically translate the frontmatter fields title and description, all headings and body text (e.g., "# Highflame", "## Setup", "## Modes", the table content and list items like "LLM01 Prompt Injection"), and the <Note> paragraph into Arabic, but do not change any code blocks (the pip install and Python snippet), the Highflame/HighflameCrewHooks names, URLs, or the <Steps>/<Step>/<Note> components and their attributes. Repeat the same parity rules for the other untranslated files mentioned (ko and pt-BR) so translations match the original English structure.Source: Coding guidelines
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@docs/ar/observability/highflame.mdx`:
- Around line 1-76: The Arabic translation file
docs/ar/observability/highflame.mdx currently contains the original English
content; update the file to provide a proper Arabic translation while preserving
all MDX/JSX, code blocks, URLs and component tags. Specifically translate the
frontmatter fields title and description, all headings and body text (e.g., "#
Highflame", "## Setup", "## Modes", the table content and list items like "LLM01
Prompt Injection"), and the <Note> paragraph into Arabic, but do not change any
code blocks (the pip install and Python snippet), the
Highflame/HighflameCrewHooks names, URLs, or the <Steps>/<Step>/<Note>
components and their attributes. Repeat the same parity rules for the other
untranslated files mentioned (ko and pt-BR) so translations match the original
English structure.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 29dc4d3b-cb68-4d05-93b5-857f54309050
📒 Files selected for processing (5)
docs/ar/observability/highflame.mdxdocs/docs.jsondocs/en/observability/highflame.mdxdocs/ko/observability/highflame.mdxdocs/pt-BR/observability/highflame.mdx
Removes the ar/ko/pt-BR copies that were English placeholders; keeps the English observability page. Translations can follow via the normal i18n flow. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
@greysonlalonde would you be the right reviewer for this? It adds a Highflame observability page (runtime guardrails for CrewAI via the |
Adds a Highflame page under Observability.
Highflame provides runtime AI security guardrails — prompt injection, sensitive-information / PII & DLP, content safety — for CrewAI via Highflame Shield, organized around the OWASP LLM Top 10. It integrates through the
BaseEventListener-basedHighflameCrewHooks(pip install 'highflame[crewai]'), guarding every LLM and tool call your crew makes.docs/en/observability/highflame.mdx, modeled on the existing Portkey observability page.ar/ko/pt-BRcopies (English pending translation).en/observability/highflamein the Observability navigation.Summary by CodeRabbit