Docs: improve overrides configuration parameter section #1326
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
KMiller-Grafana
requested review from
joe-elliott,
annanay25,
mdisibio,
dgzlopes,
mapno,
kvrhdn and
zalegrala
as code owners
joe-elliott
reviewed
Mar 7, 2022
| # - During search, traces will be skipped when they exceed this threshold. | ||
| # - During ingestion, traces that exceed this threshold will be refused. | ||
| # - During compaction, traces that exceed this threshold will be partially dropped. | ||
| # Exceeding the threshold results in errors like |
There was a problem hiding this comment.
The language "During ingestion" was there b/c that log line will only be logged when the threshold is exceeded during ingestion.
| # Tenant-specific overrides settings configuration file. See the "Tenant-specific overrides" section for an example. | ||
| [per_tenant_override_config: /conf/overrides.yaml] | ||
| # Tenant-specific overrides settings configuration file. | ||
| [per_tenant_override_config: <string> | default = "/conf/overrides.yaml"] |
There was a problem hiding this comment.
This actually defaults to an empty string which disables the feature.
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.
PR #1318 got merged in without a docs review. It had a typo. This PR was originally to fix that typo. Then I decided to correct the formatting and wording throughout the
overridessection of the configuration documentation section.A goal in injecting newlines into the definitions results in not needing a horizontal scroll bar when viewing this section's documentation.
Reviewers: please check that I corrected the definition of
per_tenant_override_configcorrectly. I believe it had only the default value listed, but not in quote marks.