PYD-1399: Add environments documentation #591
Conversation
|
|
||
| Note that by default there are system generated environments: | ||
|
|
||
| - `all envs`: Searches will include all spans with any environment set |
There was a problem hiding this comment.
@Kludex is this description of all_envs vs. not specified correct, I wasn't sure. Could it be that not specified just returns everything?
There was a problem hiding this comment.
I don't know... I was not involved in this decision. 🤷♂️
It makes sense for all envs to include not specified, but I don't know how it was implemented.
There was a problem hiding this comment.
not specified returns logs with empty env value
Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>
Deploying logfire-docs with
|
| Latest commit: |
9de9e92
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://f004cbed.logfire-docs.pages.dev |
| Branch Preview URL: | https://cs-docs-environments-feature.logfire-docs.pages.dev |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #591 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 133 133
Lines 10452 10452
Branches 1431 1431
=========================================
Hits 10452 10452 ☔ View full report in Codecov by Sentry. |
|
Not sure what's going on with the build |
| ## Can I Create an Environment in the UI? | ||
| No, you cannot create or delete set environments via the UI, instead use the SDK. |
There was a problem hiding this comment.
I wouldn't include unnecessary information. 👀
There was a problem hiding this comment.
Disagree, I think it's worth being explicit about this so people don't try and find it. There is very little downside to clarifying it.
WARNING - Doc file 'guides/advanced/using-environments.md' contains an unrecognized relative link 'docs/reference/organization-structure/', it was left as is. |
Co-authored-by: Marcelo Trylesinski <[email protected]>
Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>
Co-authored-by: Marcelo Trylesinski <[email protected]>
…gfire into cs/docs-environments-feature
Kludex
force-pushed
the
cs/docs-environments-feature
branch
2 times, most recently
from
2b17337
to
27720bc
Compare
Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>
Co-authored-by: Marcelo Trylesinski <[email protected]>
Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>
Co-authored-by: Marcelo Trylesinski <[email protected]>
Kludex
force-pushed
the
cs/docs-environments-feature
branch
from
27720bc
to
125f27c
Compare
…gfire into cs/docs-environments-feature # Conflicts: # docs/guides/advanced/using-environments.md
Co-authored-by: Marcelo Trylesinski <[email protected]>
![hyperlint-ai[bot]](https://avatars.githubusercontent.com/in/718456?s=60&v=4){kind=small}
| @@ -0,0 +1,54 @@ | |||
| As a developer, we find ourselves working on differents environments for a project: local, production, sometimes staging, and depending on your company deployment strategy... You can have even more! 😅 | |||
There was a problem hiding this comment.
| As a developer, we find ourselves working on differents environments for a project: local, production, sometimes staging, and depending on your company deployment strategy... You can have even more! 😅 | |
| As a developer, we find ourselves working on different environments for a project: local, production, sometimes staging, and depending on your company deployment strategy... You can have even more! 😅 |
Issues:
- Style Guide - (Spelling-error) Did you really mean 'differents'?
Fix Explanation:
The word 'differents' is a spelling mistake. It should be 'different' to correctly match the context of the sentence.
| As a developer, we find ourselves working on differents environments for a project: local, production, sometimes staging, and depending on your company deployment strategy... You can have even more! 😅 | ||
|
|
||
| With **Logfire** you can distinguish which environment you are sending data to. | ||
| You just need to set the the [`environment` parameter on the `logfire.configure`][logfire.configure(environment)]. |
There was a problem hiding this comment.
| You just need to set the the [`environment` parameter on the `logfire.configure`][logfire.configure(environment)]. | |
| You just need to set the [`environment` parameter on the `logfire.configure`][logfire.configure(environment)]. |
Issues:
- Style Guide - (hyperlint.repeatedWords-error) 'the' is repeated, did you mean to repeat this word?
- Style Guide - (Repetition-error) 'the' is repeated!
Fix Explanation:
The word 'the' is repeated unnecessarily. Removing the extra 'the' resolves the issue and improves the readability of the sentence.
|
|
||
| logfire.configure(environment='local') # (1)! | ||
| ``` | ||
| 1. Usually you are retriving the environment information from an environment variable. |
There was a problem hiding this comment.
| 1. Usually you are retriving the environment information from an environment variable. | |
| 1. Usually you are retrieving the environment information from an environment variable. |
Issues:
- Style Guide - (Spelling-error) Did you really mean 'retriving'?
Fix Explanation:
The word 'retriving' is a common misspelling of 'retrieving'. Correcting this spelling error improves the professionalism and clarity of the documentation.
Documents the environment feature
Edit by Marcelo: