mkdocs.yml

site_name: Pydantic Logfire Documentation
site_description: Pydantic Logfire Documentation
strict: true
site_url: https://logfire.pydantic.dev/docs

repo_name: pydantic/logfire
repo_url: https://github.com/pydantic/logfire
edit_uri: edit/main/docs/

copyright: © Pydantic Services Inc. 2024 to present
extra:
  # hide the "Made with Material for MkDocs" message
  generator: false

theme:
  name: "material"
  custom_dir: "docs/overrides"
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/lightbulb-outline
        name: "Switch to dark mode"
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/lightbulb
        name: "Switch to light mode"
  features:
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - navigation.indexes # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#section-index-pages
    - navigation.path
    - navigation.sections
    - navigation.instant
    - navigation.instant.preview
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.tracking
    - navigation.top # alternatively, we could do navigation.tabs.sticky
    - toc.follow
  logo: "logo-white.svg"
  favicon: "favicon.png"

# https://www.mkdocs.org/user-guide/configuration/#validation
validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn

extra_css:
  - "extra/tweaks.css"

# used for analytics
extra_javascript:
  - "/flarelytics/client.js"
  - "https://cdn.jsdelivr.net/npm/algoliasearch@5.20.0/dist/lite/builds/browser.umd.js"
  - "https://cdn.jsdelivr.net/npm/instantsearch.js@4.77.3/dist/instantsearch.production.min.js"
  - "javascripts/algolia-search.js"

