Skip to content

feat: update observability and system flowchart in README#18

Merged
ssdeanx merged 1 commit intomainfrom
develop
Dec 8, 2025
Merged

feat: update observability and system flowchart in README#18
ssdeanx merged 1 commit intomainfrom
develop

Conversation

@ssdeanx
Copy link
Owner

@ssdeanx ssdeanx commented Dec 8, 2025

  • Replace Arize with Langfuse in observability section for accurate tracing information.
  • Adjust styles for Client and Langfuse in the flowchart for better visual distinction.
  • Correctly format connections in the system flowchart for clarity.
  • Update environment variable from PHOENIX_ENDPOINT to LANGFUSE_BASE_URL for consistency.
  • Change observability exporters section title from Arize/Phoenix to Langfuse.

Summary by Sourcery

Update documentation to reflect Langfuse-based observability and improved system diagrams.

Documentation:

  • Replace Arize/Phoenix references with Langfuse in observability sections, including environment variables and exporter descriptions.
  • Refine architecture and system flowchart diagrams for clearer structure, connections, and visual styling.

- Replace Arize with Langfuse in observability section for accurate tracing information.
- Adjust styles for Client and Langfuse in the flowchart for better visual distinction.
- Correctly format connections in the system flowchart for clarity.
- Update environment variable from PHOENIX_ENDPOINT to LANGFUSE_BASE_URL for consistency.
- Change observability exporters section title from Arize/Phoenix to Langfuse.
Copilot AI review requested due to automatic review settings December 8, 2025 09:50
@continue
Copy link

continue bot commented Dec 8, 2025

Keep this PR in a mergeable state →

Learn more

All Green is an AI agent that automatically:

✅ Addresses code review comments

✅ Fixes failing CI checks

✅ Resolves merge conflicts

@sourcery-ai
Copy link

sourcery-ai bot commented Dec 8, 2025

Reviewer's Guide

Updates the README’s observability documentation and diagrams to reflect a migration from Arize/Phoenix to Langfuse, adjusts Mermaid flowchart styles and edge syntax for clarity, and aligns environment variable names with the new observability stack.

Flow diagram for updated observability section with Langfuse

graph TB
    subgraph "🧠 Core System"
        Client[Client UI] --> UI[Next.js App]
        UI --> App[Mastra App]
        App --> Agents[Agents]
        Agents --> Postgres[(Postgres + PgVector)]
    end

    subgraph "📊 Observability"
        Agents --> Langfuse[Langfuse Traces<br/>• 97% Traced<br/>• 10+ Scorers]
        Postgres --> Langfuse
    end

    UI --> App
    App --> Agents

    style Client fill:#e8f5e9,stroke:#ff9800
    style Langfuse fill:#e8f5e9,stroke:#ff9800
    style UI fill:#e8f5e9,stroke:#64b5f6
Loading

Flow diagram for updated system flowchart in README

