Skip to content

docs: add Highflame observability integration#6099

Open
KunalJavelin wants to merge 2 commits into
crewAIInc:mainfrom
KunalJavelin:docs/highflame-observability
Open

docs: add Highflame observability integration#6099
KunalJavelin wants to merge 2 commits into
crewAIInc:mainfrom
KunalJavelin:docs/highflame-observability

Conversation

@KunalJavelin

@KunalJavelin KunalJavelin commented Jun 10, 2026

Copy link
Copy Markdown

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-based HighflameCrewHooks (pip install 'highflame[crewai]'), guarding every LLM and tool call your crew makes.

  • Adds docs/en/observability/highflame.mdx, modeled on the existing Portkey observability page.
  • Adds ar/ko/pt-BR copies (English pending translation).
  • Registers en/observability/highflame in the Observability navigation.

⚠️ This PR was AI-assisted. Per CONTRIBUTING it should carry the llm-generated label — I don't have permission to add labels on this repo, so could a maintainer please apply it? Thanks!

Summary by CodeRabbit

  • Documentation
    • Added comprehensive Highflame Shield integration guides in English, Korean, Portuguese Brazilian, and Arabic, including installation instructions, configuration steps, code examples, and details on supported integration modes and security capabilities.
    • Updated documentation index to include new Highflame observability integration references.

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>
@coderabbitai

coderabbitai Bot commented Jun 10, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

This PR introduces Highflame Shield integration documentation for CrewAI across four languages. It adds English documentation with setup instructions, code examples using HighflameCrewHooks, and enforcement mode descriptions, then provides translated versions in Arabic, Korean, and Portuguese-Brazil. The documentation manifest is updated across 15 locations to index the new pages.

Changes

Highflame Integration Documentation

Layer / File(s) Summary
English documentation and manifest configuration
docs/en/observability/highflame.mdx, docs/docs.json
Complete Highflame integration guide covering overview, installation, API key setup, HighflameCrewHooks integration example, supported enforcement modes (enforce, monitor, alert, modify), and OWASP LLM Top 10 guardrail coverage. Documentation manifest updated at 15 locations across language-specific navigation arrays.
Translated documentation
docs/ar/observability/highflame.mdx, docs/ko/observability/highflame.mdx, docs/pt-BR/observability/highflame.mdx
Arabic, Korean, and Portuguese-Brazil translations of Highflame documentation, each covering integration purpose, setup steps, usage examples, available enforcement modes, and supported guardrail categories.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Suggested labels

size/XL

Suggested reviewers

  • greysonlalonde
  • lucasgomide
  • flaviomuniz

Poem

🐰 A shield for crews, now documented with care,
Through Arabic, Korean, Portuguese, English so fair,
Highflame's guardrails dance in the light,
Safety through languages, a multilingual sight! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: add Highflame observability integration' clearly and accurately describes the main change: adding documentation for Highflame observability integration across multiple language versions.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Warning

⚠️ This pull request might be slop. It has been flagged by CodeRabbit slop detection and should be reviewed carefully.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 lift

Translation 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>) unchanged

As 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

📥 Commits

Reviewing files that changed from the base of the PR and between da8fe8c and 287ede2.

📒 Files selected for processing (5)
  • docs/ar/observability/highflame.mdx
  • docs/docs.json
  • docs/en/observability/highflame.mdx
  • docs/ko/observability/highflame.mdx
  • docs/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>
@KunalJavelin

Copy link
Copy Markdown
Author

@greysonlalonde would you be the right reviewer for this? It adds a Highflame observability page (runtime guardrails for CrewAI via the BaseEventListener-based HighflameCrewHooks), modeled on the existing Portkey page. I've trimmed it to an English-only page (dropped the untranslated locale copies CodeRabbit flagged). One ask: I don't have permission to add labels, so could a maintainer apply llm-generated per CONTRIBUTING? Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant