Spelling and Markdown (#82)

Author: ArieHein

app/victoria-traces/servicegraph/servicegraph.go

@@ -95,7 +95,7 @@ func GenerateServiceGraphTimeRange(ctx context.Context) {
 		// persist service graph relations
 		err = vtinsert.PersistServiceGraph(ctx, tenantID, rows, endTime)
 		if err != nil {
-			logger.Errorf("cannot presist service graph for time range [%d, %d]: %s", startTime.Unix(), endTime.Unix(), err)
+			logger.Errorf("cannot persist service graph for time range [%d, %d]: %s", startTime.Unix(), endTime.Unix(), err)
 		}
 	}
 }

app/vmui/README.md

@@ -11,32 +11,31 @@ Web UI for VictoriaTraces
 
 Run the following command from the root of VictoriaTraces repository for building `vmui` static contents:
 
-```
+```sh
 make vmui-build
 ```
 
 The built static contents is put into `app/vmui/packages/vmui/` directory.
 
-
 ### Updating vmui embedded into VictoriaTraces
 
 Run the following command from the root of VictoriaTraces repository for updating `vmui` embedded into VictoriaTraces:
 
-```
+```sh
 make vmui-update
 ```
 
 This command should update `vmui` static files at `app/vtselect/vmui` directory. Commit changes to these files if needed.
 
 Then build VictoriaTraces with the following command:
 
-```
+```sh
 make victoria-traces
 ```
 
 Then run the built binary with the following command:
 
-```
+```sh
 bin/victoria-traces
 ```
 

app/vtgen/README.md

@@ -3,12 +3,15 @@
 `vtgen` is a trace data generator. It reads the OTLP request body in `testdata/testdata.bin`, modifies the `trace_id`, `start_time` and `end_time`, and sends them to OTLP trace endpoint (`/v1/traces`).
 
 ### Usage
+
 `vtgen` can be used for:
+
 1. Generating identical data for different targets, which is useful for query performance benchmarking of different storage backends against the same dataset.
 2. Generating different data at the same rate (on a best-effort basis) for different targets, which is useful for data ingestion performance benchmarking of different storage backends.
 
 You can build `vtgen` via the following commands:
-```
+
+```sh
 # build via go build
 make vtgen
 # build via Docker
@@ -20,20 +23,25 @@ These commands will generate `vtgen(-prod)` binary in `bin` folder.
 `vtgen` MUST be run from the root path of `VictoriaTraces` repository, to load the test data correctly from `app/vtgen/testdata`.
 
 To send identical data to different targets:
-```
+
+```sh
 ./bin/vtgen -addrs=http://example-url1:port/v1/traces,http://example-url2:port/insert/opentelemetry/v1/traces
 ```
+
 The performance of different targets will affect each other, as `vtgen` generates data and makes HTTP requests to them one by one.
 
 To send (potentially) different data to different addresses at the same rate, simply run multiple `vtgen` with different HTTP listening port:
-```
+
+```sh
 ./bin/vtgen -addrs=http://example-url1:port/v1/traces -httpListenAddr=0.0.0.0:8080
 ./bin/vtgen -addrs=http://example-url2:port/insert/opentelemetry/v1/traces -httpListenAddr=0.0.0.0:8081
 ```
 
 ### Metrics
+
 `vtgen` exposes some metrics to help tracking the ingestion performance. Here's the example:
-```
+
+```sh
 vt_gen_http_request_duration_seconds_bucket{path="http://example-url1:port/v1/traces",vmrange="7.743e-05...8.799e-05"} 8
 vt_gen_http_request_duration_seconds_bucket{path="http://example-url1:port/v1/traces",vmrange="3.162e-03...3.594e-03"} 1
 vt_gen_http_request_duration_seconds_sum{path="http://example-url1:port/v1/traces"} 0.17367758299999986
@@ -45,6 +53,7 @@ vt_gen_http_request_error_count{path="http://example-url1:port/v1/traces"} 667
 - `vt_gen_http_request_error_count` is a `counter` for each address.
 
 ### Command-line flags
