Skip to content

Commit 62b27ec

Browse files
authored
Spelling fixes, Markdown standard (#523)
1 parent 9859302 commit 62b27ec

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+685
-724
lines changed

app/vlinsert/insertutil/line_reader.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ func (lr *LineReader) skipUntilNextLine() (bool, int) {
151151
// Include skipped bytes before \n, including the newline itself.
152152
skipSizeBytes += n + 1 - len(lr.buf)
153153
// Include \n in the buf, so too long line is replaced with an empty line.
154-
// This is needed for maintaining synchorinzation consistency between lines
154+
// This is needed for maintaining synchronization consistency between lines
155155
// in protocols such as Elasticsearch bulk import.
156156
lr.buf = append(lr.buf[:0], lr.buf[n:]...)
157157
return true, skipSizeBytes

app/vlinsert/loki/loki.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ func getCommonParams(r *http.Request) (*commonParams, error) {
7575
if rv := httputil.GetRequestValue(r, "disable_message_parsing", "VL-Loki-Disable-Message-Parsing"); rv != "" {
7676
bv, err := strconv.ParseBool(rv)
7777
if err != nil {
78-
return nil, fmt.Errorf("cannot parse dusable_message_parsing=%q: %s", rv, err)
78+
return nil, fmt.Errorf("cannot parse disable_message_parsing=%q: %s", rv, err)
7979
}
8080
parseMessage = !bv
8181
}

app/vlogscli/main.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ var (
3939
projectID = flag.Int("projectID", 0, "Project ID to query; see https://docs.victoriametrics.com/victorialogs/#multitenancy")
4040

4141
username = flag.String("username", "", "Optional basic auth username to use for the -datasource.url")
42-
password = flagutil.NewPassword("password", "Optional basic auth password to use for the -datsource.url")
42+
password = flagutil.NewPassword("password", "Optional basic auth password to use for the -datasource.url")
4343
bearerToken = flagutil.NewPassword("bearerToken", "Optional bearer auth token to use for the -datasource.url")
4444

4545
tlsCAFile = flag.String("tlsCAFile", "", "Optional path to TLS CA file to use for verifying connections to the -datasource.url. By default, system CA is used")

app/vlselect/logsql/logsql.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1137,7 +1137,7 @@ func parseCommonArgs(r *http.Request) (*logstorage.Query, []logstorage.TenantID,
11371137
// Extract tenantID
11381138
tenantID, err := logstorage.GetTenantIDFromRequest(r)
11391139
if err != nil {
1140-
return nil, nil, fmt.Errorf("cannot obtain tenanID: %w", err)
1140+
return nil, nil, fmt.Errorf("cannot obtain tenantID: %w", err)
11411141
}
11421142
tenantIDs := []logstorage.TenantID{tenantID}
11431143

app/vlselect/logsql/logsql_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ func TestParseExtraFilters_Failure(t *testing.T) {
4646
f(`[1,2]`)
4747
f(`{"foo":[1]}`)
4848

49-
// Invliad LogsQL filter
49+
// Invalid LogsQL filter
5050
f(`foo:(bar`)
5151

5252
// excess pipe
@@ -95,7 +95,7 @@ func TestParseExtraStreamFilters_Failure(t *testing.T) {
9595
f(`[1,2]`)
9696
f(`{"foo":[1]}`)
9797

98-
// Invliad LogsQL filter
98+
// Invalid LogsQL filter
9999
f(`foo:(bar`)
100100

101101
// excess pipe

app/vmui/Dockerfile-web

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ COPY build /build
33

44
WORKDIR /build
55
COPY web/ /build/
6-
RUN GOOS=linux GOARCH=amd64 CGO_ENABLED=0 go build -o web-amd64 github.com/VictoriMetrics/vmui/ && \
7-
GOOS=windows GOARCH=amd64 CGO_ENABLED=0 go build -o web-windows github.com/VictoriMetrics/vmui/
6+
RUN GOOS=linux GOARCH=amd64 CGO_ENABLED=0 go build -o web-amd64 github.com/VictoriaMetrics/vmui/ && \
7+
GOOS=windows GOARCH=amd64 CGO_ENABLED=0 go build -o web-windows github.com/VictoriaMetrics/vmui/
88

99
FROM alpine:3.22.1
1010
USER root

docs/victorialogs/FAQ.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,6 @@ VictoriaLogs is optimized specifically for logs. So it provides the following fe
4545
- Fast full-text search over all the [log fields](https://docs.victoriametrics.com/victorialogs/keyconcepts/#data-model) out of the box.
4646
- Good integration with traditional command-line tools for log analysis. See [these docs](https://docs.victoriametrics.com/victorialogs/querying/#command-line).
4747

48-
4948
## What is the difference between VictoriaLogs and Grafana Loki?
5049

5150
Both Grafana Loki and VictoriaLogs are designed for log management and processing.
@@ -77,7 +76,6 @@ VictoriaLogs and Grafana Loki have the following differences:
7776

7877
See [this article](https://itnext.io/why-victorialogs-is-a-better-alternative-to-grafana-loki-7e941567c4d5) for more details.
7978

80-
8179
## What is the difference between VictoriaLogs and ClickHouse?
8280

8381
ClickHouse is an extremely fast and efficient analytical database. It can be used for logs storage, analysis and processing.
@@ -108,7 +106,6 @@ VictoriaLogs is designed solely for logs. VictoriaLogs uses [similar design idea
108106

109107
- VictoriaLogs provides [built-in Web UI](https://docs.victoriametrics.com/victorialogs/querying/#web-ui) for logs' exploration.
110108

111-
112109
## How does VictoriaLogs work?
113110

114111
VictoriaLogs accepts logs as [JSON entries](https://docs.victoriametrics.com/victorialogs/keyconcepts/#data-model).
@@ -322,14 +319,15 @@ _time:1h _stream_id:in(_time:1h | top 3 (_stream_id) | keep _stream_id) | count_
322319
The query works in the following way:
323320

324321
- It selects top 3 log streams with the biggest number of logs during the last hour with the following subquery:
322+
325323
```logsql
326324
_time:1h | top 3 (_stream_id) | keep _stream_id
327325
```
326+
328327
This subquery uses [`top`](https://docs.victoriametrics.com/victorialogs/logsql/#top-pipe) and [`keep`](https://docs.victoriametrics.com/victorialogs/logsql/#fields-pipe) pipes.
329328

330329
- Then it selects all the logs across the selected log streams over the last hour with the help of [`_stream_id:...` filter](https://docs.victoriametrics.com/victorialogs/logsql/#_stream_id-filter).
331330

332-
333331
## How to estimate the needed compute resources for the given workload?
334332

335333
The needed storage space depends on the following factors:

0 commit comments

Comments
 (0)