Add documentation for the Logfire Query API #405
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Kludex
reviewed
Aug 29, 2024
Kludex
reviewed
Aug 29, 2024
Deploying logfire-docs with
|
| Latest commit: |
04b3a18
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://77217d26.logfire-docs.pages.dev |
| Branch Preview URL: | https://dmontagu-read-tokens-docs.logfire-docs.pages.dev |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #405 +/- ##
==========================================
Coverage 100.00% 100.00%
==========================================
Files 128 130 +2
Lines 9355 9499 +144
Branches 1217 1230 +13
==========================================
+ Hits 9355 9499 +144 ☔ View full report in Codecov by Sentry. |
alexmojaki
reviewed
Aug 29, 2024
![hyperlint-ai[bot]](https://avatars.githubusercontent.com/in/718456?s=60&v=4){kind=small}
|
Should I block this bot from the organization? |
dmontagu
changed the title
bllchmbrs
reviewed
Aug 30, 2024
There was a problem hiding this comment.
style_guide_test.md review details
Line Edit Problems/Proposals
Note: The following 3 comments are grouped by line.
Line 3
Existing text:
# This ia a test file
Issues:
- Style Guide - (Spelling-error) Did you really mean 'ia'?
Line 5
Existing text:
it will flag errors like on pydantic.
Issues:
- Style Guide - (Terms-error) Use 'Pydantic' instead of 'pydantic'.
Line 11
Existing text:
This is is an issue.
Issues:
- Style Guide - (Repetition-error) 'is' is repeated!
- Style Guide - (hyperlint.repeatedWords-error) 'is' is repeated, did you mean to repeat this word?
There was a problem hiding this comment.
style_guide_test.md review details
Line Edit Problems/Proposals
Note: The following 3 comments are grouped by line.
Line 3
Existing text:
# This ia a test file
Issues:
- Style Guide - (Spelling-error) Did you really mean 'ia'?
Line 5
Existing text:
it will flag errors like on pydantic.
Issues:
- Style Guide - (Terms-error) Use 'Pydantic' instead of 'pydantic'.
Line 11
Existing text:
This is is an issue.
Issues:
- Style Guide - (Repetition-error) 'is' is repeated!
- Style Guide - (hyperlint.repeatedWords-error) 'is' is repeated, did you mean to repeat this word?
|
|
||
| If no `Accept` header is provided, the default response format is JSON. | ||
|
|
||
| - **Query Parameters**: |
There was a problem hiding this comment.
this doesn't render properly
There was a problem hiding this comment.
and sql needs to be included.
| # Set the headers for authentication | ||
| headers = { | ||
| 'Authorization': f'Bearer {read_token}', | ||
| 'Content-Type': 'application/json' |
There was a problem hiding this comment.
This needs to be Accept, not Content-Type
| - `application/vnd.apache.arrow.stream`: Returns the data in Apache Arrow format, suitable for high-performance data processing. | ||
| - `text/csv`: Returns the data in CSV format, which is easy to use with many data tools. | ||
|
|
||
| If no `Accept` header is provided, the default response format is JSON. |
dmontagu
added a commit
that referenced
this pull request
Sep 27, 2024
petyosi
pushed a commit
that referenced
this pull request
Oct 1, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Query API
Logfire now provides a web API for programmatically running arbitrary SQL queries against the data in your Logfire projects.
This API can be used to retrieve data for export, analysis, or integration with other tools, allowing you to leverage
your data in a variety of ways.
The API is available at
https://logfire-api.pydantic.dev/v1/queryand requires a read token for authentication.You will be soon able to generate read tokens from the Logfire web interface (this is described in more detail in the docs added in this PR).
The API can return data in various formats, including JSON, Apache Arrow, and CSV.
Changes in this PR:
This PR adds documentation of how to make HTTP requests to this API directly, and also adds sync and async clients in
logfire.experimental.query_clientto make it convenient to write code leveraging these APIs from python.The clients are being included under the
logfire.experimentalnamespace for now to indicate that they may be subject to breaking changes, though we do not have any such changes planned at this time and will try to avoid them as much as possible.