Skip to content

Conversation

@strawgate
Copy link
Contributor

@strawgate strawgate commented Dec 16, 2025

Closes: #1581

  1. Integrations overview page shows a non-working example of instrumenting fastapi as instrument_fastapi requires app. https://logfire.pydantic.dev/docs/integrations/ should match https://logfire.pydantic.dev/docs/integrations/web-frameworks/fastapi/#usage
  2. Comment under "Pydantic Integration" shows output that doesnt match what the code would show (US vs USA) https://logfire.pydantic.dev/docs/why/#pydantic-integration
  3. The autotracing example for custom modules does not include the required min_duration parameter https://logfire.pydantic.dev/docs/guides/onboarding-checklist/add-auto-tracing/#filtering-modules-to-trace
  4. What should be a link to httpx is just [httpx] https://logfire.pydantic.dev/docs/how-to-guides/suppress/#suppress-scopes
  5. The "capture everything" section is not runnable as client is not available https://logfire.pydantic.dev/docs/integrations/http-clients/httpx/#capture-everything
  6. The Logfire metrics page imports Observable but uses Observation and iterable is also not imported https://logfire.pydantic.dev/docs/guides/onboarding-checklist/add-metrics/#gauge
  7. Similar to above https://logfire.pydantic.dev/docs/guides/onboarding-checklist/add-metrics/ https://logfire.pydantic.dev/docs/guides/onboarding-checklist/add-metrics/
  8. example uses both AnthropicBedrock and AmazonBedrock, i believe AnthropicBedrock is correct https://logfire.pydantic.dev/docs/integrations/llms/anthropic/#streaming-responses
  9. some garbled text, "For OpenAI, you can use the OpenAI, you can check the OpenAI documentation." https://logfire.pydantic.dev/docs/integrations/llms/llamaindex/#instrument-the-underlying-llm
  10. Logfire is typo'd https://logfire.pydantic.dev/docs/reference/self-hosted/overview/
  11. Dependent is typo'd https://logfire.pydantic.dev/docs/reference/self-hosted/scaling/
  12. A random parens ) https://logfire.pydantic.dev/docs/integrations/web-frameworks/#excluding-urls-from-instrumentation
  13. self-managed scaling documentation has a typo in the chart for the pod disruption budget minAvaliable: 1 https://logfire.pydantic.dev/docs/reference/self-hosted/scaling/#scaling-configuration
  14. jaeger misspelled twice https://logfire.pydantic.dev/docs/how-to-guides/alternative-backends/
  15. missing an is in "A metric a calculated value measuring..." in concepts.md https://logfire.pydantic.dev/docs/concepts/ is
  16. a double issues "Sort by First Seen - youngest <> oldest issues issues" in issues.md for webui https://logfire.pydantic.dev/docs/guides/web-ui/issues/ contains
  17. Enterprise is misspelled in the enterprise quickstart https://logfire.pydantic.dev/docs/reference/self-hosted/local-quickstart/

@codecov
Copy link

codecov bot commented Dec 16, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@strawgate strawgate changed the title Small fixes for logfire docs [Draft] Small fixes for logfire docs Dec 16, 2025
@strawgate strawgate changed the title [Draft] Small fixes for logfire docs Small fixes for logfire docs Dec 17, 2025
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 addresses multiple documentation issues across the Logfire documentation, including typos, incorrect code examples, missing imports, and incorrect API references. The changes improve code runnability and documentation accuracy.

  • Fixed broken code examples by adding missing imports, variables, and required parameters
  • Corrected spelling and grammar errors throughout the documentation
  • Fixed incorrect API class names and outputs to match actual behavior

Reviewed changes

Copilot reviewed 15 out of 15 changed files in this pull request and generated no comments.

Show a summary per file
File Description
docs/why.md Corrected output example to show 'USA' instead of 'US'
docs/reference/self-hosted/scaling.md Fixed typos: 'minAvaliable' → 'minAvailable' and 'depenent' → 'dependent'
docs/reference/self-hosted/overview.md Fixed product name typo: 'Logifre' → 'Logfire'
docs/reference/self-hosted/local-quickstart.md Fixed typo: 'enterpirse' → 'enterprise'
docs/integrations/web-frameworks/index.md Removed extraneous closing parenthesis
docs/integrations/llms/llamaindex.md Removed duplicate text in OpenAI documentation reference
docs/integrations/llms/anthropic.md Corrected class names from 'AmazonBedrock' to 'AnthropicBedrock'
docs/integrations/index.md Fixed FastAPI example by adding required imports and app parameter
docs/integrations/http-clients/httpx.md Added missing client instantiation to make example runnable
docs/how-to-guides/suppress.md Added missing HTTPX link reference definition
docs/how-to-guides/alternative-backends.md Fixed 'Jager' → 'Jaeger' spelling in image alt texts (2 occurrences)
docs/guides/web-ui/issues.md Removed duplicate word 'issues'
docs/guides/onboarding-checklist/add-metrics.md Added missing imports, corrected Observable → Observation, added Linux-specific warning
docs/guides/onboarding-checklist/add-auto-tracing.md Added required min_duration parameter
docs/concepts.md Fixed grammar: 'A metric a calculated' → 'A metric is a calculated'

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@alexmojaki alexmojaki merged commit a00c662 into pydantic:main Dec 17, 2025
19 checks passed
@alexmojaki
Copy link
Contributor

Thanks!

@samuelcolvin
Copy link
Member

this is amazing, thank you @strawgate!

We should definitely find a way to run all examples in this repo with pytest-examples, like we do for pydantic and pydantic-ai, even if we don't test the generated otel data - just running the examples would have caught lots of these cases.

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.

Small Documentation Issues

3 participants