Skip to content

Add stefgen docs #103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
tigrannajaryan merged 1 commit into from
Jul 4, 2025
Merged

Add stefgen docs #103

tigrannajaryan merged 1 commit into from
Jul 4, 2025

Conversation

@tigrannajaryan
Copy link
Collaborator

@tigrannajaryan tigrannajaryan commented Jul 3, 2025

No description provided.

@tigrannajaryan tigrannajaryan force-pushed the tigran/documentstefgen branch from 893add8 to bdbbee2 Compare July 4, 2025 00:18
@github-actions
Copy link

github-actions bot commented Jul 4, 2025 •
edited
Loading

Benchmark Result

Benchmark diff with base branch 
goos: linux
goarch: amd64
pkg: github.com/splunk/stef/benchmarks
cpu: AMD EPYC 7763 64-Core Processor                
                                                 │ bench-main.txt │           bench-new.txt            │
                                                 │     sec/op     │    sec/op     vs base              │
SerializeNative/STEF/none-4                           11.57m ± 5%    10.87m ± 6%  -6.01% (p=0.009 n=6)
SerializeNative/STEFU/none-4                          43.44m ± 3%    43.01m ± 3%       ~ (p=0.394 n=6)
DeserializeNative/STEF/none-4                         3.092m ± 1%    3.102m ± 2%       ~ (p=0.589 n=6)
DeserializeNative/STEFU/none-4                        12.20m ± 3%    12.03m ± 1%       ~ (p=0.065 n=6)
SerializeFromPdata/STEF/none-4                        214.8m ± 7%    201.9m ± 3%       ~ (p=0.310 n=6)
SerializeFromPdata/STEFU/none-4                       43.76m ± 2%    43.63m ± 1%       ~ (p=0.699 n=6)
DeserializeToPdata/STEF/none-4                        44.29m ± 2%    44.48m ± 2%       ~ (p=0.818 n=6)
DeserializeToPdata/STEFU/none-4                       67.50m ± 1%    67.76m ± 1%       ~ (p=0.180 n=6)
STEFReaderRead-4                                      3.126m ± 2%    3.105m ± 1%       ~ (p=0.065 n=6)
STEFSerializeMultipart/astronomy-otelmetrics-4         3.601 ± 8%     3.698 ± 9%       ~ (p=0.132 n=6)
STEFDeserializeMultipart/astronomy-otelmetrics-4      92.01m ± 1%    94.83m ± 1%  +3.07% (p=0.002 n=6)
ReadSTEF-4                                            3.186m ± 1%    3.249m ± 3%  +1.99% (p=0.004 n=6)
ReadSTEFZ-4                                           5.314m ± 2%    5.137m ± 3%  -3.33% (p=0.009 n=6)
ReadSTEFZWriteSTEF-4                                  9.652m ± 1%   10.231m ± 3%  +6.00% (p=0.002 n=6)
geomean                                               26.63m         26.54m       -0.33%

                                                 │ bench-main.txt │           bench-new.txt           │
                                                 │   sec/point    │  sec/point   vs base              │
SerializeNative/STEF/none-4                           173.0n ± 5%   162.6n ± 6%  -5.98% (p=0.009 n=6)
SerializeNative/STEFU/none-4                          649.6n ± 3%   643.3n ± 3%       ~ (p=0.370 n=6)
DeserializeNative/STEF/none-4                         46.23n ± 1%   46.40n ± 2%       ~ (p=0.558 n=6)
DeserializeNative/STEFU/none-4                        182.5n ± 3%   179.9n ± 1%  -1.42% (p=0.043 n=6)
SerializeFromPdata/STEF/none-4                        3.213µ ± 7%   3.019µ ± 3%       ~ (p=0.255 n=6)
SerializeFromPdata/STEFU/none-4                       654.5n ± 2%   652.5n ± 1%       ~ (p=0.699 n=6)
DeserializeToPdata/STEF/none-4                        662.4n ± 2%   665.4n ± 2%       ~ (p=0.818 n=6)
DeserializeToPdata/STEFU/none-4                       1.010µ ± 1%   1.014µ ± 1%       ~ (p=0.258 n=6)
STEFReaderRead-4                                      46.75n ± 2%   46.43n ± 1%       ~ (p=0.058 n=6)
STEFSerializeMultipart/astronomy-otelmetrics-4        4.577µ ± 8%   4.700µ ± 9%       ~ (p=0.132 n=6)
STEFDeserializeMultipart/astronomy-otelmetrics-4      116.9n ± 1%   120.5n ± 1%  +3.04% (p=0.002 n=6)
ReadSTEF-4                                            47.68n ± 1%   48.63n ± 3%  +1.99% (p=0.004 n=6)
ReadSTEFZ-4                                           79.53n ± 2%   76.89n ± 3%  -3.32% (p=0.009 n=6)
ReadSTEFZWriteSTEF-4                                  144.4n ± 1%   153.2n ± 3%  +6.02% (p=0.002 n=6)
geomean                                               280.1n        279.2n       -0.33%

                                                 │ bench-main.txt │           bench-new.txt            │
                                                 │      B/op      │     B/op      vs base              │
