Skip to content

Commit 40aacc4

Browse files
committed
Updates information about profiler.
Adds introduction video
1 parent c514817 commit 40aacc4

File tree

2 files changed

+31
-8
lines changed

2 files changed

+31
-8
lines changed

docs/config/xhprof.md

Lines changed: 29 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,36 @@
11
# Integration — Xhprof profiler
22

3-
The Xhprof profiler is an essential feature of Buggregator that offers a lightweight and hierarchical profiling solution
4-
for PHP applications. It uses instrumentation to keep track of call counts and inclusive metrics for arcs in the dynamic
5-
callgraph of your program during the data collection phase. In the reporting and post-processing phase, the profiler
6-
computes exclusive metrics such as wall (elapsed) time, CPU time, and memory usage.
3+
Buggregator is not just useful for dumping variables; it’s an essential instrument for deeply analyzing your PHP
4+
applications to locate and resolve efficiency issues.
75

8-
![xhprof](https://github.com/buggregator/server/assets/773481/d69e1158-599d-4546-96a9-40a42cb060f4)
6+
To start, you only need to install the profiling package into your PHP application and begin collecting metrics. The
7+
collected metrics will be automatically sent to Buggregator, where you can analyze the PHP function call trace. With a
8+
comprehensive set of tools, you can identify slow calls and work on optimizing them. You can keep sending metrics after
9+
making changes to ensure that all unoptimized code is streamlined.
910

10-
With the Xhprof profiler, you can easily identify performance bottlenecks and optimize your application's code for
11-
better efficiency. So, if you're looking to fine-tune your PHP application's performance, the Xhprof profiler is the
12-
perfect tool for the job.
11+
Watch introduction video on [YouTube](https://www.youtube.com/watch?v=2QbgjIVnz78).
12+
13+
### Buggregator offers three types of analysis to help you enhance the performance of your PHP applications:
14+
15+
1. **Call Graph** – This shows the function calls in a tree structure. The nodes in the call tree vary in color from
16+
white to dark red. The darker the color, the more resources are being consumed by that call. This visual
17+
representation helps you quickly identify which parts of your code are using the most resources, allowing you to
18+
pinpoint where optimizations are most needed.
19+
20+
![xhprof-callgraph](https://github.com/buggregator/server/assets/773481/1cf3c587-c1df-4742-8fcd-54a320c86252)
21+
22+
2. **FlameGraph** – This graphical representation stacks function calls and shows which functions are called by which
23+
other functions. It's particularly useful for spotting repetitive or time-consuming operations that might not be
24+
obvious. The FlameGraph helps you see how functions interact and where time is being spent in your application,
25+
making it easier to target specific areas for improvement.
26+
27+
![xhprof-flamegraph](https://github.com/buggregator/server/assets/773481/5f75e271-527d-4c6b-a0b1-a3558f8bac51)
28+
29+
3. **Top 100 Functions** – This table lists the top 100 function calls that consume the most resources. It provides a
30+
clear, focused list of potential problem areas, so you can start optimizing the parts of your application that will
31+
make the biggest difference to overall performance.
32+
33+
![xhprof-top-func](https://github.com/buggregator/server/assets/773481/43dbe4c8-ac23-4cfb-8715-f5141093618f)
1334

1435
## Installation extension
1536

docs/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ debugging PHP applications, but it's also compatible with other programming lang
55
for developers. What makes it special is that it offers a range of features that you would usually find in various paid
66
tools, but it's available for free.
77

8+
**Watch introduction video on [YouTube](https://www.youtube.com/watch?v=yKWbuw8xN_c)**
9+
810
**Project repository:** https://github.com/buggregator/server
911

1012
![Cover image](https://github.com/buggregator/server/assets/773481/47491a3c-57a3-4b40-b82e-37976afdf708)

0 commit comments

Comments
 (0)