nav:
  - Getting Started:
      - Logfire: index.md
      - Why Logfire?: why.md
      - Concepts: concepts.md
      - Get Help: help.md
      - Onboarding Checklist:
          - Onboarding Checklist: guides/onboarding-checklist/index.md
          - Integrate Logfire: guides/onboarding-checklist/integrate.md
          - Add Logfire Manual Tracing: guides/onboarding-checklist/add-manual-tracing.md
          - Add Logfire Auto-Tracing: guides/onboarding-checklist/add-auto-tracing.md
          - Add Logfire Metrics: guides/onboarding-checklist/add-metrics.md
      - Web UI:
          - Live View: guides/web-ui/live.md
          - Dashboards: guides/web-ui/dashboards.md
          - Alerts (Beta): guides/web-ui/alerts.md
          - Saved Searches: guides/web-ui/saved-searches.md
          - SQL Explorer: guides/web-ui/explore.md
  - Understanding your Usage: logfire-costs.md
  - How To - Guides:
      - Create Write Tokens: how-to-guides/create-write-tokens.md
      - Use different environments: how-to-guides/environments.md
      - Convert to Organization: how-to-guides/convert-to-organization.md
      - Link to Code Source: how-to-guides/link-to-code-source.md
      - Use Alternative Clients: how-to-guides/alternative-clients.md
      - Use Alternative Backends: how-to-guides/alternative-backends.md
      - Implement Sampling Strategies: how-to-guides/sampling.md
      - Export your Logfire Data: how-to-guides/query-api.md
      - Scrub Sensitive Data: how-to-guides/scrubbing.md
      - Trace across Multiple Services: how-to-guides/distributed-tracing.md
      - Detect Service is Down: how-to-guides/detect-service-is-down.md
      - Suppress Spans and Metrics: how-to-guides/suppress.md
      - OpenTelemetry Collector: how-to-guides/otel-collector.md
      - Collect Metrics from your Cloud Provider: how-to-guides/cloud-metrics.md
      - Connect to the MCP Server: how-to-guides/mcp-server.md
      - Setup Slack Alerts: how-to-guides/setup-slack-alerts.md
  - Integrations:
      - Integrations: integrations/index.md
      - LLMs:
          - PydanticAI: integrations/llms/pydanticai.md
          - OpenAI: integrations/llms/openai.md
          - Anthropic: integrations/llms/anthropic.md
          - LangChain: integrations/llms/langchain.md
          - LLamaIndex: integrations/llms/llamaindex.md
          - Mirascope: integrations/llms/mirascope.md
          - LiteLLM: integrations/llms/litellm.md
          - Magentic: integrations/llms/magentic.md
      - Web Frameworks:
          - Web Frameworks: integrations/web-frameworks/index.md
          - FastAPI: integrations/web-frameworks/fastapi.md
          - Django: integrations/web-frameworks/django.md
          - Flask: integrations/web-frameworks/flask.md
          - Starlette: integrations/web-frameworks/starlette.md
          - AIOHTTP: integrations/web-frameworks/aiohttp.md
          - ASGI: integrations/web-frameworks/asgi.md
          - WSGI: integrations/web-frameworks/wsgi.md
          - Gunicorn: integrations/web-frameworks/gunicorn.md
      - JavaScript:
          - JavaScript: integrations/javascript/index.md
          - Browser: integrations/javascript/browser.md
          - Next.js: integrations/javascript/nextjs.md
          - Cloudflare: integrations/javascript/cloudflare.md
          - Express: integrations/javascript/express.md
          - Node.js: integrations/javascript/node.md
          - Deno: integrations/javascript/deno.md
      - Databases:
          - Psycopg: integrations/databases/psycopg.md
          - SQLAlchemy: integrations/databases/sqlalchemy.md
          - Asyncpg: integrations/databases/asyncpg.md
          - PyMongo: integrations/databases/pymongo.md
          - MySQL: integrations/databases/mysql.md
          - SQLite3: integrations/databases/sqlite3.md
          - Redis: integrations/databases/redis.md
          - BigQuery: integrations/databases/bigquery.md
      - HTTP Clients:
          - HTTPX: integrations/http-clients/httpx.md
          - Requests: integrations/http-clients/requests.md
          - AIOHTTP: integrations/http-clients/aiohttp.md
      - Event Streams:
          - Airflow: integrations/event-streams/airflow.md
          - FastStream: integrations/event-streams/faststream.md
          - Celery: integrations/event-streams/celery.md
      - Logging:
          - Logging: integrations/logging.md
          - Structlog: integrations/structlog.md
          - Loguru: integrations/loguru.md
      - Pydantic: integrations/pydantic.md
      - System Metrics: integrations/system-metrics.md
      - Stripe: integrations/stripe.md
      - AWS Lambda: integrations/aws-lambda.md
  - Reference:
      - SQL: reference/sql.md
      - Advanced:
          - Baggage: reference/advanced/baggage.md
          - Generators: reference/advanced/generators.md
          - Testing: reference/advanced/testing.md
      - Examples: reference/examples.md
      - Configuration: reference/configuration.md
      - Data Regions: reference/data-regions.md
      - Organization Structure: reference/organization-structure.md
      - Self-Hosted Deployment: reference/self-hosted.md
      - SDK CLI: reference/cli.md
      - SDK API:
          - Logfire: reference/api/logfire.md
          - Testing: reference/api/testing.md
          - Sampling: reference/api/sampling.md
          - Propagate: reference/api/propagate.md
          - Exceptions: reference/api/exceptions.md
          - Pydantic: reference/api/pydantic.md
  - Roadmap: roadmap.md
  - Languages: languages.md
  - Enterprise: enterprise.md
  - Compliance: compliance.md
  - Release Notes: release-notes.md

markdown_extensions:
  - tables
  - toc:
      permalink: true
      title: Page contents
      # this only affects `/legal/` since (at time of change) there are no `h5` in the rest of the docs
      toc_depth: 4
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.details
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.mark
  - pymdownx.superfences
  - pymdownx.snippets
  - pymdownx.tilde
  - pymdownx.highlight:
      pygments_lang_class: true
  - pymdownx.extra:
      pymdownx.superfences:
        custom_fences:
          - name: mermaid
            class: mermaid
            format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - sane_lists # this means you can start a list from any number

watch:
  - logfire