+
 ```
   -addrs string
     	otlp trace export endpoints, split by ",".
@@ -80,4 +89,4 @@ vt_gen_http_request_error_count{path="http://example-url1:port/v1/traces"} 667
     	Show VictoriaMetrics version
   -worker int
     	number of workers. (default 4)
-```
+```

app/vtselect/internalselect/internalselect.go

@@ -357,8 +357,8 @@ func getCommonParams(r *http.Request, expectedProtocolVersion string) (*commonPa
 func checkProtocolVersion(r *http.Request, expectedProtocolVersion string) error {
 	version := r.FormValue("version")
 	if version != expectedProtocolVersion {
-		return fmt.Errorf("unexpected protocol version=%q; want %q; the most likely casue of this error is different versions of VictoriaLogs cluster components; "+
-			"make sure VictoriaLogs compoments have the same release version", version, expectedProtocolVersion)
+		return fmt.Errorf("unexpected protocol version=%q; want %q; the most likely cause of this error is different versions of VictoriaLogs cluster components; "+
+			"make sure VictoriaLogs components have the same release version", version, expectedProtocolVersion)
 	}
 	return nil
 }

app/vtstorage/netselect/netselect.go

@@ -495,8 +495,8 @@ func (s *Storage) DeleteRunTask(ctx context.Context, taskID string, timestamp in
 	errs := make([]error, len(s.sns))
 
 	// Return an error to the caller when at least a single storage node is unavailable.
-	// This improves awarenes of the caller about unavailable storage nodes.
-	// If some storage node is unavailable, then the deletetion task
+	// This improves awareness of the caller about unavailable storage nodes.
+	// If some storage node is unavailable, then the deletion task
 	// can start on arbitrary number of the remaining available nodes.
 	// It is OK to re-run the delete task in this case.
 	allowPartialResponse := false
@@ -525,7 +525,7 @@ func (s *Storage) DeleteStopTask(ctx context.Context, taskID string) error {
 	errs := make([]error, len(s.sns))
 
 	// Return an error to the caller when at least a single storage node is unavailable.
-	// This improves awarenes of the caller about unavailable storage nodes.
+	// This improves awareness of the caller about unavailable storage nodes.
 	// If some storage node is unavailable, then the deletion task can remain uncanceled on such nodes.
 	// It is OK to stop the delete task multiple times in this case.
 	allowPartialResponse := false

codespell/README.md

@@ -1,11 +1,12 @@
 # Spell checking
 
-This directory contains configuration and instructions for spell checking in 
+This directory contains configuration and instructions for spell checking in
 [docs](https://github.com/VictoriaMetrics/VictoriaTraces/tree/master/docs) folder.
 
 To run execute the following command:
+
 ```sh
 make spellcheck
 ```
 
-This command required Docker to build `spellcheck` image and run the spell checks. 
+This command required Docker to build `spellcheck` image and run the spell checks.

docs/victoriatraces/README.md

@@ -22,7 +22,7 @@ VictoriaTraces provides the following prominent features:
   to integrate with [Grafana](https://grafana.com/docs/grafana/latest/datasources/jaeger/) or [Jaeger Frontend](https://www.jaegertracing.io/docs/2.6/frontend-ui/).
 - It supports alerting - see [these docs](https://docs.victoriametrics.com/victoriatraces/vmalert/).
 
-If you want to play with the VictoriaTraces demo, simply go to our [Grafana playground](https://play-grafana.victoriametrics.com/explore) to query and visualize the traces, 
+If you want to play with the VictoriaTraces demo, simply go to our [Grafana playground](https://play-grafana.victoriametrics.com/explore) to query and visualize the traces,
 and visit the [VictoriaTraces playground](https://play-vtraces.victoriametrics.com/) to see how trace spans are structured and stored.
 
 ## Operation

docs/victoriatraces/changelog/CHANGELOG.md

@@ -30,7 +30,7 @@ Released at 2025-11-08
 
 * FEATURE: [Single-node VictoriaTraces](https://docs.victoriametrics.com/victoriatraces/) and [VictoriaTraces cluster](https://docs.victoriametrics.com/victoriatraces/cluster/): support [OTLP/gRPC](https://opentelemetry.io/docs/specs/otlp/#otlpgrpc) data ingestion. It requires `-otlpGRPCListenAddr` flag to be set on Single-node VictoriaTraces or vtinsert. See [this doc](https://docs.victoriametrics.com/victoriatraces/data-ingestion/opentelemetry) for details. Thanks to @JayiceZ for the [pull request](https://github.com/VictoriaMetrics/VictoriaTraces/pull/59).
 
-* BUGFIX: [Single-node VictoriaTraces](https://docs.victoriametrics.com/victoriatraces/) and vtselect in [VictoriaTraces cluster](https://docs.victoriametrics.com/victoriatraces/cluster/): return the correct error message and the total number when searching by trace ID yields no hits in the result. Thank @huan89983 for [the bug report](https://github.com/VictoriaMetrics/VictoriaTraces/issues/77). 
+* BUGFIX: [Single-node VictoriaTraces](https://docs.victoriametrics.com/victoriatraces/) and vtselect in [VictoriaTraces cluster](https://docs.victoriametrics.com/victoriatraces/cluster/): return the correct error message and the total number when searching by trace ID yields no hits in the result. Thank @huan89983 for [the bug report](https://github.com/VictoriaMetrics/VictoriaTraces/issues/77).
 
 ## [v0.4.1](https://github.com/VictoriaMetrics/VictoriaTraces/releases/tag/v0.4.1)
 

docs/victoriatraces/data-ingestion/opentelemetry.md

@@ -33,7 +33,7 @@ The OpenTelemetry provides detailed document and examples for various programmin
 
 You can send data to VictoriaTraces by HTTP or gRPC endpoints.
 
-### HTTP endpoint 
+### HTTP endpoint
 
 To send data by HTTP endpoint, specify the `EndpointURL` for http-exporter builder to `http://<victoria-traces>:10428/insert/opentelemetry/v1/traces`.
 
