Project: Grafana Pyroscope (Observability and Analysis / Observability)
File: ruby-span-profiles.md

title: Span profiles with Traces to profiles for Ruby menuTitle: Span profiles with Traces to profiles (Ruby) description: Learn about and configure Span profiles with Traces to profiles in Grafana for the Ruby language. weight: 102 Span Profiles represents a major shift in profiling methodology, enabling deeper analysis of both tracing and profiling data. Traditional continuous profiling provides an application-wide view over fixed intervals. In contrast, Span Profiles delivers focused, dynamic analysis on specific execution scopes within applications, such as individual requests or specific trace spans. This shift enables a more granular view of performance, enhancing the utility of profiles by linking them directly with traces for a comprehensive understanding of application behavior. As a result, engineering teams can more efficiently identify and address performance bottlenecks. To learn more about Span Profiles, refer to . Pyroscope integrates with distributed tracing systems supporting the standard. This integration lets you link traces with the profiling data and find resource usage for specific lines of code for your trace spans. {{< admonition type="note" >}} Only CPU profiling is supported at the moment. Because of how sampling profilers work, spans shorter than the sample interval may not be captured. {{< /admonition >}} To use Span Profiles, you need to: Configure a client-side package to link traces and profiles: Your applications must be instrumented for profiling and tracing before you can use span profiles. Profiling: Your application must be instrumented with Pyroscope's Ruby SDK. Refer to the guide for instructions. Tracing: Your application must be instrumented with OpenTelemetry traces. Refer to the guide for instructions. To start collecting Span Profiles for your Ruby application, you need to include in your code. This package is a `TracerProvider` implementation, that labels profiling data with span IDs which makes it possible to query for span-specific profiling data in Grafana Tempo UI. ```shell gem install pyroscope-otel ``` Next, you need to create and configure the tracer provider: ```ruby Pyroscope.configure do |config| end OpenTelemetry::SDK.configure do |config| config.addspanprocessor Pyroscope::Otel::SpanProcessor.new( "#{app_name}.cpu", # your app name with ".cpu" suffix, for example rideshare-ruby.cpu pyroscope_endpoint # link to your pyroscope server, for example "http://localhost:4040" ) end ``` To view the span profiles in Grafana Tempo, you need to have a Grafana instance running and a data source configured to link trace spans and profiles. Refer to the to see how to configure the visualization to link trace spans with profiles. To use a simple configuration, follow these steps: Select a Pyroscope data source from the Data source drop-down. Optional: Choose any tags to use in the query. If left blank, the default values of `service.name` and `service.namespace` are used. The tags you configure must be present in the spans attributes or resources for a trace to profiles span link to appear. You can optionally configure a new name for the tag. This is useful for example if the tag has dots in the name and the target data source doesn't allow using dots in labels. In that case you can for example remap service.name to service_name. Select one or more profile types to use in the query. Select the drop-down and choose options from the menu. The profile type or app must be selected for the query to be valid. Grafana doesn't show any data if the profile type or app isnt selected when a query runs. Check out the directory for a complete demo application that shows tracing integration features.