plugins:
  - search
  - glightbox
  - mkdocstrings:
      handlers:
        python:
          paths: [src/packages/logfire/logfire]
          options:
            members_order: source
            separate_signature: true
            filters: ['!^_']
            docstring_options:
              ignore_init_summary: true
            merge_init_into_class: true
            parameter_headings: true
            show_signature_annotations: true
            signature_crossrefs: true
          import:
            - url: https://docs.python.org/3/objects.inv
            - url: https://docs.pydantic.dev/latest/objects.inv
            - url: https://fastapi.tiangolo.com/objects.inv
            - url: https://opentelemetry-python-contrib.readthedocs.io/en/latest/objects.inv
            - url: https://opentelemetry-python.readthedocs.io/en/latest/objects.inv
            - url: https://requests.readthedocs.io/en/latest/objects.inv
            - url: https://typing-extensions.readthedocs.io/en/latest/objects.inv
            - url: https://rich.readthedocs.io/en/stable/objects.inv
            - url: https://faststream.airt.ai/latest/objects.inv
            - url: https://redis.readthedocs.io/en/stable/objects.inv
            - url: https://pymongo.readthedocs.io/en/stable/objects.inv
  - redirects:
      redirect_maps:
        "guides/first_steps/index.md": "index.md"
        "guides/onboarding_checklist/index.md": "guides/onboarding-checklist/index.md"
        "guides/onboarding_checklist/integrate.md": "guides/onboarding-checklist/integrate.md"
        "guides/onboarding_checklist/add_manual_tracing.md": "guides/onboarding-checklist/add-manual-tracing.md"
        "guides/onboarding_checklist/add_auto_tracing.md": "guides/onboarding-checklist/add-auto-tracing.md"
        "guides/web_ui/index.md": "guides/web-ui/live.md"
        "guides/web-ui/index.md": "guides/web-ui/live.md"
        "guides/web_ui/live.md": "guides/web-ui/live.md"
        "guides/web_ui/dashboards.md": "guides/web-ui/dashboards.md"
        "guides/web_ui/alerts.md": "guides/web-ui/alerts.md"
        "guides/web_ui/explore.md": "guides/web-ui/explore.md"
        "guides/advanced/generators.md": "reference/advanced/generators.md"
        "guides/advanced/testing.md": "reference/advanced/testing.md"
        "guides/advanced/query_api.md": "how-to-guides/query-api.md"
        "guides/advanced/query-api.md": "how-to-guides/query-api.md"
        "guides/advanced/scrubbing.md": "how-to-guides/scrubbing.md"
        "guides/advanced/sampling.md": "how-to-guides/sampling.md"
        "guides/advanced/alternative-clients.md": "how-to-guides/alternative-clients.md"
        "guides/advanced/link-to-code-source.md": "how-to-guides/link-to-code-source.md"
        "guides/advanced/alternative_backends.md": "how-to-guides/alternative-backends.md"
        "guides/advanced/alternative-backends.md": "how-to-guides/alternative-backends.md"
        "guides/advanced/creating_write_tokens.md": "how-to-guides/create-write-tokens.md"
        "guides/advanced/creating-write-tokens.md": "how-to-guides/create-write-tokens.md"
        "guides/advanced/index.md": "how-to-guides/environments.md"
        "guides/advanced/environments.md": "how-to-guides/environments.md"
        "integrations/system_metrics.md": "integrations/system-metrics.md"
        "integrations/third_party/index.md": "integrations/index.md"
        "integrations/third-party/index.md": "integrations/index.md"
        "integrations/third_party/mirascope.md": "integrations/llms/mirascope.md"
        "integrations/third_party/litellm.md": "integrations/llms/litellm.md"
        "integrations/third-party/litellm.md": "integrations/llms/litellm.md"
        "integrations/third-party/mirascope.md": "integrations/llms/mirascope.md"
        "integrations/third_party/magentic.md": "integrations/llms/magentic.md"
        "integrations/use_cases/web_frameworks.md": "integrations/web-frameworks/index.md"
        "integrations/use-cases/web_frameworks.md": "integrations/web-frameworks/index.md"
        "integrations/fastapi.md": "integrations/web-frameworks/fastapi.md"
        "integrations/django.md": "integrations/web-frameworks/django.md"
        "integrations/flask.md": "integrations/web-frameworks/flask.md"
        "integrations/starlette.md": "integrations/web-frameworks/starlette.md"
        "integrations/asgi.md": "integrations/web-frameworks/asgi.md"
        "integrations/wsgi.md": "integrations/web-frameworks/wsgi.md"
        "integrations/psycopg.md": "integrations/databases/psycopg.md"
        "integrations/sqlalchemy.md": "integrations/databases/sqlalchemy.md"
        "integrations/asyncpg.md": "integrations/databases/asyncpg.md"
        "integrations/pymongo.md": "integrations/databases/pymongo.md"
        "integrations/mysql.md": "integrations/databases/mysql.md"
        "integrations/sqlite3.md": "integrations/databases/sqlite3.md"
        "integrations/redis.md": "integrations/databases/redis.md"
        "integrations/bigquery.md": "integrations/databases/bigquery.md"
        "integrations/httpx.md": "integrations/http-clients/httpx.md"
        "integrations/requests.md": "integrations/http-clients/requests.md"
        "integrations/aiohttp.md": "integrations/http-clients/aiohttp.md"
        "integrations/airflow.md": "integrations/event-streams/airflow.md"
        "integrations/faststream.md": "integrations/event-streams/faststream.md"
        "integrations/celery.md": "integrations/event-streams/celery.md"
        "integrations/openai.md": "integrations/llms/openai.md"
        "integrations/anthropic.md": "integrations/llms/anthropic.md"
        "reference/organization_structure.md": "reference/organization-structure.md"
        "legal/service_level_agreement.md": "https://pydantic.dev/legal/terms-of-service"
        "legal/terms_of_service.md": "https://pydantic.dev/legal/terms-of-service"
        "legal/data_processing_addendum.md": "https://pydantic.dev/legal/data-processing-addendum"
        "legal/cloud_subprocessors.md": "https://pydantic.dev/legal/cloud-subprocessors"
        "legal/terms-of-service.md": "https://pydantic.dev/legal/terms-of-service"
        "legal/privacy.md": "https://pydantic.dev/legal/privacy-policy"
        "legal/data-processing-addendum.md": "https://pydantic.dev/legal/data-processing-addendum"
        "legal/cloud-subprocessors.md": "https://pydantic.dev/legal/cloud-subprocessors"
        "release_notes.md": "release-notes.md"
        "examples.md": "reference/examples.md"
        "reference.md": "reference/examples.md"
        "api/logfire.md": "reference/api/logfire.md"
        "api/testing.md": "reference/api/testing.md"
        "api/propagate.md": "reference/api/propagate.md"
        "api/exceptions.md": "reference/api/exceptions.md"
        "api/sampling.md": "reference/api/sampling.md"
        "api/integrations/structlog.md": "reference/api/logfire.md#logfire.StructlogProcessor"
        "api/integrations/pydantic.md": "reference/api/pydantic.md"
        "api/integrations/logging.md": "reference/api/logfire.md#logfire.LogfireLoggingHandler"
        "guides/onboarding_checklist/add_metrics.md": "guides/onboarding-checklist/add-metrics.md"
        "guides/index.md": "index.md"
        "why-logfire/index.md": "why.md"
        "why-logfire/pydantic.md": "why.md"
        "why-logfire/opentelemetry.md": "why.md"
        "why-logfire/simplicity.md": "why.md"
        "why-logfire/python-centric.md": "why.md"
        "why-logfire/sql.md": "why.md"
        "get-started/traces.md": "concepts.md"
  - llmstxt:
      enabled: !ENV [CI, false]
      full_output: llms-full.txt
      markdown_description: |-
        From the team behind Pydantic, Logfire is an observability platform built on the same belief as our
        open source library — that the most powerful tools can be easy to use.
      sections:
        General:
          - index.md
          - why.md
          - concepts.md
        How To - Guides:
          - guides/*/*.md
          - how-to-guides/*.md
        Integrations:
          - integrations/*.md
          - integrations/*/*.md
        Optional:
          - roadmap.md
          - release-notes.md
hooks:
  - docs/plugins/main.py
  - docs/plugins/algolia.py