improve instrumentation docs #1625
Conversation
PR Change SummaryImproved the instrumentation documentation for Logfire, enhancing clarity and usability.
Modified Files
How can I customize these reviews?Check out the Hyperlint AI Reviewer docs for more information on how to customize the review. If you just want to ignore it on this PR, you can add the Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add |
Docs Preview
|
docs/img/logfire-weather-agent.png
Outdated
There was a problem hiding this comment.
fair point about the resolution, don't know how that happened.
Is including this stuff helpful?
Why not expand the trace trees fully?
What about the tool call responses on the right?
There was a problem hiding this comment.
i think showing the full page adds helpful context.
|
|
||
| * **Debugging** — Using the live view to see what's happening in your application in real-time. | ||
| * **Monitoring** — Using SQL and dashboards to observe the behavior of your application, Logfire is effectively a SQL database that stores information about how your application is running. | ||
|
|
||
| ### Debugging |
There was a problem hiding this comment.
The video here really needs updating
|
|
||
|  | ||
|  |
There was a problem hiding this comment.
this is missing the httpx instrumentation spans
There was a problem hiding this comment.
i'm saying that it says "running the above code containing logfire.instrument_httpx will display this" and that's not what it will display
|
|
||
| agent = Agent('openai:gpt-4o', instrument=True) |
There was a problem hiding this comment.
It seems like you've removed all mentions of Agent(instrument=...) which seems extreme
There was a problem hiding this comment.
it's still in the API docs.
| from pydantic_ai.agent import Agent | ||
| from pydantic_ai.models.instrumented import InstrumentationSettings | ||
|
|
||
| os.environ['OTEL_EXPORTER_OTLP_ENDPOINT'] = 'http://localhost:4318' |
There was a problem hiding this comment.
I understand it might still be worth showing this this way, but I just want to point out that:
OTLPSpanExporteruses that value by default anywayOTLPSpanExporter(endpoint=...)can be used instead of an env var
Co-authored-by: Alex Hall <[email protected]>
No description provided.