Skip to content

Use NaN-safe numpy functions in metric aggregations #312

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Copilot wants to merge 4 commits into
base: master
Choose a base branch
from
Draft

Use NaN-safe numpy functions in metric aggregations #312

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2c1e925
Initial plan
Copilot Dec 4, 2025
c2f875f
Replace numpy functions with NaN-safe variants in metric aggregations
Copilot Dec 4, 2025
0559710
Apply code formatting with black and fix flake8 issues
Copilot Dec 4, 2025
998d276
Address code review feedback
Copilot Dec 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 41 additions & 39 deletions prometheus_api_client/prometheus_connect.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""A Class for collection of metrics from a Prometheus Host."""

from urllib.parse import urlparse
import bz2
import os
Expand Down Expand Up @@ -41,7 +42,7 @@ class PrometheusConnect:
Example: {"http_proxy": "<ip_address/hostname:port>", "https_proxy": "<ip_address/hostname:port>"}
:param session (Optional) Custom requests.Session to enable complex HTTP configuration
:param timeout: (Optional) A timeout (in seconds) applied to all requests
:param method: (Optional) (str) HTTP Method (GET or POST) to use for Query APIs that allow POST
:param method: (Optional) (str) HTTP Method (GET or POST) to use for Query APIs that allow POST
(/query, /query_range and /labels). Use POST for large and complex queries. Default is GET.
"""

