docs: explain language insights and config mechanisms #280
Conversation
This file contains hidden or 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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
camdencheek
approved these changes
Apr 26, 2024
Comment on lines
+76
to
+97
| ### Concurrent Requests | ||
|
|
||
| This concurrent requests to the gitserver are configurable through the `GET_INVENTORY_GIT_SERVER_CONCURRENCY` environment variable ([#62011](https://github.com/sourcegraph/sourcegraph/pull/62011)). | ||
| We recommend increasing this carefully, as an increase in concurrency may cause the gitserver to become overloaded and slow down responses. | ||
|
|
||
| Example: | ||
|
|
||
| ``` | ||
| GET_INVENTORY_GIT_SERVER_CONCURRENCY=4 | ||
| ``` | ||
|
|
||
| To understand how this configuration impacts your language stats queries you can use [tracing](/admin/observability/tracing). | ||
|
|
||
| ### Language Stats Timeout | ||
|
|
||
| The timeout in minutes for language stats queries is configurable through the `GET_INVENTORY_TIMEOUT` environment variable ([#62011](https://github.com/sourcegraph/sourcegraph/pull/62011)). | ||
|
|
||
| Example: | ||
|
|
||
| ``` | ||
| GET_INVENTORY_TIMEOUT=5 | ||
| ``` |
There was a problem hiding this comment.
I'm not positive we want to be advertising these env vars. Generally, env vars are so we can have escape hatches in case of emergency, but we don't really want customers to be messing with them without help from support. I think it's probably fine to leave this section with the "reach out to Sourcegraph support"
There was a problem hiding this comment.
If we drop the section here, I'd like to figure out a place where our support engineers can discover this info by themselves. Where would we document this for our support folks?
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.
This PR updates the documentation as a follow-up to https://github.com/sourcegraph/sourcegraph/pull/62011 where we introduced new environment variables and improved the performance of language stats insights.