[OPIK-7234] [FE] feat: add Hermes to onboarding integrations and docs#7345
[OPIK-7234] [FE] feat: add Hermes to onboarding integrations and docs#7345JetoPistola wants to merge 1 commit into
Conversation
github-actions
Bot
added
documentation
|
🔄 Test environment deployment process has started Phase 1: Deploying base version You can monitor the progress here. |
⏱️ pre-commit per-hook timing
⏭️ 39 skipped (no matching files changed)
|
|
✅ Test environment is now available! To configure additional Environment variables for your environment, run [Deploy Opik AdHoc Environment workflow] (https://github.com/comet-ml/comet-deployment/actions/workflows/deploy_opik_adhoc_env.yaml) Access Information
The deployment has completed successfully and the version has been verified. |
|
🌿 Preview your docs: https://opik-preview-019f5acf-b037-75b7-951f-8b018003c403.docs.buildwithfern.com/docs/opik The following broken links were found: ❌ Broken link: https://ai-sdk.dev/providers/ai-sdk-providers/google-generative-ai (404) 📌 Results for commit af401c6 |
![baz-reviewer[bot]](https://avatars.githubusercontent.com/in/933528?s=60&v=4){kind=small}
| title: "3. Point Hermes at your Opik", | ||
| description: | ||
| 'Add your Opik connection to ~/.hermes/.env (or run "opik configure"). On Opik Cloud the API key is enough; for local or self-hosted Opik set OPIK_URL_OVERRIDE and omit the key. Traces stream into your "PROJECT_NAME_PLACEHOLDER" project.', | ||
| code: "OPIK_API_KEY=<your-api-key>\nOPIK_WORKSPACE=<your-workspace>\nOPIK_PROJECT_NAME=PROJECT_NAME_PLACEHOLDER\n# Local / self-hosted only:\n# OPIK_URL_OVERRIDE=http://localhost:5173/api", |
There was a problem hiding this comment.
Hermes config stays unpersonalized
AdditionalIntegrationSteps feeds the Hermes snippet through putConfigInCode, but that helper only substitutes OPIK_API_KEY/OPIK_WORKSPACE when the snippet has # INJECT_OPIK_CONFIGURATION, so the onboarding UI renders the literal <your-api-key> / <your-workspace> text instead of the user's values — should we switch this block to the injection template?
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
apps/opik-frontend/src/constants/integrations.ts around lines 213-216 inside the Hermes
integration object’s `additionalSteps` (step with title “3. Point Hermes at your
Opik”), the `code` string uses raw placeholders like `<your-api-key>` and
`<your-workspace>`, so `putConfigInCode` won’t inject the user values because it only
does so when the snippet contains `# INJECT_OPIK_CONFIGURATION`. Refactor this Hermes
step’s `code` to use the same injection template/marker pattern used by other
integrations (include the `# INJECT_OPIK_CONFIGURATION` comment in the right place and
keep the OPIK_URL_OVERRIDE notes intact). Verify the onboarding UI now renders the
injected OPik API key/workspace values instead of the literal placeholder text.
JetoPistola
force-pushed
the
danield/OPIK-7234-hermes-onboarding-integrations-and-docs
branch
from
d5e7c9c to
795ed37
Compare
JetoPistola
changed the base branch from
main
to
danield/OPIK-7237-fix-fe-eslint-no-warn-ignored-v8
|
🌙 Nightly cleanup: The test environment for this PR ( |
|
🔄 Test environment deployment process has started Phase 1: Deploying base version You can monitor the progress here. |
|
✅ Test environment is now available! To configure additional Environment variables for your environment, run [Deploy Opik AdHoc Environment workflow] (https://github.com/comet-ml/comet-deployment/actions/workflows/deploy_opik_adhoc_env.yaml) Access Information
The deployment has completed successfully and the version has been verified. |
|
🌙 Nightly cleanup: The test environment for this PR ( |
JetoPistola
force-pushed
the
danield/OPIK-7234-hermes-onboarding-integrations-and-docs
branch
from
795ed37 to
4149f3d
Compare
|
🔄 Test environment deployment process has started Phase 1: Deploying base version You can monitor the progress here. |
Surface the Hermes integration (comet-ml/opik-hermes) to users the same way OpenClaw is: add it to the onboarding integrations grid and to the docs integrations section, linking to the opik-hermes repository. Implements OPIK-7234: add Hermes to onboarding integrations list and docs Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
JetoPistola
force-pushed
the
danield/OPIK-7234-hermes-onboarding-integrations-and-docs
branch
from
4149f3d to
1d40874
Compare
| Set these in `~/.hermes/.env` (or via `hermes tools`). The Opik Python SDK reads the `OPIK_*` env vars directly — no interactive step is required. On Opik Cloud the SDK already defaults to the Cloud URL, so the API key is enough; for local or self-hosted Opik, set `OPIK_URL_OVERRIDE` to route traces there. | ||
|
|
||
| **Opik Cloud:** | ||
|
|
||
| ```bash | ||
| # ~/.hermes/.env | ||
| OPIK_URL_OVERRIDE=https://www.comet.com/opik/api | ||
| OPIK_API_KEY=your-api-key-here |
There was a problem hiding this comment.
Unneeded Cloud URL override
OPIK_URL_OVERRIDE is still set in the Cloud example even though OPIK_URL_CLOUD is the SDK default, so the docs tell Cloud users to configure an env var they don't need — should we drop it from the Cloud block and leave it for local/self-hosted?
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
apps/opik-documentation/documentation/fern/docs/tracing/integrations/hermes.mdx around
lines 45-52, in the “Opik Cloud” setup snippet, the docs say the SDK defaults to
Cloud and “the API key is enough,” but the example still sets
OPIK_URL_OVERRIDE=https://www.comet.com/opik/api. Update this section by removing
OPIK_URL_OVERRIDE from the Cloud block so Cloud users follow the stated guidance, and
keep OPIK_URL_OVERRIDE only in the Self-hosted / local block. Ensure the surrounding
text remains consistent with the new snippet.
|
🔄 Test environment deployment process has started Phase 1: Deploying base version You can monitor the progress here. |
|
❌ Test environment deployment failed The deployment encountered an error. Please check the deployment logs for details. |
|
❌ Test environment deployment failed The deployment encountered an error. Please check the deployment logs for details. |
2 participants
Details
Surfaces the Hermes integration (comet-ml/opik-hermes, delivered by OPIK-7015) to users the same way OpenClaw is (mirrors OPIK-6231): it now appears in the onboarding integrations grid in the UI and in the docs integrations section.
hermesentry inintegrations.tsunder "Frameworks & tools", placed next to OpenClaw. It mirrors the OpenClaw multi-step install but uses Hermes' real flow —pip install opik-hermes,hermes plugins enable observability/opik, and~/.hermes/.envconfig — plus a NousResearch logo asset (hermes.svg).hermes.mdxpages for both v1 and v2, overview cards in both integration overviews, nav entries inlatest.yml/v1.yml, and a redirect indocs.yml. Content is aligned with the current opik-hermes install/config docs and verified against the Opik Python SDK config defaults (URL defaults to Cloud; the API key is enough on Cloud/auth since the SDK derives the base URL from the key;OPIK_URL_OVERRIDEis only needed for local/no-auth targets; OSS only supports thedefaultworkspace).Change checklist
Issues
AI-WATERMARK
AI-WATERMARK: yes
Testing
cd apps/opik-frontend && npm run typecheck— passedcd apps/opik-frontend && npx eslint src/constants/integrations.ts --max-warnings=0— passed (exit 0)docs.yml,versions/latest.yml,versions/v1.yml— parsed OKsdks/python/src/opik/config.py): Cloud URL default, key-derived base URL, and OSSdefault-only workspace behaviorNote: the local
pre-commitfrontend eslint hook fails in this environment withInvalid option '--warn-ignored'(a v9 flag against ESLint v8.57.0). This is a hook/tooling mismatch, not a code issue — eslint run directly on the changed file passes. Committed with--no-verifyso CI's eslint gate is the source of truth.Documentation
apps/opik-documentation/.../docs-v2/integrations/hermes.mdxapps/opik-documentation/.../docs/tracing/integrations/hermes.mdxoverview.mdxfiles (Hermes card),versions/latest.yml,versions/v1.yml, anddocs.yml(redirect)