-
Notifications
You must be signed in to change notification settings - Fork 621
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(examples): update ruby examples (#3771)
* chore(examples): update ruby examples * update ruby docs * update screenshots and links
- Loading branch information
1 parent
74a05a9
commit 6d0c159
Showing
8 changed files
with
71 additions
and
240 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
105 changes: 4 additions & 101 deletions
105
examples/language-sdk-instrumentation/ruby/rideshare/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,113 +1,16 @@ | ||
| ## Continuous Profiling for Ruby applications | ||
| ### Profiling a Ruby Rideshare App with Pyroscope | ||
|  | ||
| # Rideshare Example | ||
|
|
||
| Note: For documentation on the Pyroscope ruby gem visit [our website](https://pyroscope.io/docs/ruby/) | ||
| ## Background | ||
| In this example we show a simplified, basic use case of Pyroscope. We simulate a "ride share" company which has three endpoints found in `server.rb`: | ||
| - `/bike` : calls the `order_bike(search_radius)` function to order a bike | ||
| - `/car` : calls the `order_car(search_radius)` function to order a car | ||
| - `/scooter` : calls the `order_scooter(search_radius)` function to order a scooter | ||
|
|
||
| We also simulate running 3 distinct servers in 3 different regions (via [docker-compose.yml](https://github.com/pyroscope-io/pyroscope/blob/main/examples/ruby/docker-compose.yml)) | ||
| - us-east | ||
| - eu-north | ||
| - ap-south | ||
|
|
||
| One of the most useful capabilities of Pyroscope is the ability to tag your data in a way that is meaningful to you. In this case, we have two natural divisions, and so we "tag" our data to represent those: | ||
| - `region`: statically tags the region of the server running the code | ||
| - `vehicle`: dynamically tags the endpoint (similar to how one might tag a controller rails) | ||
|
|
||
|
|
||
| ## Tagging static region | ||
| Tagging something static, like the `region`, can be done in the initialization code in the `config.tags` variable: | ||
| ``` | ||
| Pyroscope.configure do |config| | ||
| config.app_name = "ride-sharing-app" | ||
| config.server_address = "http://pyroscope:4040" | ||
| config.tags = { | ||
| "region": ENV["REGION"], # Tags the region based of the environment variable | ||
| } | ||
| end | ||
| ``` | ||
|
|
||
| ## Tagging dynamically within functions | ||
| Tagging something more dynamically, like we do for the `vehicle` tag can be done inside our utility `find_nearest_vehicle()` function using a `Pyroscope.tag_wrapper` block | ||
| ``` | ||
| def find_nearest_vehicle(n, vehicle) | ||
| Pyroscope.tag_wrapper({ "vehicle" => vehicle }) do | ||
| ...code to find nearest vehicle | ||
| end | ||
| end | ||
| ``` | ||
|
|
||
| What this block does, is: | ||
| 1. Add the tag `{ "vehicle" => "car" }` | ||
| 2. execute the `find_nearest_vehicle()` function | ||
| 3. Before the block ends it will (behind the scenes) remove the `{ "vehicle" => "car" }` from the application since that block is complete | ||
|
|
||
| ## Resulting flamgraph / performance results from the example | ||
| ### Running the example | ||
| To run the example run the following commands: | ||
| ``` | ||
| # Pull latest pyroscope and grafana images: | ||
| docker pull grafana/pyroscope:latest | ||
| docker pull grafana/grafana:latest | ||
| # Run the example project: | ||
| docker-compose up --build | ||
| docker compose up --build | ||
| # Reset the database (if needed): | ||
| # docker-compose down | ||
| docker compose down | ||
| ``` | ||
|
|
||
| What this example will do is run all the code mentioned above and also send some mock-load to the 3 servers as well as their respective 3 endpoints. If you select our application: `ride-sharing-app.cpu` from the dropdown, you should see a flame graph that looks like this. After we give 20-30 seconds for the flame graph to update and then click the refresh button we see our 3 functions at the bottom of the flame graph taking CPU resources _proportional to the size_ of their respective `search_radius` parameters. | ||
|
|
||
| ## Where's the performance bottleneck? | ||
|  | ||
|
|
||
|
|
||
| The first step when analyzing a profile outputted from your application, is to take note of the _largest node_ which is where your application is spending the most resources. In this case, it happens to be the `order_car` function. | ||
|
|
||
| The benefit of using the Pyroscope package, is that now that we can investigate further as to _why_ the `order_car()` function is problematic. Tagging both `region` and `vehicle` allows us to test two good hypotheses: | ||
| - Something is wrong with the `/car` endpoint code | ||
| - Something is wrong with one of our regions | ||
|
|
||
| To analyze this we can select one or more tags from the "Select Tag" dropdown: | ||
|
|
||
|  | ||
|
|
||
| ## Narrowing in on the Issue Using Tags | ||
| Knowing there is an issue with the `order_car()` function we automatically select that tag. Then, after inspecting multiple `region` tags, it becomes clear by looking at the timeline that there is an issue with the `eu-north` region, where it alternates between high-cpu times and low-cpu times. | ||
|
|
||
| We can also see that the `mutex_lock()` function is consuming almost 70% of CPU resources during this time period. | ||
|
|
||
|  | ||
|
|
||
| ## Comparing two time periods | ||
| Using Pyroscope's "comparison view" we can actually select two different time ranges from the timeline to compare the resulting flame graphs. The pink section on the left timeline results in the left flame graph and the blue section on the right represents the right flame graph. | ||
|
|
||
| When we select a period of low-cpu utilization, and a period of high-cpu utilization we can see that there is clearly different behavior in the `mutex_lock()` function where it takes **23% of CPU** during low-cpu times and **70% of CPU** during high-cpu times. | ||
|
|
||
|  | ||
|
|
||
| ## Visualizing diff between two flame graphs | ||
| While the difference _in this case_ is stark enough to see in the comparison view, sometimes the diff between the two flame graphs is better visualized with them overlayed over each other. Without changing any parameters, we can simply select the diff view tab and see the difference represented in a color-coded diff flame graph. | ||
|
|
||
|  | ||
|
|
||
|
|
||
| ### More use cases | ||
| We have been beta testing this feature with several different companies and some of the ways that we've seen companies tag their performance data: | ||
| - Tagging controllers | ||
| - Tagging regions | ||
| - Tagging jobs from a redis or sidekiq queue | ||
| - Tagging commits | ||
| - Tagging staging / production environments | ||
| - Tagging different parts of their testing suites | ||
| - Etc... | ||
|
|
||
| ### Future Roadmap | ||
| We would love for you to try out this example and see what ways you can adapt this to your ruby application. Continuous profiling has become an increasingly popular tool for the monitoring and debugging of performance issues (arguably the fourth pillar of observability). | ||
|
|
||
| We'd love to continue to improve this gem by adding things like integrations with popular tools, memory profiling, etc. and we would love to hear what features _you would like to see_. | ||
| Navigate to [Grafana](http://localhost:3000/a/grafana-pyroscope-app/profiles-explorer?explorationType=flame-graph&var-serviceName=ride-sharing-app&var-profileMetricId=process_cpu:cpu:nanoseconds:cpu:nanoseconds) to Explore Profiles. |
Oops, something went wrong.