Skip to content

Commit beccf56

Browse files
committed
docs: add a demo
1 parent bbcb752 commit beccf56

File tree

3 files changed

+10
-16
lines changed

3 files changed

+10
-16
lines changed

README-zh.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -38,16 +38,13 @@ GhostScope 是一个**运行时追踪工具**,将 printf 调试的简单性带
3838

3939
GhostScope 将编译后的二进制文件转变为可观测系统。在函数入口、特定源代码行或任何中间位置设置追踪点,打印局部变量、全局变量、函数参数、复杂嵌套结构,甚至函数调用栈。既拥有 printf 调试的简单性,又具备现代追踪技术的强大功能。
4040

41+
下面的演示展示了使用 GhostScope 追踪带有调试信息的 nginx worker 进程。可以看到,GhostScope 支持条件判断逻辑,能够轻松提取复杂数据结构的内部信息,且完全不影响进程的正常运行。
42+
4143
<br />
4244

43-
<!-- 演示视频占位符 -->
4445
<div align="center">
45-
<picture>
46-
<source media="(prefers-color-scheme: dark)" srcset="assets/demo-dark.gif">
47-
<source media="(prefers-color-scheme: light)" srcset="assets/demo-light.gif">
48-
<img src="assets/demo.gif" alt="GhostScope Demo" width="100%"/>
49-
</picture>
50-
<p><sub><i>使用 GhostScope 实时追踪运行中的应用程序</i></sub></p>
46+
<img src="assets/demo.gif" alt="GhostScope Demo" width="100%"/>
47+
<p><sub><i>实时追踪运行中的 nginx worker 进程</i></sub></p>
5148
</div>
5249

5350
## ✨ 核心特性
@@ -185,7 +182,7 @@ GhostScope 采用 [GNU 通用公共许可证](LICENSE) 授权。
185182
- [**bpftrace**](https://github.com/iovisor/bpftrace) - eBPF 追踪技术
186183
- [**cgdb**](https://cgdb.github.io/) - TUI 设计和用户体验
187184

188-
特别感谢以下优秀博客文章,学习了很多
185+
特别感谢以下优秀博客文章,学到了很多
189186

190187
- [**动态追踪漫谈**](https://blog.openresty.com.cn/cn/dynamic-tracing/)
191-
- [**硬核方式进行栈回溯**](https://lesenechal.fr/en/linux/unwinding-the-stack-the-hard-way)
188+
- [**Unwinding the stack the hard way**](https://lesenechal.fr/en/linux/unwinding-the-stack-the-hard-way)

README.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -43,16 +43,13 @@ With this map in hand, GhostScope leverages **eBPF and uprobe** technology to sa
4343

4444
GhostScope transforms compiled binaries into observable systems. Place trace points at function entries, specific source lines, or anywhere in between. Print local variables, global variables, function parameters, complex nested structures, even stack backtraces. All with the simplicity of printf debugging, but the power of modern tracing.
4545

46+
The demo below shows GhostScope tracing an nginx worker process with debug information. You can see how GhostScope supports conditional logic, easily extracts information from complex data structures, and operates without disrupting the process.
47+
4648
<br />
4749

48-
<!-- Demo Video Placeholder -->
4950
<div align="center">
50-
<picture>
51-
<source media="(prefers-color-scheme: dark)" srcset="assets/demo-dark.gif">
52-
<source media="(prefers-color-scheme: light)" srcset="assets/demo-light.gif">
53-
<img src="assets/demo.gif" alt="GhostScope Demo" width="100%"/>
54-
</picture>
55-
<p><sub><i>Real-time tracing of a running application with GhostScope</i></sub></p>
51+
<img src="assets/demo.gif" alt="GhostScope Demo" width="100%"/>
52+
<p><sub><i>Real-time tracing of a running nginx worker process</i></sub></p>
5653
</div>
5754

5855
## ✨ Highlights

assets/demo.gif

12.7 MB
Loading

0 commit comments

Comments
 (0)