Skip to content

Commit fd81b1b

Browse files
authored
docs: fixing some Vale linter errors (#15212) (#15259)
1 parent 42d2de1 commit fd81b1b

File tree

3 files changed

+203
-202
lines changed

3 files changed

+203
-202
lines changed

docs/sources/configure/bp-configure.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ weight: 100
66
---
77
# Configuration best practices
88

9-
Grafana Loki is under active development, and we are constantly working to improve performance. But here are some of the most current best practices for configuration that will give you the best experience with Loki.
9+
Grafana Loki is under active development, and the Loki team is constantly working to improve performance. But here are some of the most current best practices for configuration that will give you the best experience with Loki.
1010

1111
## Configure caching
1212

@@ -36,7 +36,7 @@ If Loki received these two lines which are for the same stream, everything would
3636
{job="syslog"} 00:00:01 i'm a syslog! <- Rejected out of order!
3737
```
3838

39-
What can we do about this? What if this was because the sources of these logs were different systems? We can solve this with an additional label which is unique per system:
39+
What can you do about this? What if this was because the sources of these logs were different systems? You can solve this with an additional label which is unique per system:
4040

4141
```
4242
{job="syslog", instance="host1"} 00:00:00 i'm a syslog!
@@ -56,9 +56,9 @@ Using `chunk_target_size` instructs Loki to try to fill all chunks to a target _
5656

5757
Other configuration variables affect how full a chunk can get. Loki has a default `max_chunk_age` of 2h and `chunk_idle_period` of 30m to limit the amount of memory used as well as the exposure of lost logs if the process crashes.
5858

59-
Depending on the compression used (we have been using snappy which has less compressibility but faster performance), you need 5-10x or 7.5-10MB of raw log data to fill a 1.5MB chunk. Remembering that a chunk is per stream, the more streams you break up your log files into, the more chunks that sit in memory, and the higher likelihood they get flushed by hitting one of those timeouts mentioned above before they are filled.
59+
Depending on the compression used (Loki has been using snappy which has less compressibility but faster performance), you need 5-10x or 7.5-10MB of raw log data to fill a 1.5MB chunk. Remembering that a chunk is per stream, the more streams you break up your log files into, the more chunks that sit in memory, and the higher likelihood they get flushed by hitting one of those timeouts mentioned above before they are filled.
6060

61-
Lots of small, unfilled chunks negatively affect Loki. We are always working to improve this and may consider a compactor to improve this in some situations. But, in general, the guidance should stay about the same: try your best to fill chunks.
61+
Lots of small, unfilled chunks negatively affect Loki. The team is always working to improve this and may consider a compactor to improve this in some situations. But, in general, the guidance should stay about the same: try your best to fill chunks.
6262

6363
If you have an application that can log fast enough to fill these chunks quickly (much less than `max_chunk_age`), then it becomes more reasonable to use dynamic labels to break that up into separate streams.
6464

@@ -68,4 +68,4 @@ Loki and Promtail have flags which will dump the entire config object to stderr
6868

6969
`-print-config-stderr` works well when invoking Loki from the command line, as you can get a quick output of the entire Loki configuration.
7070

71-
`-log-config-reverse-order` is the flag we run Loki with in all our environments. The configuration entries are reversed, so that the order of the configuration reads correctly top to bottom when viewed in Grafana's Explore.
71+
`-log-config-reverse-order` is the flag Grafana runs Loki with in all our environments. The configuration entries are reversed, so that the order of the configuration reads correctly top to bottom when viewed in Grafana's Explore.

docs/sources/configure/storage.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ When a new schema is released and you want to gain the advantages it provides, y
193193

194194
First, you'll want to create a new [period_config](https://grafana.com/docs/loki/<LOKI_VERSION>/configure/#period_config) entry in your [schema_config](https://grafana.com/docs/loki/<LOKI_VERSION>/configure/#schema_config). The important thing to remember here is to set this at some point in the _future_ and then roll out the config file changes to Loki. This allows the table manager to create the required table in advance of writes and ensures that existing data isn't queried as if it adheres to the new schema.
195195

196-
As an example, let's say it's 2023-07-14 and we want to start using the `v13` schema on the 20th:
196+
As an example, let's say it's 2023-07-14 and you want to start using the `v13` schema on the 20th:
197197

198198
```yaml
199199
schema_config:
@@ -214,7 +214,7 @@ schema_config:
214214
period: 24h
215215
```
216216

217-
It's that easy; we just created a new entry starting on the 20th.
217+
It's that easy; you just created a new entry starting on the 20th.
218218

219219
## Retention
220220

@@ -485,7 +485,7 @@ schema_config:
485485

486486
### On premise deployment (MinIO Single Store)
487487

488-
We configure MinIO by using the AWS config because MinIO implements the S3 API:
488+
You configure MinIO by using the AWS config because MinIO implements the S3 API:
489489

490490
```yaml
491491
storage_config:

0 commit comments

Comments
 (0)