Skip to content

Commit a895cba

Browse files
committed
fix doc
1 parent 4c47d09 commit a895cba

File tree

3 files changed

+8
-5
lines changed

3 files changed

+8
-5
lines changed

apm-protocol/apm-network/src/main/java/org/apache/skywalking/oap/server/network/trace/component/command/PprofTaskCommand.java

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,9 @@ public class PprofTaskCommand extends BaseCommand implements Serializable, Deser
3131
* pprof taskId
3232
*/
3333
private String taskId;
34-
// Type of profiling (CPU/Heap/Block/Mutex/Goroutine/Threadcreate/Allocs)
34+
/**
35+
* event type of profiling (CPU/Heap/Block/Mutex/Goroutine/Threadcreate/Allocs)
36+
*/
3537
private String events;
3638
/**
3739
* run profiling for duration (minute)
@@ -45,8 +47,8 @@ public class PprofTaskCommand extends BaseCommand implements Serializable, Deser
4547
* pprof dump period parameters. There are different dumpperiod configurations for different events.
4648
* Here is a table of parameters.
4749
*
48-
* <p>For Block - sample an average of one blocking event per rate nanoseconds spent blocked. (default: 0)</p>
49-
* <p>For Mutex - sample an average of 1/rate events are reported. (default: 0)</p>
50+
* <p>for Block - sample an average of one blocking event per rate nanoseconds spent blocked. (default: 0)</p>
51+
* <p>for Mutex - sample an average of 1/rate events are reported. (default: 0)</p>
5052
* details @see <a href="https://pkg.go.dev/runtime/pprof">pprof argument</a>
5153
*/
5254
private int dumpPeriod;

docs/en/changes/changes.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,6 @@
5353
* Self Observability: add `metrics_aggregation_queue_used_percentage` and `metrics_persistent_collection_cached_size` metrics for the OAP server.
5454
* Optimize metrics aggregate/persistent worker: separate `OAL` and `MAL` workers and consume pools. The dataflow signal drives the new MAL consumer,
5555
the following table shows the pool size,driven mode and queue size for each worker.
56-
* Support the go agent(0.7.0 release) bundled pprof profiling feature.
5756

5857
| Worker | poolSize | isSignalDrivenMode | queueChannelSize | queueBufferSize |
5958
|-------------------------------|------------------------------------------|--------------------|------------------|-----------------|
@@ -112,6 +111,8 @@
112111
* Make MAL percentile align with OAL percentile calculation.
113112
* Update Grafana dashboards for OAP observability.
114113
* BanyanDB: fix query `getInstance` by instance ID.
114+
* Support the go agent(0.7.0 release) bundled pprof profiling feature.
115+
115116

116117
#### UI
117118

docs/en/concepts-and-designs/profiling.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Only Java agent support this.
4949

5050
### Go App Profiling
5151

52-
Go App Profiling uses the [Pprof](https://github.com/google/pprof) for sampling.
52+
Go App Profiling uses the [pprof](https://github.com/google/pprof) for sampling.
5353

5454
pprof is a profiling tool by Google for visualizing and analyzing sampled performance data.
5555
It reads samples in profile.proto format and generates text or graphical reports (via the dot visualization) to highlight performance hotspots.

0 commit comments

Comments
 (0)