EXPAND ALL
  • Home
Open Source Docs

px.otel.metric.Summary

Defines the DataFrame mapping to an OpenTelemetry Metric Summary

Summaries describe distributions by recording quantile values (aka percentile values) such as p50, p90 and p99. User specify as many of these point values as they like, labeling them with the float equivalent position in the distribution. Ie p50 would be labeled 0.5, p99 as 0.99. The source DataFrame must have a time_ column of type TIME64NS or the compiler will throw an error. The unit of this metric will be inferred from the SemanticType of the column value.

Arguments

NameTypeDescription
namestringThe name of the metric.
countColumnThe column of the count of elements inside each summary. Must be INT64
sumColumnThe column of the sum of elements in inside each summary to use for the Summary. Must be FLOAT64
quantile_valuesDict[float, Column]The mapping of the quantile value to the DataFrame column containing the quantile value information. Must be FLOAT64.
descriptionstring, optionalA description of what the metric tracks.
attributesDict[double, Column], optionalA mapping of attribute name to the column name that stores data about the attribute.
unitstring, optionalThe unit string to use for the metric. If not specified, will attempt to use the Semantic Type of the quantile values to infer the unit string.

Returns

OTelDataContainer: the mapping of DataFrame columns to OpenTelemetry Summary fields. Can be passed into px.otel.Data() as the data argument.

This site uses cookies to provide you with a better user experience. By using Pixie, you consent to our use of cookies.