Skip to content

Commit 2105963

Browse files
committed
Readme examples changes
1 parent 94fc945 commit 2105963

File tree

1 file changed

+17
-14
lines changed

1 file changed

+17
-14
lines changed

examples/README.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,22 +11,25 @@ These are very simple projects where the application is basically one `while tru
1111

1212

1313
# How Pyroscope works
14-
Pyroscope is open-source software that allows you to continuously profile your code to debug performance issues down the line of code.
15-
If you haven't used profilers before, then welcome.
16-
![pyroscope_diagram_no_logo-01](https://user-images.githubusercontent.com/23323466/104868724-1194d680-58f9-11eb-96da-c5a4922a95d5.png)
17-
If you are familiar with profiling / flamegraphs, then you should know that Pyroscope:
14+
Pyroscope identifies performance issues in your application by continuously profiling the code.
15+
16+
If you've never used a profiler before, then welcome!
17+
18+
If you are familiar with profiling and flame graphs, then you'll be happy to know that Pyroscope:
1819
- Requires very minimal overhead
19-
- Is designed in a way that **it can store years of your applications perf data down to 10 second granularity.**
20-
There are two main components that allow Pyroscope to do this:
20+
- Can store years of perf data down to 10 second granularity
21+
- Uses a unique, inverted flame graph for increased readability
22+
23+
There are two main components that allow Pyroscope to run smoothly and quickly:
2124
## Pyroscope agent
22-
The Pyroscope agent wraps around your Python, Ruby, or Go application to poll the stacktrace (100 times per second) to calculate which function is consuming your CPU resources.
23-
This simply means that 100 times a second Pyroscope records what function is currently using CPU to do some work or calculate something.
25+
Every .01 seconds, the Pyroscope agent wraps around your Python, Ruby, or Go application to poll the stacktrace and calculate which function is consuming your CPU resources.
26+
![pyroscope_diagram_no_logo-01](https://user-images.githubusercontent.com/23323466/104868724-1194d680-58f9-11eb-96da-c5a4922a95d5.png)
2427
## Pyroscope Server
25-
Pyroscope records and aggregates what your application has been doing, it then sends that data to the Pyroscope server over port `:4040`
26-
Then here, the data is processed, aggregated, and stored ([BadgerDB](https://github.com/dgraph-io/badger)) in a way which allows for you to **quickly** query any time range:
28+
Pyroscope records and aggregates what your application has been doing, then sends that data to the Pyroscope server over port `:4040`([BadgerDB](https://github.com/dgraph-io/badger)) to be processed, aggregated, and stored for speedy queries of any time range, including:
2729
- [x] all of 2020
28-
- [x] that one day that weird thing happened last month
29-
- [x] that time you deployed on a friday and everything went to s*** and nobody knew why
30-
- [x] A random 10 second span anytime ever that you only are querying to see if this is legit
31-
We've been running a demo in production for a while now. Check out our [Demo Page](https://demo.pyroscope.io/) and select any time range to see how quick it is!
30+
- [x] that one day last month when that weird thing happened
31+
- [x] that time you deployed on a Friday and messed up everything without knowing why
32+
- [x] A random 10 seconds you are only querying to see if Pyroscope is legit
33+
34+
Check out our [Demo Page](https://demo.pyroscope.io/) and select any time range to see how quickly Pyroscope works!
3235
![image](https://user-images.githubusercontent.com/23323466/104861560-2ebfaa00-58e5-11eb-862e-3481f294cbcf.png)

0 commit comments

Comments
 (0)