SerializeNative/STEF/none-4                          3.478Mi ± 0%   3.476Mi ± 0%       ~ (p=0.180 n=6)
SerializeNative/STEFU/none-4                         6.950Mi ± 0%   6.951Mi ± 0%  +0.00% (p=0.026 n=6)
DeserializeNative/STEF/none-4                        840.7Ki ± 0%   840.7Ki ± 0%       ~ (p=0.156 n=6)
DeserializeNative/STEFU/none-4                       1.464Mi ± 0%   1.464Mi ± 0%       ~ (p=0.162 n=6)
SerializeFromPdata/STEF/none-4                       138.0Mi ± 0%   138.0Mi ± 0%       ~ (p=0.394 n=6)
SerializeFromPdata/STEFU/none-4                      6.951Mi ± 0%   6.950Mi ± 0%       ~ (p=0.699 n=6)
DeserializeToPdata/STEF/none-4                       29.81Mi ± 0%   29.81Mi ± 0%       ~ (p=0.093 n=6)
DeserializeToPdata/STEFU/none-4                      36.53Mi ± 0%   36.53Mi ± 0%       ~ (p=0.310 n=6)
STEFReaderRead-4                                     840.7Ki ± 0%   840.7Ki ± 0%  -0.00% (p=0.022 n=6)
STEFSerializeMultipart/astronomy-otelmetrics-4       3.650Gi ± 0%   3.648Gi ± 0%       ~ (p=0.180 n=6)
STEFDeserializeMultipart/astronomy-otelmetrics-4     20.17Mi ± 0%   20.17Mi ± 0%       ~ (p=0.221 n=6)
ReadSTEF-4                                           840.7Ki ± 0%   840.7Ki ± 0%       ~ (p=0.084 n=6)
ReadSTEFZ-4                                          10.19Mi ± 0%   10.19Mi ± 0%       ~ (p=0.093 n=6)
ReadSTEFZWriteSTEF-4                                 13.53Mi ± 0%   13.53Mi ± 0%       ~ (p=0.180 n=6)
geomean                                              10.55Mi        10.55Mi       -0.01%

                                                 │ bench-main.txt │            bench-new.txt            │
                                                 │   allocs/op    │  allocs/op   vs base                │
SerializeNative/STEF/none-4                           2.874k ± 1%   2.870k ± 1%       ~ (p=0.160 n=6)
SerializeNative/STEFU/none-4                          1.044k ± 0%   1.044k ± 0%       ~ (p=0.076 n=6)
DeserializeNative/STEF/none-4                         1.318k ± 0%   1.318k ± 0%       ~ (p=1.000 n=6) ¹
DeserializeNative/STEFU/none-4                        1.379k ± 0%   1.379k ± 0%       ~ (p=1.000 n=6) ¹
SerializeFromPdata/STEF/none-4                        256.4k ± 0%   256.4k ± 0%       ~ (p=0.725 n=6)
SerializeFromPdata/STEFU/none-4                       1.045k ± 0%   1.045k ± 0%       ~ (p=0.939 n=6)
DeserializeToPdata/STEF/none-4                        623.4k ± 0%   623.4k ± 0%       ~ (p=1.000 n=6) ¹
DeserializeToPdata/STEFU/none-4                       812.1k ± 0%   812.1k ± 0%       ~ (p=1.000 n=6) ¹
STEFReaderRead-4                                      1.318k ± 0%   1.318k ± 0%       ~ (p=1.000 n=6) ¹
STEFSerializeMultipart/astronomy-otelmetrics-4        14.44M ± 0%   14.44M ± 0%       ~ (p=0.169 n=6)
STEFDeserializeMultipart/astronomy-otelmetrics-4      8.378k ± 0%   8.378k ± 0%       ~ (p=1.000 n=6)
ReadSTEF-4                                            1.318k ± 0%   1.318k ± 0%       ~ (p=1.000 n=6) ¹
ReadSTEFZ-4                                           1.352k ± 0%   1.352k ± 0%       ~ (p=1.000 n=6) ¹
ReadSTEFZWriteSTEF-4                                  2.296k ± 0%   2.295k ± 0%       ~ (p=1.000 n=6)
geomean                                               11.19k        11.19k       -0.01%
¹ all samples are equal
Benchmark result 
benchstat bench-new.txt
goos: linux
goarch: amd64
pkg: github.com/splunk/stef/benchmarks
cpu: AMD EPYC 7763 64-Core Processor                
                                                 │ bench-new.txt │
                                                 │    sec/op     │
