forked from open-telemetry/opentelemetry-collector
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Disable concurrency in zstd and add Benchmark tests for it (open-tele…
…metry#9749) **Description:** zstd benchmark tests added The goal of this PR is to disable concurrency in zstd compression to reduce its memory footprint and avoid a known issue with goroutine leaks. Please see - klauspost/compress#264 **Link to tracking Issue:** open-telemetry#8216 **Testing:** Benchmark test results below ``` BenchmarkCompression/zstdWithConcurrency/compress-10 21392 55855 ns/op 187732.88 MB/s 2329164 B/op 28 allocs/op BenchmarkCompression/zstdNoConcurrency/compress-10 29526 39902 ns/op 262787.42 MB/s 1758988 B/op 15 allocs/op input => 10.00 MB ```
- Loading branch information
1 parent
b1e075f
commit 7a8954f
Showing
3 changed files
with
125 additions
and
3 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Use this changelog template to create an entry for release notes. | ||
|
||
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' | ||
change_type: enhancement | ||
|
||
# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver) | ||
component: confighttp | ||
|
||
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). | ||
note: Disable concurrency in zstd compression | ||
|
||
# One or more tracking issues or pull requests related to the change | ||
issues: [8216] | ||
|
||
# (Optional) One or more lines of additional information to render under the primary note. | ||
# These lines will be padded with 2 spaces and then inserted directly into the document. | ||
# Use pipe (|) for multiline entries. | ||
subtext: | ||
|
||
# Optional: The change log or logs in which this entry should be included. | ||
# e.g. '[user]' or '[user, api]' | ||
# Include 'user' if the change is relevant to end users. | ||
# Include 'api' if there is a change to a library API. | ||
# Default: '[user]' | ||
change_logs: [] |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,96 @@ | ||
// Copyright The OpenTelemetry Authors | ||
// SPDX-License-Identifier: Apache-2.0 | ||
|
||
// This file contains helper functions regarding compression/decompression for confighttp. | ||
|
||
package confighttp // import "go.opentelemetry.io/collector/config/confighttp" | ||
|
||
import ( | ||
"bytes" | ||
"fmt" | ||
"io" | ||
"strings" | ||
"testing" | ||
|
||
"github.com/klauspost/compress/zstd" | ||
|
||
"go.opentelemetry.io/collector/config/configcompression" | ||
) | ||
|
||
func BenchmarkCompression(b *testing.B) { | ||
benchmarks := []struct { | ||
codec configcompression.Type | ||
name string | ||
function func(*testing.B, configcompression.Type, *bytes.Buffer, []byte) | ||
}{ | ||
{ | ||
codec: configcompression.TypeZstd, | ||
name: "zstdWithConcurrency", | ||
function: benchmarkCompression, | ||
}, | ||
{ | ||
codec: configcompression.TypeZstd, | ||
name: "zstdNoConcurrency", | ||
function: benchmarkCompressionNoConcurrency, | ||
}, | ||
} | ||
payload := make([]byte, 10<<20) | ||
buffer := bytes.Buffer{} | ||
buffer.Grow(len(payload)) | ||
|
||
ts := &bytes.Buffer{} | ||
defer func() { | ||
fmt.Printf("input => %.2f MB\n", float64(len(payload))/(1024*1024)) | ||
fmt.Println(ts) | ||
}() | ||
|
||
for i := range benchmarks { | ||
benchmark := &benchmarks[i] | ||
b.Run(fmt.Sprint(benchmark.name), func(b *testing.B) { | ||
benchmark.function(b, benchmark.codec, &buffer, payload) | ||
}) | ||
|
||
} | ||
} | ||
|
||
func benchmarkCompression(b *testing.B, _ configcompression.Type, buf *bytes.Buffer, payload []byte) { | ||
// Concurrency Enabled | ||
|
||
b.Run("compress", func(b *testing.B) { | ||
stringReader := strings.NewReader(string(payload)) | ||
stringReadCloser := io.NopCloser(stringReader) | ||
var enc io.Writer | ||
b.ResetTimer() | ||
b.ReportAllocs() | ||
b.SetBytes(int64(len(payload))) | ||
for i := 0; i < b.N; i++ { | ||
enc, _ = zstd.NewWriter(nil, zstd.WithEncoderConcurrency(5)) | ||
enc.(writeCloserReset).Reset(buf) | ||
_, copyErr := io.Copy(enc, stringReadCloser) | ||
if copyErr != nil { | ||
b.Fatal(copyErr) | ||
} | ||
} | ||
}) | ||
} | ||
|
||
func benchmarkCompressionNoConcurrency(b *testing.B, _ configcompression.Type, buf *bytes.Buffer, payload []byte) { | ||
// Concurrency Disabled | ||
|
||
b.Run("compress", func(b *testing.B) { | ||
stringReader := strings.NewReader(string(payload)) | ||
stringReadCloser := io.NopCloser(stringReader) | ||
var enc io.Writer | ||
b.ResetTimer() | ||
b.ReportAllocs() | ||
b.SetBytes(int64(len(payload))) | ||
for i := 0; i < b.N; i++ { | ||
enc, _ = zstd.NewWriter(nil, zstd.WithEncoderConcurrency(1)) | ||
enc.(writeCloserReset).Reset(buf) | ||
_, copyErr := io.Copy(enc, stringReadCloser) | ||
if copyErr != nil { | ||
b.Fatal(copyErr) | ||
} | ||
} | ||
}) | ||
} |