Skip to content

Latest commit

 

History

History
183 lines (137 loc) · 7.16 KB

README_zh-CN.md

File metadata and controls

183 lines (137 loc) · 7.16 KB
Raw

go-size-analyzer

Go Report Card Tests codecov GitHub release homebrew version

一个简单的工具，用于分析 Go 编译二进制文件的大小。

安装

从发布页面下载最新版本。

你可以使用 Homebrew 安装 go-size-analyzer

brew install go-size-analyzer

或者使用以下命令安装最新版本：

go install github.com/Zxilly/go-size-analyzer/cmd/gsa@latest

使用

Example

Web mode

$ gsa --web golang-compiled-binary

将在 8080 端口启动一个 web 服务器，您可以在浏览器中查看结果。

或者您可以在浏览器中使用 WASM 版本：GSA Treemap

Note

由于浏览器的限制，wasm 版本比原生版本慢得多。 通常分析相同二进制文件需要 10 倍的时间。

仅建议用于分析小型应用程序（大小小于 30 MB）

网页将如下所示：

image

您可以点击以展开包以查看详细信息。

终端用户界面

$ gsa --tui golang-compiled-binary

demo

文本模式

$ gsa docker-compose-linux-x86_64
+------------------------------------------------------------------------------+
| docker-compose-linux-x86_64                                                  |
+---------+-----------------------------------------------+--------+-----------+
| PERCENT | NAME                                          | SIZE   | TYPE      |
+---------+-----------------------------------------------+--------+-----------+
| 27.76%  | .gopclntab                                    | 17 MB  | section   |
| 15.17%  | .rodata                                       | 9.5 MB | section   |
| 11.63%  | k8s.io/api                                    | 7.3 MB | vendor    |
| 6.69%   | .strtab                                       | 4.2 MB | section   |
| 3.47%   | k8s.io/client-go                              | 2.2 MB | vendor    |
| 3.37%   | .symtab                                       | 2.1 MB | section   |
| 2.28%   | github.com/moby/buildkit                      | 1.4 MB | vendor    |
| 1.54%   | github.com/gogo/protobuf                      | 968 kB | vendor    |
| 1.53%   | github.com/google/gnostic-models              | 958 kB | vendor    |
| 1.33%   | github.com/aws/aws-sdk-go-v2                  | 836 kB | vendor    |
| 1.26%   | crypto                                        | 790 kB | std       |
| 1.25%   | google.golang.org/protobuf                    | 782 kB | vendor    |
| 1.24%   | k8s.io/apimachinery                           | 779 kB | vendor    |
| 1.24%   | net                                           | 777 kB | std       |
| 1.20%   | github.com/docker/compose/v2                  | 752 kB | main      |
| 0.95%   | .noptrdata                                    | 596 kB | section   |
| 0.93%   | go.opentelemetry.io/otel                      | 582 kB | vendor    |
| 0.85%   | google.golang.org/grpc                        | 533 kB | vendor    |
| 0.71%   | runtime                                       | 442 kB | std       |
| 0.59%   | github.com/docker/buildx                      | 371 kB | vendor    |
| 0.55%   | github.com/docker/docker                      | 347 kB | vendor    |
| 0.53%   |                                               | 331 kB | generated |
| 0.52%   | golang.org/x/net                              | 326 kB | vendor    |
| 0.47%   | github.com/theupdateframework/notary          | 294 kB | vendor    |

...[Collapsed]...

| 0.00%   | database/sql/driver                           | 128 B  | std       |
| 0.00%   | .note.go.buildid                              | 100 B  | section   |
| 0.00%   | hash/fnv                                      | 96 B   | std       |
| 0.00%   | maps                                          | 96 B   | std       |
| 0.00%   | github.com/moby/sys/sequential                | 64 B   | vendor    |
| 0.00%   | .text                                         | 1 B    | section   |
+---------+-----------------------------------------------+--------+-----------+
| 97.65%  | KNOWN                                         | 61 MB  |           |
| 100%    | TOTAL                                         | 63 MB  |           |
+---------+-----------------------------------------------+--------+-----------+

Svg 模式

gsa cockroach-darwin-amd64 -f svg -o data.svg --hide-sections

image

完整选项

Usage: gsa <file> [flags]

A tool for analyzing the size of dependencies in compiled Golang binaries,
providing insight into their impact on the final build.

Arguments:
  <file>    Binary file to analyze

Flags:
  -h, --help             Show context-sensitive help.
      --verbose          Verbose output
  -f, --format="text"    Output format, possible values: text,json,html,svg
      --no-disasm        Skip disassembly pass
      --no-symbol        Skip symbol pass
  -o, --output=STRING    Write to file
      --version          Show version

Text output options
  --hide-sections    Hide sections
  --hide-main        Hide main package
  --hide-std         Hide standard library

Json output options
  --indent=INDENT    Indentation for json output
  --compact          Hide function details, replacement with size

Svg output options
  --width=1028         Width of the svg treemap
  --height=640         Height of the svg treemap
  --margin-box=4       Margin between boxes
  --padding-box=4      Padding between box border and content
  --padding-root=32    Padding around root content

Web interface options
  --web               use web interface to explore the details
  --listen=":8080"    listen address
  --open              Open browser

Terminal interface options
  --tui    use terminal interface to explore the details

Caution

该工具可以分析剥离 symbol 的二进制文件，但可能导致结果不准确。

TODO

  • 添加更多用于反汇编二进制文件的模式
  • 从 DWARF 段提取信息
  • 计算符号本身的大小到包中
  • 添加其他图表，如火焰图、饼图等
  • 支持 demangle cgo 中的 C++/Rust 符号
  • 添加 TUI 模式以探索
  • 编译为 wasm，创建一个在浏览器中分析二进制文件的用户界面

Contribution

欢迎任何形式的贡献，随时提出问题或拉取请求。

LICENSE

根据 AGPL-3.0 发布。