Skip to content

[Docs] UI Spend Logs Settings Docs#20197

Merged
yuneng-jiang merged 1 commit intomainfrom
spend_logs_docs
Jan 31, 2026
Merged

[Docs] UI Spend Logs Settings Docs#20197
yuneng-jiang merged 1 commit intomainfrom
spend_logs_docs

Conversation

@yuneng-jiang
Copy link
Collaborator

Relevant issues

Pre-Submission checklist

Please complete all items before asking a LiteLLM maintainer to review your PR

  • I have Added testing in the tests/litellm/ directory, Adding at least 1 test is a hard requirement - see details
  • My PR passes all unit tests on make test-unit
  • My PR's scope is as isolated as possible, it only solves 1 specific problem

CI (LiteLLM team)

CI status guideline:

  • 50-55 passing tests: main is stable with minor issues.
  • 45-49 passing tests: acceptable but needs attention
  • <= 40 passing tests: unstable; be careful with your merges and assess the risk.
  • Branch creation CI run
    Link:

  • CI run for the last commit
    Link:

  • Merge / cherry-pick CI run
    Links:

Type

📖 Documentation

Changes

@vercel
Copy link

vercel bot commented Jan 31, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
litellm Building Building Preview, Comment Jan 31, 2026 11:20pm

Request Review

@yuneng-jiang yuneng-jiang merged commit 543e85a into main Jan 31, 2026
9 of 12 checks passed
@yuneng-jiang yuneng-jiang deleted the spend_logs_docs branch January 31, 2026 23:20
@greptile-apps
Copy link
Contributor

greptile-apps bot commented Jan 31, 2026

Greptile Overview

Greptile Summary

This PR adds comprehensive documentation for the new UI Spend Log Settings feature, which allows users to configure spend log behavior directly from the Admin UI without requiring config file edits or proxy restarts.

Key changes:

  • Added new documentation page (ui_spend_log_settings.md) with detailed walkthrough including screenshots
  • Updated existing ui_logs.md to reference the new UI settings option alongside config-based approach
  • Added navigation entry in sidebars.js to make the new page discoverable
  • Included screenshot image showing the UI settings interface

The documentation clearly explains:

  • How to configure settings via UI vs config file
  • That UI settings override config file values
  • Settings apply immediately without restart (useful for cloud deployments)
  • Step-by-step instructions with multiple screenshots
  • Use cases for cloud deployments and debugging scenarios

All cross-references to existing documentation (config_settings.md, spend_logs_deletion.md) are valid and the new page is properly integrated into the site navigation.

Confidence Score: 5/5

  • This PR is safe to merge with no risk - it only adds documentation
  • This is a documentation-only PR with no code changes. The new documentation is well-written, comprehensive, and properly integrated. All file references and links are valid, the markdown formatting is correct, and the content follows existing documentation patterns. No functional changes to the codebase means zero risk of introducing bugs or breaking changes.
  • No files require special attention

Important Files Changed

Filename Overview
docs/my-website/docs/proxy/ui_spend_log_settings.md New comprehensive documentation for UI-based spend log settings configuration with detailed walkthrough and screenshots
docs/my-website/docs/proxy/ui_logs.md Updated to reference new UI settings page and clarify that settings can be configured via UI or config file
docs/my-website/sidebars.js Added new UI spend log settings page to sidebar navigation under UI Logs section
docs/my-website/img/ui_spend_logs_settings.png New screenshot image for UI spend log settings documentation

Sequence Diagram

sequenceDiagram
    participant User
    participant AdminUI as Admin UI
    participant Proxy as LiteLLM Proxy
    participant DB as Database
    
    User->>AdminUI: Navigate to Logs page
    User->>AdminUI: Click Settings icon
    AdminUI->>Proxy: Fetch current settings
    Proxy->>DB: Query existing config
    DB-->>Proxy: Return settings
    Proxy-->>AdminUI: Display current settings
    User->>AdminUI: Enable "Store Prompts in Spend Logs"
    User->>AdminUI: Set Retention Period (e.g., "7d")
    User->>AdminUI: Click Save Settings
    AdminUI->>Proxy: POST updated settings
    Proxy->>DB: Update config in DB
    DB-->>Proxy: Confirm update
    Proxy-->>AdminUI: Settings saved successfully
    Note over Proxy: Settings apply immediately<br/>No restart needed
    User->>Proxy: Make new API request
    Proxy->>DB: Store spend log with prompts
    Note over DB: New logs include<br/>request/response content
Loading

Copy link
Contributor

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

4 files reviewed, no comments

Edit Code Review Agent Settings | Greptile

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