Set Up Profiling

With profiling, Sentry allows you to collect and analyze performance profiles from real user devices in production to give you a complete picture of how your application performs in a variety of environments.

Enable Performance Monitoring

Profiling depends on Sentry’s performance monitoring product being enabled beforehand. To enable performance monitoring in the SDK:

sentry_sdk.init(
  dsn="https://examplePublicKey@o0.ingest.sentry.io/0",
  traces_sample_rate=1.0,
)

Check out the performance setup documentation for more detailed information on how to configure sampling. Setting the sample rate to 1.0 means all transactions will be captured. By default, some transactions will be created automatically for common operations like loading a view controller/activity and app startup.

Enable Profiling

import sentry_sdk

def profiles_sampler(sampling_context):
    # ...
    # return a number between 0 and 1 or a boolean

sentry_sdk.init(
    dsn="https://examplePublicKey@o0.ingest.sentry.io/0",
    traces_sample_rate=1.0,

    # To set a uniform sample rate
    # Set profiles_sample_rate to 1.0 to profile 100%
    # of sampled transactions.
    # We recommend adjusting this value in production,
    profiles_sample_rate=1.0,

    # Alternatively, to control sampling dynamically
    profiles_sampler=profiles_sampler
)

Upgrading from older SDK versions

The feature was experimental prior to version 1.17.0. To update to the latest SDK, remove profiles_sample_rate from _experiments and set it in the top-level options.

sentry_sdk.init(
    dsn="https://examplePublicKey@o0.ingest.sentry.io/0",
    traces_sample_rate=1.0,
    _experiments={
      "profiles_sample_rate": 1.0,  # for versions before 1.17.0
    },
)

Troubleshooting

If you don't see any profiling data in sentry.io, you can try the following:

• Ensure that performance monitoring is enabled.
• Ensure that the automatic instrumentation is sending performance data to Sentry by going to the Performance page in sentry.io.
• If the automatic instrumentation is not sending performance data, try using custom instrumentation.
• Enable debug mode in the SDK and check the logs.