@@ -48,6 +48,7 @@ traceExporter, err := otlptracehttp.New(ctx,
 ### gRPC endpoint
 
 To send the trace data to VictoriaTraces gRPC trace service, you need to first enable the OTLP gRPC server on VictoriaTraces by:
+
 ```shell
 ./victoria-traces -otlpGRPCListenAddr=:4317 -otlpGRPC.tlsCertFile=<cert_file> -otlpGRPC.tlsKeyFile=<key_file>
 ```
@@ -57,6 +58,7 @@ To send the trace data to VictoriaTraces gRPC trace service, you need to first e
 After that, specify the `Endpoint` for grpc-exporter builder to `<victoria-traces>:4317`.
 
 Consider the following example for Go SDK:
+
 ```go
 traceExporter, err := otlptracegrpc.New(ctx,
     otlptracegrpc.WithEndpoint("<victoria-traces>:4317"),
@@ -100,16 +102,19 @@ exporters:
     headers:
       VT-Extra-Fields: foo=bar
 ```
+
 #### gRPC exporter
 
 To send the collected traces to VictoriaTraces gRPC trace service, you need to first enable the OTLP gRPC server on VictoriaTraces by:
+
 ```shell
 ./victoria-traces -otlpGRPCListenAddr=:4317 -otlpGRPC.tlsCertFile=<cert_file> -otlpGRPC.tlsKeyFile=<key_file>
 ```
 
 > You can also **disable TLS** for incoming gRPC requests by setting `-otlpGRPC.tls=false`. TLS is recommended for production use, and disabling it should only be done when you're testing or aware of the potential risks.
 
 After that, specify endpoint for [OTLP/gRPC exporter](https://github.com/open-telemetry/opentelemetry-collector/blob/main/exporter/otlpexporter/README.md):
+
 ```yaml
 exporters:
   # otlp exporter with TLS
@@ -128,6 +133,7 @@ exporters:
 > Optionally, you can specify the `compression` type to one of the following: `gzip` (default), `snappy`, `zstd`, and `none`.
 
 As same as HTTP endpoint, gRPC also support various HTTP headers. For example, the following configs add (or overwrites) `foo: bar` field to each trace span during data ingestion:
+
 ```yaml
 exporters:
   otlp/without-tls:

docs/victoriatraces/quick-start.md

@@ -78,21 +78,21 @@ See how to [write](#write-data) or [read](#read-data) from VictoriaTraces.
 
 ### Write data
 
-VictoriaTraces can accept trace spans via [the OpenTelemetry protocol (OTLP)](https://opentelemetry.io/docs/specs/otlp/). 
+VictoriaTraces can accept trace spans via [the OpenTelemetry protocol (OTLP)](https://opentelemetry.io/docs/specs/otlp/).
 
 It provides the following HTTP API:
 
 - `/insert/opentelemetry/v1/traces`
 
 and the OpenTelemetry Collector gRPC [TraceService](https://github.com/open-telemetry/opentelemetry-proto/blob/v1.8.0/opentelemetry/proto/collector/trace/v1/trace_service.proto#L30).
 
-These enable user to ingest trace spans through [OTLP/HTTP](https://opentelemetry.io/docs/specs/otlp/#otlphttp) and [OTLP/gRPC](https://opentelemetry.io/docs/specs/otlp/#otlpgrpc). 
+These enable user to ingest trace spans through [OTLP/HTTP](https://opentelemetry.io/docs/specs/otlp/#otlphttp) and [OTLP/gRPC](https://opentelemetry.io/docs/specs/otlp/#otlpgrpc).
 
 To test the data ingestion, run the following command:
 
 ```shell
-echo '{"resourceSpans":[{"resource":{"attributes":[{"key":"service.name","value":{"stringValue":"frontend-web"}},{"key":"telemetry.sdk.language","value":{"stringValue":"webjs"}},{"key":"telemetry.sdk.name","value":{"stringValue":"opentelemetry"}},{"key":"telemetry.sdk.version","value":{"stringValue":"1.30.1"}},{"key":"process.runtime.name","value":{"stringValue":"browser"}},{"key":"process.runtime.description","value":{"stringValue":"Web Browser"}},{"key":"process.runtime.version","value":{"stringValue":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) HeadlessChrome/136.0.0.0 Safari/537.36"}}]},"scopeSpans":[{"scope":{"name":"@opentelemetry/instrumentation-document-load","version":"0.44.1"},"spans":[{"traceId":"1af5dd013a30efe7f2970032ab81958b","spanId":"229d083a6c480511","parentSpanId":"","name":"documentLoad","kind":1,"startTimeUnixNano":"ingestTimePlaceHolder","endTimeUnixNano":"ingestTimePlaceHolder","attributes":[{"key":"session.id","value":{"stringValue":"96e702c3-6f05-4f54-b2b3-2fad2b7b7995"}},{"key":"http.url","value":{"stringValue":"http://frontend-proxy:8080/cart"}},{"key":"http.user_agent","value":{"stringValue":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) HeadlessChrome/136.0.0.0 Safari/537.36"}}],"events":[{"timeUnixNano":"1757320936519100098","name":"fetchStart"}],"status":{}}]}]}]}' | 
-sed "s/ingestTimePlaceHolder/$(date +%s000000000)/g" | 
+echo '{"resourceSpans":[{"resource":{"attributes":[{"key":"service.name","value":{"stringValue":"frontend-web"}},{"key":"telemetry.sdk.language","value":{"stringValue":"webjs"}},{"key":"telemetry.sdk.name","value":{"stringValue":"opentelemetry"}},{"key":"telemetry.sdk.version","value":{"stringValue":"1.30.1"}},{"key":"process.runtime.name","value":{"stringValue":"browser"}},{"key":"process.runtime.description","value":{"stringValue":"Web Browser"}},{"key":"process.runtime.version","value":{"stringValue":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) HeadlessChrome/136.0.0.0 Safari/537.36"}}]},"scopeSpans":[{"scope":{"name":"@opentelemetry/instrumentation-document-load","version":"0.44.1"},"spans":[{"traceId":"1af5dd013a30efe7f2970032ab81958b","spanId":"229d083a6c480511","parentSpanId":"","name":"documentLoad","kind":1,"startTimeUnixNano":"ingestTimePlaceHolder","endTimeUnixNano":"ingestTimePlaceHolder","attributes":[{"key":"session.id","value":{"stringValue":"96e702c3-6f05-4f54-b2b3-2fad2b7b7995"}},{"key":"http.url","value":{"stringValue":"http://frontend-proxy:8080/cart"}},{"key":"http.user_agent","value":{"stringValue":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) HeadlessChrome/136.0.0.0 Safari/537.36"}}],"events":[{"timeUnixNano":"1757320936519100098","name":"fetchStart"}],"status":{}}]}]}]}' |
+sed "s/ingestTimePlaceHolder/$(date +%s000000000)/g" |
 curl -X POST -H 'Content-Type: application/json' --data-binary @- http://<victoria-traces>:10428/insert/opentelemetry/v1/traces
 ```