flowchart TD
    A[app/chat] -->|components| B[chat-header.tsx]
    A -->|components| C[chat-messages.tsx]
    A -->|components| D[chat-input.tsx]
    A -->|config| E[agents.ts]
    A -->|providers| F[chat-context.tsx]

    G[app/networks] -->|components| H[network-header.tsx]
    G -->|components| I[network-messages.tsx]
    G -->|config| J[networks.ts]
    G -->|providers| K[network-context.tsx]

    L[app/workflows] -->|components| M[workflow-canvas.tsx]
    L -->|components| N[workflow-header.tsx]
    L -->|config| O[workflows.ts]
    L -->|providers| P[workflow-context.tsx]

    Q[app/dashboard] -->|components| R[dashboard.tsx]
    Q -->|components| S[agent-list.tsx]
    Q -->|providers| T[dashboard-context.tsx]

    U[lib] -->|hooks| V[use-mastra.ts]
    U -->|hooks| W[use-dashboard-queries.ts]
    U -->|utils| X[utils.ts]
    U -->|client| Y[mastra-client.ts]

    Z[src/types] -->|api| AA[mastra-api.ts]

    AB[src/mastra/index.ts] -->|imports| AC[agents/*]
    AB -->|imports| AD[tools/*]
    AB -->|imports| AE[workflows/*]
    AB -->|imports| AF[networks/*]
    AB -->|imports| AG[config/*]

    style A fill:#e8f5e9,stroke:#81c784
    style G fill:#e8f5e9,stroke:#81c784
    style L fill:#e8f5e9,stroke:#81c784
    style Q fill:#e8f5e9,stroke:#81c784
    style U fill:#e3f2fd,stroke:#64b5f6
    style Z fill:#e3f2fd,stroke:#64b5f6
    style AB fill:#000000,stroke:#ff9800
Loading

File-Level Changes

Change Details Files
Update observability diagram to reference Langfuse instead of Arize/Phoenix and tweak visual styling.
  • Replace Arize/Phoenix node label with Langfuse-specific text in the observability Mermaid graph
  • Update edges from Agents/Postgres to point to the Langfuse node
  • Adjust Client, Langfuse, and UI Mermaid style directives to use new fill and stroke colors for better distinction
README.md
Normalize Mermaid system flowchart edge syntax and tweak styling.
  • Remove reversed connector syntax (`-->
label
Align environment variable documentation and observability exporter naming with Langfuse-based tracing.
  • Rename PG_CONNECTION env var to SUPABASE for the Postgres + PgVector RAG configuration entry
  • Replace PHOENIX_ENDPOINT with LANGFUSE_BASE_URL and update its description to Langfuse tracing
  • Retitle the observability exporters section from Arize/Phoenix Exporters to Langfuse Exporters while keeping the metrics description intact
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@ssdeanx ssdeanx merged commit 081bf9e into main Dec 8, 2025
7 of 9 checks passed
@github-actions
Copy link

github-actions bot commented Dec 8, 2025

🤖 Hi @ssdeanx, I've received your request, and I'm working on it now! You can track my progress in the logs for more details.

@coderabbitai
Copy link

coderabbitai bot commented Dec 8, 2025

Caution

Review failed

The pull request is closed.

Summary by CodeRabbit

Release Notes

  • Documentation
    • Updated observability setup to use Langfuse instead of Arize/Phoenix.
    • Updated environment variable configuration for RAG setup.
    • Enhanced system and flow diagrams with improved syntax and styling for better clarity.
    • Updated RAG and observability metrics documentation.

✏️ Tip: You can customize this high-level summary in your review settings.

Walkthrough

README.md has been updated to replace Arize/Phoenix observability tooling with Langfuse throughout diagrams and documentation. Environment variable references changed from PG_CONNECTION to LANGFUSE_BASE_URL with SUPABASE as the new RAG setup key. Mermaid diagram syntax corrected by removing stray "<" annotations. Diagram styling enhanced with stroke colors for consistency.

Changes

Cohort / File(s) Summary
Documentation and Observability Migration
README.md
Replaced Arize/Phoenix observability integration with Langfuse; updated environment variables (PG_CONNECTION → LANGFUSE_BASE_URL, added SUPABASE); corrected Mermaid diagram syntax by removing stray "<" annotations; added stroke colors to diagram nodes (Client, Langfuse, UI) for visual consistency; updated RAG and Observability sections with Langfuse metrics (100% traces, 10+ scorers, sampling details)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • Single file with consistent pattern replacements (Arize/Phoenix → Langfuse)
  • Verify all environment variable references are updated consistently across diagrams and text
  • Confirm Mermaid syntax corrections don't affect diagram rendering
  • Check styling changes render properly in both light and dark modes

Poem

🐰 Langfuse now watches the flow with care,
Phoenix and Arize fade in the air,
Diagrams fixed with syntax so clean,
Colors now pop on the observability scene! ✨

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch develop

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7e3a5bc and 87eab2c.

📒 Files selected for processing (1)
  • README.md (3 hunks)

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.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @ssdeanx, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request updates the README.md file to reflect a significant change in the project's observability stack, transitioning from Arize/Phoenix to Langfuse. The changes ensure that the documentation accurately represents the current system architecture, including updated environment variables, flowchart diagrams, and descriptive text, providing a clear and up-to-date overview for users and contributors.

Highlights

  • Observability Platform Update: Replaced all mentions of Arize/Phoenix with Langfuse across the README for accurate tracing information.
  • Flowchart Visuals: Adjusted styles for Client and Langfuse nodes in the observability flowchart and corrected connection formatting in the system flowchart for improved clarity.
  • Environment Variable Renaming: Updated the environment variable PHOENIX_ENDPOINT to LANGFUSE_BASE_URL and PG_CONNECTION to SUPABASE for consistency and accuracy.
  • Documentation Section Title: Changed the 'Arize/Phoenix Exporters' section title to 'Langfuse Exporters' to reflect the new observability tool.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey there - I've reviewed your changes - here's some feedback:

  • Double-check the PG_CONNECTIONSUPABASE env var rename aligns with the actual configuration keys used in the codebase, as this could easily desync the README from the runtime config.
  • The style AB fill:#000000,stroke:#ff9800 change will render black text on a black background in Mermaid by default; consider using a lighter fill color or explicitly setting a contrasting font color.
  • The new styles for Client, Langfuse, and UI all reuse the same fill color, which may reduce visual distinction in the observability diagram compared to the previous palette; consider varying fill colors if the goal is clearer differentiation.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Double-check the `PG_CONNECTION``SUPABASE` env var rename aligns with the actual configuration keys used in the codebase, as this could easily desync the README from the runtime config.
- The `style AB fill:#000000,stroke:#ff9800` change will render black text on a black background in Mermaid by default; consider using a lighter fill color or explicitly setting a contrasting font color.
- The new styles for `Client`, `Langfuse`, and `UI` all reuse the same fill color, which may reduce visual distinction in the observability diagram compared to the previous palette; consider varying fill colors if the goal is clearer differentiation.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the README.md to reflect the migration from Arize/Phoenix to Langfuse for observability. The changes correctly update the architecture diagrams, environment variables table, and section headers.

However, the update appears to be incomplete and contains some inconsistencies. I found several remaining references to Arize/Phoenix that should be updated for consistency:

  • In README.md:
    • Line 60: The comparison table still lists "Full Arize/Phoenix tracing".
    • Line 80: The core capabilities list mentions "Arize/Phoenix traces".
    • Line 646: The contribution guidelines mention "Arize spans".
  • In src/mastra/config/AGENTS.md:
    • Line 61: The environment variables section still lists PHOENIX_ENDPOINT.

Additionally, there are a couple of other inconsistencies:

  • The environment variable PG_CONNECTION was changed to SUPABASE in README.md (line 556), but this change is not reflected in src/mastra/config/AGENTS.md (line 45), which still refers to PG_CONNECTION.
  • The PR description does not mention the change from PG_CONNECTION to SUPABASE.

I've left one specific comment regarding a styling issue in one of the updated Mermaid diagrams that affects readability. Please address these points to ensure the documentation is fully consistent with the codebase changes.

style U fill:#e3f2fd,stroke:#64b5f6
style Z fill:#e3f2fd,stroke:#64b5f6
style AB fill:#fff3e0,stroke:#ff9800
style AB fill:#000000,stroke:#ff9800
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

The fill color for the src/mastra/index.ts node (AB) in this Mermaid diagram has been set to black (#000000). This will make the node's label unreadable, as the default text color is also black. To ensure the diagram is clear, please use a lighter fill color that provides sufficient contrast. The previous color #fff3e0 would work well.

Suggested change
style AB fill:#000000,stroke:#ff9800
style AB fill:#fff3e0,stroke:#ff9800

@github-actions
Copy link

github-actions bot commented Dec 8, 2025

🤖 I'm sorry @ssdeanx, but I was unable to process your request. Please see the logs for more details.

@greptile-apps
Copy link

greptile-apps bot commented Dec 8, 2025

Greptile Overview

Greptile Summary

This PR migrates the observability documentation from Arize/Phoenix to Langfuse across the README, including:

  • Updated architecture diagram to show Langfuse instead of Arize/Phoenix
  • Fixed system flowchart arrow syntax (removed invalid |< connectors)
  • Changed environment variable from PHOENIX_ENDPOINT to LANGFUSE_BASE_URL
  • Updated observability exporters section title

Issues Found:

  • Three references to Arize/Phoenix were missed in the comparison table (line 60), core capabilities section (line 80), and contributing guidelines (line 646)
  • These inconsistencies should be corrected to complete the migration

Confidence Score: 3/5

  • This PR is safe to merge after fixing the three inconsistent references to Arize/Phoenix
  • The changes are straightforward documentation updates with correct syntax fixes for the flowchart. However, the incomplete migration (3 missed references) creates inconsistency in the documentation. Once these are addressed, the PR will be ready to merge.
  • README.md:60 README.md:80 README.md:646 need Arize/Phoenix references updated to Langfuse

Important Files Changed

File Analysis

Filename Score Overview
README.md 3/5 Updated observability references from Arize/Phoenix to Langfuse, fixed flowchart syntax, and corrected environment variables. Found 3 missed references that need updating for consistency.

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant README as README.md
    participant Obs as Observability System
    participant Env as Environment Config
    
    Dev->>README: Update observability references
    Note over README: Line 109: Arize → Langfuse
    Note over README: Line 110: Connection updated
    
    Dev->>README: Fix flowchart syntax
    Note over README: Lines 125-164: |< → |
    Note over README: Correct Mermaid arrows
    
    Dev->>README: Update environment variables
    Note over README: Line 556: PG_CONNECTION → SUPABASE
    Note over README: Line 560: PHOENIX_ENDPOINT → LANGFUSE_BASE_URL
    
    Dev->>README: Update observability section
    Note over README: Line 586: Section title updated
    
    README-->>Obs: Documentation now references Langfuse
    README-->>Env: New env var names documented
    
    Note over README: ⚠️ Missed references:<br/>Line 60, 80, 646 still mention Arize/Phoenix
Loading

Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

Additional Comments (3)

  1. README.md, line 60 (link)

    syntax: inconsistent with the rest of the PR - should be updated to Langfuse to match the changes made elsewhere in the document

  2. README.md, line 80 (link)

    syntax: inconsistent with the PR - should reference Langfuse instead of Arize/Phoenix

  3. README.md, line 646 (link)

    syntax: inconsistent with the observability migration - should be Langfuse instead of Arize

1 file reviewed, 3 comments

Edit Code Review Agent Settings | Greptile

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the documentation to migrate from Arize/Phoenix to Langfuse as the observability platform, while also improving the readability of mermaid flowchart syntax.

Key changes:

  • Replaces Arize/Phoenix references with Langfuse across diagrams and configuration tables
  • Fixes flowchart arrow syntax (removes < characters) for proper rendering
  • Updates environment variable from PG_CONNECTION to SUPABASE for consistency with .env.example

style U fill:#e3f2fd,stroke:#64b5f6
style Z fill:#e3f2fd,stroke:#64b5f6
style AB fill:#fff3e0,stroke:#ff9800
style AB fill:#000000,stroke:#ff9800
Copy link

Copilot AI Dec 8, 2025

Choose a reason for hiding this comment

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

The style uses a black fill color (#000000) which may make the text difficult to read in the diagram. Consider using a lighter background color consistent with other elements in the flowchart. For example: style AB fill:#fff3e0,stroke:#ff9800 (as it was before) or another light color that provides good contrast.

Suggested change
style AB fill:#000000,stroke:#ff9800
style AB fill:#fff3e0,stroke:#ff9800

Copilot uses AI. Check for mistakes.
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