PythonPerformance Metrics
Sentry's SDKs support sending performance metrics data to Sentry. These are numeric values attached to transactions that are aggregated and displayed in Sentry.
In addition to automatic performance metrics, the SDK supports setting custom performance metrics on transactions. This allows you to define metrics that are important to your application and send them to Sentry.
To set a performance metric, you need to supply the following:
- name (
string) - value (any numeric type -
float,integer, etc.) - unit (
string, Defaults to the stringnoneif omitted.)
Sentry supports adding arbitrary custom units, but we recommend using one of the supported units listed below.
Adding custom metrics is supported in Sentry's Python SDK version 1.16.0 and above.
sentry_sdk.init(
dsn="https://examplePublicKey@o0.ingest.sentry.io/0",
)
To capture in the SDK:
from sentry_sdk import set_measurement
# Record amount of memory used
set_measurement('memory_used', 123, 'byte')
# Record time when job was started
set_measurement('job_start_time', 1.3, 'second')
# Record amount of times cache was read
set_measurement('cache_read_count', 4)
The feature was marked experimental between versions 1.5.12 and 1.16.0. To enable the capturing of custom metrics before 1.16.0, you'll need to enable the custom_measurements experiment option and fetch the transaction manually.
sentry_sdk.init(
dsn="https://examplePublicKey@o0.ingest.sentry.io/0",
_experiments={
"custom_measurements": True, # for versions before 1.16.0
},
)
transaction = Hub.current.scope.transaction
if transaction:
transaction.set_measurement('memory_used', 123, 'byte')
Currently, unit conversion is only supported once the data has already been stored. This means that, for example, ('myMetric', 60, 'second') and ('myMetric', 3, 'minute') would not be aggregated, but rather stored as two separate metrics. To avoid this, make sure to use a consistent unit when recording a custom metric.
Units augment metric values by giving meaning to what otherwise might be abstract numbers. Adding units also allows Sentry to offer controls - unit conversions, filters, and so on - based on those units. For values that are unitless, you can supply an empty string or none.
nanosecondmicrosecondmillisecondsecondminutehourdayweek
bitbytekilobytekibibytemegabytemebibytegigabytegibibyteterabytetebibytepetabytepebibyteexabyteexbibyte
ratiopercent
For more details about supported units, see our event ingestion documentation.
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").
- Package:
- pypi:sentry-sdk
- Version:
- 2.0.0
- Repository:
- https://github.com/getsentry/sentry-python
- API Documentation:
- https://getsentry.github.io/sentry-python/