-
Notifications
You must be signed in to change notification settings - Fork 65
/
mkdocs.yml
263 lines (252 loc) · 10.6 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
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
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.expand
- navigation.indexes
- navigation.path
- navigation.tabs
- navigation.instant
- navigation.instant.preview
- navigation.instant.prefetch
- navigation.instant.progress
- navigation.sections
- 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"
nav:
- Why Logfire?:
- Introducing Logfire: why-logfire/index.md
- Simplicity and Power: why-logfire/simplicity.md
- Python-centric Insights: why-logfire/python-centric.md
- Pydantic Integration: why-logfire/pydantic.md
- OpenTelemetry: why-logfire/opentelemetry.md
- Structured Data and SQL: why-logfire/sql.md
- Get Started:
- Get Started: index.md
- Tracing with Spans: get-started/traces.md
- Guides:
- Guides: guides/index.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:
- Intro to the Web UI: guides/web-ui/index.md
- Live View: guides/web-ui/live.md
- Dashboards: guides/web-ui/dashboards.md
- Alerts (Beta): guides/web-ui/alerts.md
- SQL Explorer: guides/web-ui/explore.md
- Advanced User Guide:
- Advanced User Guide: guides/advanced/index.md
- Alternative Clients: guides/advanced/alternative-clients.md
- Alternative Backends: guides/advanced/alternative-backends.md
- Sampling: guides/advanced/sampling.md
- Scrubbing: guides/advanced/scrubbing.md
- Generators: guides/advanced/generators.md
- Creating Write Tokens: guides/advanced/creating-write-tokens.md
- Query API: guides/advanced/query-api.md
- Link to Code Source: guides/advanced/link-to-code-source.md
- Testing: guides/advanced/testing.md
- Backfill: guides/advanced/backfill.md
- Integrations:
- Integrations: integrations/index.md
- OpenTelemetry:
- FastAPI: integrations/fastapi.md
- Django: integrations/django.md
- Flask: integrations/flask.md
- Starlette: integrations/starlette.md
- ASGI: integrations/asgi.md
- WSGI: integrations/wsgi.md
- HTTPX: integrations/httpx.md
- Requests: integrations/requests.md
- AIOHTTP: integrations/aiohttp.md
- SQLAlchemy: integrations/sqlalchemy.md
- Asyncpg: integrations/asyncpg.md
- Psycopg: integrations/psycopg.md
- PyMongo: integrations/pymongo.md
- MySQL: integrations/mysql.md
- Redis: integrations/redis.md
- BigQuery: integrations/bigquery.md
- Celery: integrations/celery.md
- Stripe: integrations/stripe.md
- System Metrics: integrations/system-metrics.md
- Custom:
- Pydantic: integrations/pydantic.md
- OpenAI: integrations/openai.md
- Anthropic: integrations/anthropic.md
- Logging:
- Logging: integrations/logging.md
- Structlog: integrations/structlog.md
- Loguru: integrations/loguru.md
- Third Party:
- Third Party: integrations/third-party/index.md
- Mirascope: integrations/third-party/mirascope.md
- LiteLLM: integrations/third-party/litellm.md
- Use Cases:
- Web Frameworks: integrations/use-cases/web-frameworks.md
- Reference:
- Examples: reference/examples.md
- Configuration: reference/configuration.md
- Organization Structure: reference/organization-structure.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
- Help: help.md
- Roadmap: roadmap.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
- 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/index.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/alternative_backends.md": "guides/advanced/alternative-backends.md"
"guides/advanced/creating_write_tokens.md": "guides/advanced/creating-write-tokens.md"
"integrations/system_metrics.md": "integrations/system-metrics.md"
"integrations/third_party/index.md": "integrations/third-party/index.md"
"integrations/third_party/mirascope.md": "integrations/third-party/mirascope.md"
"integrations/third_party/litellm.md": "integrations/third-party/litellm.md"
"integrations/use_cases/web_frameworks.md": "integrations/use-cases/web-frameworks.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/advanced/query_api.md": "guides/advanced/query-api.md"
hooks:
- docs/plugins/main.py