Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pydantic/logfire
Uncomplicated Observability for Python and beyond! 🪵🔥
https://github.com/pydantic/logfire
fastapi logging metri observability openai opentelemetry pydantic python trace
Last synced: 28 days ago
JSON representation
Uncomplicated Observability for Python and beyond! 🪵🔥
- Host: GitHub
- URL: https://github.com/pydantic/logfire
- Owner: pydantic
- License: mit
- Created: 2024-04-23T11:50:23.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-05-23T06:00:45.000Z (6 months ago)
- Last Synced: 2024-05-23T08:00:30.631Z (6 months ago)
- Topics: fastapi, logging, metri, observability, openai, opentelemetry, pydantic, python, trace
- Language: Python
- Homepage: https://docs.pydantic.dev/logfire/
- Size: 27.5 MB
- Stars: 1,391
- Watchers: 14
- Forks: 41
- Open Issues: 40
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Roadmap: docs/roadmap.md
Awesome Lists containing this project
- awesome-ChatGPT-repositories - logfire - Uncomplicated Observability for Python and beyond! 🪵🔥 (Openai)
README
# Pydantic Logfire — Uncomplicated Observability
[](https://github.com/pydantic/logfire/actions?query=event%3Apush+branch%3Amain+workflow%3ACI)
[](https://codecov.io/gh/pydantic/logfire)
[](https://pypi.python.org/pypi/logfire)
[](https://github.com/pydantic/logfire/blob/main/LICENSE)
[](https://github.com/pydantic/logfire)
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.
What sets Logfire apart:
- **Simple and Powerful:** Logfire's dashboard is simple relative to the power it provides, ensuring your entire engineering team will actually use it.
- **Python-centric Insights:** From rich display of Python objects, to event-loop telemetry, to profiling Python code and database queries, Logfire gives you unparalleled visibility into your Python application's behavior.
- **SQL:** Query your data using standard SQL — all the control and (for many) nothing new to learn. Using SQL also means you can query your data with existing BI tools and database querying libraries.
- **OpenTelemetry:** Logfire is an opinionated wrapper around OpenTelemetry, allowing you to leverage existing tooling, infrastructure, and instrumentation for many common Python packages, and enabling support for virtually any language.
- **Pydantic Integration:** Understand the data flowing through your Pydantic models and get built-in analytics on validations.
See the [documentation](https://logfire.pydantic.dev/docs/) for more information.
**Feel free to report issues and ask any questions about Logfire in this repository!**
This repo contains the Python SDK for `logfire` and documentation; the server application for recording and displaying data is closed source.
## Using Logfire
This is a very brief overview of how to use Logfire, the [documentation](https://logfire.pydantic.dev/docs/) has much more detail.
### Install
```bash
pip install logfire
```
[_(learn more)_](https://logfire.pydantic.dev/docs/guides/first_steps/#install)
## Authenticate
```bash
logfire auth
```
[_(learn more)_](https://logfire.pydantic.dev/docs/guides/first_steps/#authentication)
### Manual tracing
Here's a simple manual tracing (aka logging) example:
```python
import logfire
from datetime import date
logfire.info('Hello, {name}!', name='world')
with logfire.span('Asking the user their {question}', question='age'):
user_input = input('How old are you [YYYY-mm-dd]? ')
dob = date.fromisoformat(user_input)
logfire.debug('{dob=} {age=!r}', dob=dob, age=date.today() - dob)
```
[_(learn more)_](https://logfire.pydantic.dev/docs/guides/onboarding-checklist/add-manual-tracing/)
### Integration
Or you can also avoid manual instrumentation and instead integrate with [lots of popular packages](https://logfire.pydantic.dev/docs/integrations/), here's an example of integrating with FastAPI:
```py
import logfire
from pydantic import BaseModel
from fastapi import FastAPI
app = FastAPI()
logfire.configure()
logfire.instrument_fastapi(app)
# next, instrument your database connector, http library etc. and add the logging handler
class User(BaseModel):
name: str
country_code: str
@app.post('/')
async def add_user(user: User):
# we would store the user here
return {'message': f'{user.name} added'}
```
[_(learn more)_](https://logfire.pydantic.dev/docs/integrations/fastapi/)
Logfire gives you a view into how your code is running like this:
## Contributing
We'd love anyone interested to contribute to the Logfire SDK and documentation, see the [contributing guide](https://github.com/pydantic/logfire/blob/main/CONTRIBUTING.md).
## Reporting a Security Vulnerability
See our [security policy](https://github.com/pydantic/logfire/security).