SerializeNative/STEF/none-4                          10.87m ± 6%
SerializeNative/STEFU/none-4                         43.01m ± 3%
DeserializeNative/STEF/none-4                        3.102m ± 2%
DeserializeNative/STEFU/none-4                       12.03m ± 1%
SerializeFromPdata/STEF/none-4                       201.9m ± 3%
SerializeFromPdata/STEFU/none-4                      43.63m ± 1%
DeserializeToPdata/STEF/none-4                       44.48m ± 2%
DeserializeToPdata/STEFU/none-4                      67.76m ± 1%
STEFReaderRead-4                                     3.105m ± 1%
STEFSerializeMultipart/astronomy-otelmetrics-4        3.698 ± 9%
STEFDeserializeMultipart/astronomy-otelmetrics-4     94.83m ± 1%
ReadSTEF-4                                           3.249m ± 3%
ReadSTEFZ-4                                          5.137m ± 3%
ReadSTEFZWriteSTEF-4                                 10.23m ± 3%
geomean                                              26.54m

                                                 │ bench-new.txt │
                                                 │   sec/point   │
SerializeNative/STEF/none-4                          162.6n ± 6%
SerializeNative/STEFU/none-4                         643.3n ± 3%
DeserializeNative/STEF/none-4                        46.40n ± 2%
DeserializeNative/STEFU/none-4                       179.9n ± 1%
SerializeFromPdata/STEF/none-4                       3.019µ ± 3%
SerializeFromPdata/STEFU/none-4                      652.5n ± 1%
DeserializeToPdata/STEF/none-4                       665.4n ± 2%
DeserializeToPdata/STEFU/none-4                      1.014µ ± 1%
STEFReaderRead-4                                     46.43n ± 1%
STEFSerializeMultipart/astronomy-otelmetrics-4       4.700µ ± 9%
STEFDeserializeMultipart/astronomy-otelmetrics-4     120.5n ± 1%
ReadSTEF-4                                           48.63n ± 3%
ReadSTEFZ-4                                          76.89n ± 3%
ReadSTEFZWriteSTEF-4                                 153.2n ± 3%
geomean                                              279.2n

                                                 │ bench-new.txt │
                                                 │     B/op      │
SerializeNative/STEF/none-4                         3.476Mi ± 0%
SerializeNative/STEFU/none-4                        6.951Mi ± 0%
DeserializeNative/STEF/none-4                       840.7Ki ± 0%
DeserializeNative/STEFU/none-4                      1.464Mi ± 0%
SerializeFromPdata/STEF/none-4                      138.0Mi ± 0%
SerializeFromPdata/STEFU/none-4                     6.950Mi ± 0%
DeserializeToPdata/STEF/none-4                      29.81Mi ± 0%
DeserializeToPdata/STEFU/none-4                     36.53Mi ± 0%
STEFReaderRead-4                                    840.7Ki ± 0%
STEFSerializeMultipart/astronomy-otelmetrics-4      3.648Gi ± 0%
STEFDeserializeMultipart/astronomy-otelmetrics-4    20.17Mi ± 0%
ReadSTEF-4                                          840.7Ki ± 0%
ReadSTEFZ-4                                         10.19Mi ± 0%
ReadSTEFZWriteSTEF-4                                13.53Mi ± 0%
geomean                                             10.55Mi

                                                 │ bench-new.txt │
                                                 │   allocs/op   │
SerializeNative/STEF/none-4                          2.870k ± 1%
SerializeNative/STEFU/none-4                         1.044k ± 0%
DeserializeNative/STEF/none-4                        1.318k ± 0%
DeserializeNative/STEFU/none-4                       1.379k ± 0%
SerializeFromPdata/STEF/none-4                       256.4k ± 0%
SerializeFromPdata/STEFU/none-4                      1.045k ± 0%
DeserializeToPdata/STEF/none-4                       623.4k ± 0%
DeserializeToPdata/STEFU/none-4                      812.1k ± 0%
STEFReaderRead-4                                     1.318k ± 0%
STEFSerializeMultipart/astronomy-otelmetrics-4       14.44M ± 0%
STEFDeserializeMultipart/astronomy-otelmetrics-4     8.378k ± 0%
ReadSTEF-4                                           1.318k ± 0%
ReadSTEFZ-4                                          1.352k ± 0%
ReadSTEFZWriteSTEF-4                                 2.295k ± 0%
geomean                                              11.19k

@tigrannajaryan tigrannajaryan force-pushed the tigran/documentstefgen branch from bdbbee2 to 4ffda34 Compare July 4, 2025 14:37
@tigrannajaryan tigrannajaryan force-pushed the tigran/documentstefgen branch from 4ffda34 to 0c1f2fc Compare July 4, 2025 14:41
@tigrannajaryan tigrannajaryan merged commit e459101 into main Jul 4, 2025
10 checks passed
@tigrannajaryan tigrannajaryan deleted the tigran/documentstefgen branch July 4, 2025 14:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@maheshkanote maheshkanote maheshkanote approved these changes

@dmitryax dmitryax Awaiting requested review from dmitryax

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@tigrannajaryan @maheshkanote