Expand All @@ -55,7 +56,7 @@ def __init__(
proxy: dict = None,
session: Session = None,
timeout: int = None,
method: str = "GET"
method: str = "GET",
):
"""Functions as a Constructor for the class PrometheusConnect."""
if url is None:
Expand All @@ -69,7 +70,7 @@ def __init__(

if not isinstance(method, str):
raise TypeError("Method must be a string")

method = method.upper()
if method not in {"GET", "POST"}:
raise ValueError("Method can only be GET or POST")
Expand Down Expand Up @@ -130,7 +131,6 @@ def all_metrics(self, params: dict = None):
self._all_metrics = self.get_label_values(label_name="__name__", params=params)
return self._all_metrics


def get_series(self, start: datetime, end: datetime, params: dict = None):
"""
Get a list series happening between start and end times.
Expand Down Expand Up @@ -165,7 +165,6 @@ def get_series(self, start: datetime, end: datetime, params: dict = None):
)
return labels


def get_label_names(self, params: dict = None):
"""
Get a list of all labels.
Expand Down Expand Up @@ -480,7 +479,13 @@ def custom_query(self, query: str, params: dict = None, timeout: int = None):
return data

def custom_query_range(
self, query: str, start_time: datetime, end_time: datetime, step: str, params: dict = None, timeout: int = None
self,
query: str,
start_time: datetime,
end_time: datetime,
step: str,
params: dict = None,
timeout: int = None,
):
"""
Send a query_range to a Prometheus Host.
Expand Down Expand Up @@ -597,41 +602,40 @@ def get_metric_aggregation(
np_array = numpy.array(query_values)
for operation in operations:
if operation == "sum":
aggregated_values["sum"] = numpy.sum(np_array)
aggregated_values["sum"] = numpy.nansum(np_array)
elif operation == "max":
aggregated_values["max"] = numpy.max(np_array)
aggregated_values["max"] = numpy.nanmax(np_array)
elif operation == "min":
aggregated_values["min"] = numpy.min(np_array)
aggregated_values["min"] = numpy.nanmin(np_array)
elif operation == "average":
aggregated_values["average"] = numpy.average(np_array)
aggregated_values["average"] = numpy.nanmean(np_array)
elif operation.startswith("percentile"):
percentile = float(operation.split("_")[1])
aggregated_values["percentile_" + str(percentile)] = numpy.percentile(
query_values, percentile
aggregated_values["percentile_" + str(percentile)] = numpy.nanpercentile(
np_array, percentile
)
elif operation == "deviation":
aggregated_values["deviation"] = numpy.std(np_array)
aggregated_values["deviation"] = numpy.nanstd(np_array)
elif operation == "variance":
aggregated_values["variance"] = numpy.var(np_array)
aggregated_values["variance"] = numpy.nanvar(np_array)
else:
raise TypeError("Invalid operation: " + operation)
return aggregated_values


def get_scrape_pools(self) -> list[str]:
"""
Get a list of all scrape pools in activeTargets.
"""
scrape_pools = []
for target in self.get_targets()['activeTargets']:
scrape_pools.append(target['scrapePool'])
for target in self.get_targets()["activeTargets"]:
scrape_pools.append(target["scrapePool"])
return list(set(scrape_pools))

def get_targets(self, state: str = None, scrape_pool: str = None):
"""
Get a list of all targets from Prometheus.

:param state: (str) Optional filter for target state ('active', 'dropped', 'any').
:param state: (str) Optional filter for target state ('active', 'dropped', 'any').
If None, returns both active and dropped targets.
:param scrape_pool: (str) Optional filter by scrape pool name
:returns: (dict) A dictionary containing active and dropped targets
Expand All @@ -641,9 +645,9 @@ def get_targets(self, state: str = None, scrape_pool: str = None):
"""
params = {}
if state:
params['state'] = state
params["state"] = state
if scrape_pool:
params['scrapePool'] = scrape_pool
params["scrapePool"] = scrape_pool

response = self._session.request(
method="GET",
Expand All @@ -660,8 +664,7 @@ def get_targets(self, state: str = None, scrape_pool: str = None):
return response.json()["data"]
else:
raise PrometheusApiClientException(
"HTTP Status Code {} ({!r})".format(
response.status_code, response.content)
"HTTP Status Code {} ({!r})".format(response.status_code, response.content)
)

def get_target_metadata(self, target: dict[str, str], metric: str = None):
Expand All @@ -679,12 +682,11 @@ def get_target_metadata(self, target: dict[str, str], metric: str = None):

# Convert target dict to label selector string
if metric:
params['metric'] = metric
params["metric"] = metric

if target:
match_target = "{" + \
",".join(f'{k}="{v}"' for k, v in target.items()) + "}"
params['match_target'] = match_target
match_target = "{" + ",".join(f'{k}="{v}"' for k, v in target.items()) + "}"
params["match_target"] = match_target

response = self._session.request(
method="GET",
Expand All @@ -701,8 +703,7 @@ def get_target_metadata(self, target: dict[str, str], metric: str = None):
return response.json()["data"]
else:
raise PrometheusApiClientException(
"HTTP Status Code {} ({!r})".format(
response.status_code, response.content)
"HTTP Status Code {} ({!r})".format(response.status_code, response.content)
)

def get_metric_metadata(self, metric: str, limit: int = None, limit_per_metric: int = None):
Expand All @@ -721,13 +722,13 @@ def get_metric_metadata(self, metric: str, limit: int = None, limit_per_metric:
params = {}

if metric:
params['metric'] = metric
params["metric"] = metric

if limit:
params['limit'] = limit
params["limit"] = limit

if limit_per_metric:
params['limit_per_metric'] = limit_per_metric
params["limit_per_metric"] = limit_per_metric

response = self._session.request(
method="GET",
Expand All @@ -745,15 +746,16 @@ def get_metric_metadata(self, metric: str, limit: int = None, limit_per_metric:
formatted_data = []
for k, v in data.items():
for v_ in v:
formatted_data.append({
"metric_name": k,
"type": v_.get('type', 'unknown'),
"help": v_.get('help', ''),
"unit": v_.get('unit', '')
})
formatted_data.append(
{
"metric_name": k,
"type": v_.get("type", "unknown"),
"help": v_.get("help", ""),
"unit": v_.get("unit", ""),
}
)
return formatted_data
else:
raise PrometheusApiClientException(
"HTTP Status Code {} ({!r})".format(
response.status_code, response.content)
"HTTP Status Code {} ({!r})".format(response.status_code, response.content)
)
Loading
Loading