garf-prometheus 0.0.1__tar.gz

garf_prometheus-0.0.1/PKG-INFO

@@ -0,0 +1,88 @@
+Metadata-Version: 2.4
+Name: garf-prometheus
+Version: 0.0.1
+Summary: Garf implementation for Prometheus API
+Author-email: Andrei Markin <amarkin@google.com>, "Google Inc. (gTech gPS CSE team)" <no-reply@google.com>
+License: Apache 2.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: garf-core[pandas]>=1.1.2
+Requires-Dist: garf-io>=1.0.0
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: pytest-mock; extra == "test"
+Requires-Dist: python-dotenv; extra == "test"
+
+# `garf` for Prometheus HTTP API
+
+[![PyPI](https://img.shields.io/pypi/v/garf-prometheus?logo=pypi&logoColor=white&style=flat-square)](https://pypi.org/project/garf-prometheus)
+[![Downloads PyPI](https://img.shields.io/pypi/dw/garf-prometheus?logo=pypi)](https://pypi.org/project/garf-prometheus/)
+
+`garf-prometheus` simplifies fetching data from Prometheus HTTP API using SQL-like queries.
+
+## Prerequisites
+
+* Running Prometheus instance
+
+## Installation
+
+`pip install garf-prometheus`
+
+## Usage
+
+### Run as a library
+```
+import os
+
+from garf.io import writer
+from garf.community.prometheus import PrometheusApiReportFetcher
+
+query = """
+SELECT
+  timestamp,
+  instance,
+  job,
+  value
+FROM query
+WHERE query = up
+"""
+
+fetched_report = (
+  PrometheusApiReportFetcher(
+    endpoint='http://localhost:9090'
+  )
+  .fetch(query)
+)
+
+console_writer = writer.create_writer('console')
+console_writer.write(fetched_report, 'query')
+```
+
+### Run via CLI
+
+> Install `garf-executors` package to run queries via CLI (`pip install garf-executors`).
+
+```
+garf <PATH_TO_QUERIES> --source prometheus \
+  --output <OUTPUT_TYPE> \
+  --prometheus.endpoint=http://localhost:9090
+```
+
+where:
+
+* `PATH_TO_QUERIES` - local or remove files containing queries
+* `output` - output supported by [`garf-io` library](https://google.github.io/garf/usage/writers/).
+* `SOURCE_PARAMETER=VALUE` - key-value pairs to refine fetching, check [available source parameters](#available-source-parameters).
+
+###  Available source parameters
+
+| name | values| comments |
+|----- | ----- | -------- |
+| `endpoint`   | Base URL when Prometheus is running (`http://localhost:9090` by default) |
+
+## Documentation
+
+You can find a documentation on `garf-prometheus` [here](https://google.github.io/garf/fetchers/prometheus/).

garf_prometheus-0.0.1/README.md

@@ -0,0 +1,70 @@
+# `garf` for Prometheus HTTP API
+
+[![PyPI](https://img.shields.io/pypi/v/garf-prometheus?logo=pypi&logoColor=white&style=flat-square)](https://pypi.org/project/garf-prometheus)
+[![Downloads PyPI](https://img.shields.io/pypi/dw/garf-prometheus?logo=pypi)](https://pypi.org/project/garf-prometheus/)
+
+`garf-prometheus` simplifies fetching data from Prometheus HTTP API using SQL-like queries.
+
+## Prerequisites
+
+* Running Prometheus instance
+
+## Installation
+
+`pip install garf-prometheus`
+
+## Usage
+
+### Run as a library
+```
+import os
+
+from garf.io import writer
+from garf.community.prometheus import PrometheusApiReportFetcher
+
+query = """
+SELECT
+  timestamp,
+  instance,
+  job,
+  value
+FROM query
+WHERE query = up
+"""
+
+fetched_report = (
+  PrometheusApiReportFetcher(
+    endpoint='http://localhost:9090'
+  )
+  .fetch(query)
+)
+
+console_writer = writer.create_writer('console')
+console_writer.write(fetched_report, 'query')
+```
+
+### Run via CLI
+
+> Install `garf-executors` package to run queries via CLI (`pip install garf-executors`).
+
+```
+garf <PATH_TO_QUERIES> --source prometheus \
+  --output <OUTPUT_TYPE> \
+  --prometheus.endpoint=http://localhost:9090
+```
+
+where:
+
+* `PATH_TO_QUERIES` - local or remove files containing queries
+* `output` - output supported by [`garf-io` library](https://google.github.io/garf/usage/writers/).
+* `SOURCE_PARAMETER=VALUE` - key-value pairs to refine fetching, check [available source parameters](#available-source-parameters).
+
+###  Available source parameters
+
+| name | values| comments |
+|----- | ----- | -------- |
+| `endpoint`   | Base URL when Prometheus is running (`http://localhost:9090` by default) |
+
+## Documentation
+
+You can find a documentation on `garf-prometheus` [here](https://google.github.io/garf/fetchers/prometheus/).

garf_prometheus-0.0.1/garf/community/prometheus/__init__.py

@@ -0,0 +1,17 @@
+# Copyright 2026 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Library for interacting with Prometheus Query API via garf."""
+
+__version__ = '0.0.1'

garf_prometheus-0.0.1/garf/community/prometheus/api_clients.py

@@ -0,0 +1,66 @@
+# Copyright 2026 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Handles to Prometheus HTTP API querying."""
+
+import requests
+from garf.community.prometheus import exceptions, query_editor
+from garf.core import api_clients
+
+
+class PrometheusApiClientError(exceptions.PrometheusApiError):
+  """Prometheus HTTP API specific error."""
+
+
+class PrometheusApiClient(api_clients.RestApiClient):
+  """Specifies client for interacting with Prometheus HTTP API."""
+
+  def get_response(
+    self,
+    request: query_editor.PrometheusApiQuery,
+    **kwargs: str,
+  ) -> api_clients.GarfApiResponse:
+    url = f'{self.endpoint}/api/v1/{request.resource_name}'
+    params = {}
+    for field in request.fields:
+      if field == 'timestamp':
+        continue
+      params['query'] = field
+    for element in request.filters:
+      key, value = element.split(' = ')
+      params[key.strip()] = value.strip().replace(' ', '')
+    headers = {k: v for k, v in kwargs.items() if not isinstance(v, bool)}
+    response = requests.get(url, params=params, headers=headers)
+    if response.status_code == self.OK:
+      results = response.json()
+      if request.resource_name == 'query_range':
+        results = results.get('data').get('result')
+        final_results = []
+        for r in results:
+          labels = r.get('metric')
+          for row in r.get('values'):
+            values = dict(zip(['timestamp', 'value'], row))
+            final_results.append({**values, **labels})
+
+      if request.resource_name == 'query':
+        results = results.get('data').get('result')
+        final_results = []
+        for row in results:
+          values = dict(zip(['timestamp', 'value'], row.get('value')))
+          labels = row.get('metric')
+          final_results.append({**values, **labels})
+      return api_clients.GarfApiResponse(results=final_results)
+    raise PrometheusApiClientError(
+      'Failed to get data from Prometheus HTTP API, reason: ', response.text
+    )

garf_prometheus-0.0.1/garf/community/prometheus/exceptions.py

@@ -0,0 +1,19 @@
+# Copyright 2026 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from garf.core import exceptions
+
+
+class PrometheusApiError(exceptions.GarfError):
+  """Prometheus Query API error."""

garf_prometheus-0.0.1/garf/community/prometheus/query_editor.py

@@ -0,0 +1,19 @@
+# Copyright 2026 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from garf.core import query_editor
+
+
+class PrometheusApiQuery(query_editor.QuerySpecification):
+  """Query to Prometheus API."""

garf_prometheus-0.0.1/garf/community/prometheus/report_fetcher.py

@@ -0,0 +1,45 @@
+# Copyright 2026 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import garf.core
+from garf.community.prometheus import api_clients, query_editor
+
+
+class PrometheusApiReportFetcher(garf.core.ApiReportFetcher):
+  """Defines report fetcher for Prometheus API."""
+
+  alias = 'prometheus'
+
+  def __init__(
+    self,
+    api_client: api_clients.PrometheusApiClient | None = None,
+    parser: garf.core.parsers.DictParser = (
+      garf.core.parsers.NumericConverterDictParser
+    ),
+    query_spec: query_editor.PrometheusApiQuery = (
+      query_editor.PrometheusApiQuery
+    ),
+    parallel_threshold: int = 10,
+    **kwargs: str,
+  ) -> None:
+    """Initializes PrometheusApiReportFetcher."""
+    if not api_client:
+      api_client = api_clients.PrometheusApiClient(**kwargs)
+    self.parallel_threshold = parallel_threshold
+    super().__init__(
+      api_client=api_client,
+      parser=parser,
+      query_specification_builder=query_spec,
+      **kwargs,
+    )

garf_prometheus-0.0.1/garf/community/prometheus/telemetry.py

@@ -0,0 +1,17 @@
+# Copyright 2026 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from opentelemetry import trace
+
+tracer = trace.get_tracer(instrumenting_module_name='garf.community.prometheus')

garf_prometheus-0.0.1/garf_prometheus.egg-info/PKG-INFO

@@ -0,0 +1,88 @@
+Metadata-Version: 2.4
+Name: garf-prometheus
+Version: 0.0.1
+Summary: Garf implementation for Prometheus API
+Author-email: Andrei Markin <amarkin@google.com>, "Google Inc. (gTech gPS CSE team)" <no-reply@google.com>
+License: Apache 2.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: garf-core[pandas]>=1.1.2
+Requires-Dist: garf-io>=1.0.0
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: pytest-mock; extra == "test"
+Requires-Dist: python-dotenv; extra == "test"
+
+# `garf` for Prometheus HTTP API
+
+[![PyPI](https://img.shields.io/pypi/v/garf-prometheus?logo=pypi&logoColor=white&style=flat-square)](https://pypi.org/project/garf-prometheus)
+[![Downloads PyPI](https://img.shields.io/pypi/dw/garf-prometheus?logo=pypi)](https://pypi.org/project/garf-prometheus/)
+
+`garf-prometheus` simplifies fetching data from Prometheus HTTP API using SQL-like queries.
+
+## Prerequisites
+
+* Running Prometheus instance
+
+## Installation
+
+`pip install garf-prometheus`
+
+## Usage
+
+### Run as a library
+```
+import os
+
+from garf.io import writer
+from garf.community.prometheus import PrometheusApiReportFetcher
+
+query = """
+SELECT
+  timestamp,
+  instance,
+  job,
+  value
+FROM query
+WHERE query = up
+"""
+
+fetched_report = (
+  PrometheusApiReportFetcher(
+    endpoint='http://localhost:9090'
+  )
+  .fetch(query)
+)
+
+console_writer = writer.create_writer('console')
+console_writer.write(fetched_report, 'query')
+```
+
+### Run via CLI
+
+> Install `garf-executors` package to run queries via CLI (`pip install garf-executors`).
+
+```
+garf <PATH_TO_QUERIES> --source prometheus \
+  --output <OUTPUT_TYPE> \
+  --prometheus.endpoint=http://localhost:9090
+```
+
+where:
+
+* `PATH_TO_QUERIES` - local or remove files containing queries
+* `output` - output supported by [`garf-io` library](https://google.github.io/garf/usage/writers/).
+* `SOURCE_PARAMETER=VALUE` - key-value pairs to refine fetching, check [available source parameters](#available-source-parameters).
+
+###  Available source parameters
+
+| name | values| comments |
+|----- | ----- | -------- |
+| `endpoint`   | Base URL when Prometheus is running (`http://localhost:9090` by default) |
+
+## Documentation
+
+You can find a documentation on `garf-prometheus` [here](https://google.github.io/garf/fetchers/prometheus/).

garf_prometheus-0.0.1/garf_prometheus.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+README.md
+pyproject.toml
+garf/community/prometheus/__init__.py
+garf/community/prometheus/api_clients.py
+garf/community/prometheus/exceptions.py
+garf/community/prometheus/query_editor.py
+garf/community/prometheus/report_fetcher.py
+garf/community/prometheus/telemetry.py
+garf_prometheus.egg-info/PKG-INFO
+garf_prometheus.egg-info/SOURCES.txt
+garf_prometheus.egg-info/dependency_links.txt
+garf_prometheus.egg-info/entry_points.txt
+garf_prometheus.egg-info/requires.txt
+garf_prometheus.egg-info/top_level.txt

garf_prometheus-0.0.1/garf_prometheus.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

garf_prometheus-0.0.1/garf_prometheus.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[garf]
+prometheus = garf.community.prometheus.report_fetcher

garf_prometheus-0.0.1/garf_prometheus.egg-info/requires.txt

@@ -0,0 +1,8 @@
+garf-core[pandas]>=1.1.2
+garf-io>=1.0.0
+
+[test]
+pytest
+pytest-cov
+pytest-mock
+python-dotenv

garf_prometheus-0.0.1/garf_prometheus.egg-info/top_level.txt

@@ -0,0 +1 @@
+garf

garf_prometheus-0.0.1/pyproject.toml

@@ -0,0 +1,41 @@
+[build-system]
+requires = ["setuptools >= 61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "garf-prometheus"
+dependencies = [
+  "garf-core[pandas]>=1.1.2",
+  "garf-io>=1.0.0",
+]
+authors = [
+  {name = "Andrei Markin", email = "amarkin@google.com"},
+  {name = "Google Inc. (gTech gPS CSE team)", email = "no-reply@google.com"},
+]
+license = {text = "Apache 2.0"}
+requires-python = ">=3.9"
+description = "Garf implementation for Prometheus API"
+readme = "README.md"
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Programming Language :: Python"
+]
+
+dynamic=["version"]
+
+[tool.setuptools.dynamic]
+version = {attr = "garf.community.prometheus.__version__"}
+
+[project.entry-points.garf]
+prometheus = "garf.community.prometheus.report_fetcher"
+
+[project.optional-dependencies]
+test =  [
+  "pytest",
+  "pytest-cov",
+  "pytest-mock",
+  "python-dotenv",
+]
+[tool.setuptools.packages.find]
+where = ["."]
+include=["garf.*"]

garf_prometheus-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+