origin rebase

.github/dependabot.yml

@@ -0,0 +1,18 @@
+version: 2
+updates:
+  - package-ecosystem: pip
+    directory: /
+    schedule:
+      interval: weekly
+    groups:
+      minor:
+        update-types: [minor]
+      major:
+        update-types: [major]
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly
+    groups:
+      all:
+        update-types: [major, minor]

.github/workflows/ci.yml

@@ -13,53 +13,60 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Repository checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
-          python-version: "3.10"
+          python-version: "3.13"
 
       - name: Install dependencies
         run: |
           pip install --upgrade pip tox
 
       - name: Lint
         run: |
-          tox -e lint
+          tox run -e lint
 
   check:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version:
+          - "3.11"
+          - "3.12"
+          - "3.13"
     steps:
       - name: Repository checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
-          python-version: "3.10"
+          python-version: ${{ matrix.python-version }}
 
       - name: Install dependencies
         run: |
           pip install --upgrade pip tox
 
       - name: Check
         run: |
-          tox -e check
+          tox run -e check
 
   test:
     runs-on: ubuntu-latest
     strategy:
       matrix:
         python-version:
-          - "3.10"
           - "3.11"
+          - "3.12"
+          - "3.13"
     steps:
       - name: Repository checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -69,11 +76,4 @@ jobs:
 
       - name: Test
         run: |
-          tox -e coverage -- --cov-report xml:coverage.xml
-
-      - name: Codecov
-        uses: codecov/codecov-action@v3
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }}
-          env_vars: PYTHON
-          full_report: coverage.xml
+          tox run -e coverage

.github/workflows/docker-image.yaml

@@ -0,0 +1,64 @@
+name: Docker image
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - "[0-9]+.[0-9]+.[0-9]+"
+  pull_request:
+    branches:
+      - main
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  build-and-push-image:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+      attestations: write
+      id-token: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: |
+            ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          tags: |
+            type=schedule
+            type=semver,pattern={{version}}
+            type=ref,event=branch
+            type=ref,event=tag
+            type=ref,event=pr
+            type=sha,prefix=sha-
+
+      - name: Build and push Docker image
+        id: push
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+
+      - name: Generate artifact attestation
+        uses: actions/attest-build-provenance@v2
+        with:
+          subject-name: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME}}
+          subject-digest: ${{ steps.push.outputs.digest }}
+          push-to-registry: true

CHANGES.rst

@@ -1,3 +1,92 @@
+v3.1.0 - 2025-01-08
+===================
+
+- Support passing multiple configuration files (#108).
+- Support YAML tags for ``env``, ``file``, and ``include`` (#188).
+
+**NOTE**:
+  The ``env:`` and ``file:`` prefixes for DSNs string form is now deprecated in
+  favor of the corresponding tags, and will be dropped in the next major release.
+
+
+v3.0.0 - 2024-12-30
+===================
+
+- Convert all logging to structured (#199).
+- Look for ``config.yaml`` configuration file by default, configuration file
+  can be optionally specified with ``--config``.
+- Support passing configuration options via environment variables.
+- Support loading ``.env`` file with environment variables for configuration.
+- [docker] Run exporter from the ``/config`` directory, supporting having
+  ``.env`` file there.
+- [snap] Run exporter from the ``$SNAP_DATA`` directory, supporting having
+  ``.env`` file there.
+
+**NOTE**:
+  This release introduces a few breaking changes from the 2.x series,
+  specificially:
+
+  - The ``--log-level`` option now takes lowercase names for levels.
+  - The configuration file is no longer a required option, since
+    ``config.yaml`` in the current directory is looked up automatically. If a
+    different file is specified, it should be done as an optional parameter
+    with ``--config``.
+  - Metrics of type ``counter`` are now set by default to values returned by
+    queries. To preserve the old default behavior of incrementing it by the
+    returned value, ``increment`` should be set to ``true`` in the metric
+    configuration.
+
+
+v2.11.1 - 2024-11-19
+====================
+
+- Update ``prometheus-aioexporter`` dependency range.
+
+
+v2.11.0 - 2024-11-19
+====================
+
+- Switch to SQLAlchemy 2.
+- Require Python 3.11.
+- [docker] Use Python 3.13 on Debian Bookwork as base image.
+- [snap] Rebase on core24.
+
+
+v2.10.0 - 2024-01-28
+====================
+
+- Fix columns names in InvalidResultColumnNames being reported the wrong way
+  round (#185).
+- Add a metric to track query execution timestamp (#178).
+- [docker] Define a volume containing the config file (#158).
+- [docker] Add support for ODBC version 17, support alternative versions.
+- Switch to ruff for formatting.
+
+
+v2.9.2 - 2023-10-28
+===================
+
+- Fix main script (#171).
+- Typos fixes in documentation.
+
+
+v2.9.1 - 2023-10-28
+===================
+
+- Update dependency to ``prometheus-aioexporter`` 2.0.
+- [snap] Add support for ClickHouse.
+- [docker] Add support for ClickHouse.
+
+
+v2.9.0 - 2023-08-18
+===================
+
+- Add ``increment`` flag for counter metrics (#124).
+- Rework project setup.
+- [docker] Add ``pymssql`` package (#133).
+- [docker] Fix setup for Microsoft repository (#159).
+
+
 v2.8.3 - 2022-07-16
 ===================
 
@@ -8,23 +97,23 @@ v2.8.3 - 2022-07-16
 v2.8.2 - 2022-07-16
 ===================
 
-- Require Python 3.10
-- [snap] Change base to core22
-- [docker] Use Python 3.10
-- [docker] Base on Debian 11
+- Require Python 3.10.
+- [snap] Change base to core22.
+- [docker] Use Python 3.10.
+- [docker] Base on Debian 11.
 
 
 v2.8.1 - 2022-02-18
 ===================
 
-- Require `sqlalchemy_aio` 0.17.0, drop workaround for previous versions
+- Require ``sqlalchemy_aio`` 0.17.0, drop workaround for previous versions
   (#105).
 
 
 v2.8.0 - 2022-01-18
 ===================
 
-- Add support for paramters matrix in queries.
+- Add support for parameters matrix in queries.
 - Allow freetext name for databases in config (#99).
 
 
@@ -89,7 +178,7 @@ v2.4.0 - 2020-06-20
 ===================
 
 - Add a ``query_latency`` metric to track query execution times. This is
-  lebeled by database and query name (#46).
+  labeled by database and query name (#46).
 
 
 v2.3.0 - 2020-06-04
@@ -159,7 +248,7 @@ v2.0.0 - 2020-02-02
 
  - Only named parameters with the ``:param`` style are now supported, queries
    using positional parameters or other styles of named parameters need to be
-   udpated.
+   updated.
  - Literal ``:`` at the beginning of a word need to be escaped (with backslash)
    to avoid confusion with parameter markers. Colons that appear inside words
    don't need to be escaped.
@@ -209,13 +298,13 @@ v1.8.0 - 2019-05-25
 - Disable queries that will certainly always fail (e.g. because of invalid.
   returned column names/number) (#6).
 - Support disconnecting from after each query (#8).
-- Rework tests to use actualy SQLite in-memory databases instead of fakes.
+- Rework tests to use actually SQLite in-memory databases instead of fakes.
 
 
 v1.7.0 - 2019-04-07
 ===================
 
-- Add a ``queries`` and ``database_errors`` metrics lebeled by database (#1).
+- Add a ``queries`` and ``database_errors`` metrics labeled by database (#1).
 - Support database DSNs defined as ``env:<VARNAME>`` to supply the dns from the
   environment (#5).
 
@@ -239,7 +328,7 @@ v1.4.0 - 2018-06-08
 ===================
 
 - Support for python3.7.
-- Use asynctest for asyncronous tests.
+- Use asynctest for asynchronous tests.
 - Updated toolrack dependency.
 
 

Dockerfile

@@ -1,11 +1,13 @@
-FROM python:3.10-slim-bullseye AS build-image
+FROM python:3.13-slim-bookworm AS build-image
 
 RUN apt-get update
 RUN apt-get full-upgrade -y
 RUN apt-get install -y --no-install-recommends \
     build-essential \
     curl \
     default-libmysqlclient-dev \
+    freetds-dev \
+    libkrb5-dev \
     libpq-dev \
     pkg-config \
     unixodbc-dev \
@@ -16,18 +18,24 @@ COPY . /srcdir
 RUN python3 -m venv /virtualenv
 ENV PATH="/virtualenv/bin:$PATH"
 RUN pip install \
-    /srcdir \
+    -r /srcdir/requirements.txt \
+    cx-Oracle \
+    clickhouse-sqlalchemy \
+    "ibm-db-sa; platform_machine == 'x86_64' or platform_machine == 'ppc64le'" \
+    mysqlclient \
     psycopg2
 
 RUN curl \
-    https://download.oracle.com/otn_software/linux/instantclient/instantclient-basiclite-linuxx64.zip \
+    https://download.oracle.com/otn_software/linux/instantclient/instantclient-basiclite-linux$(arch | sed -e 's/x86_64/x64/g; s/aarch64/-arm64/g').zip \
     -o instantclient.zip
 RUN unzip instantclient.zip
 RUN mkdir -p /opt/oracle/instantclient
 RUN mv instantclient*/* /opt/oracle/instantclient
 
 
-FROM python:3.10-slim-bullseye
+FROM python:3.13-slim-bookworm
+ARG ODBC_DRIVER_VERSION=18
+ENV ODBC_DRIVER=msodbcsql${ODBC_DRIVER_VERSION}
 
 RUN apt-get update && \
     apt-get full-upgrade -y && \
@@ -42,7 +50,7 @@ RUN apt-get update && \
     curl https://packages.microsoft.com/keys/microsoft.asc | gpg --dearmor > /etc/apt/trusted.gpg.d/microsoft.gpg && \
     (. /etc/os-release; echo "deb https://packages.microsoft.com/debian/$VERSION_ID/prod $VERSION_CODENAME main") > /etc/apt/sources.list.d/mssql-release.list && \
     apt-get update && \
-    ACCEPT_EULA=Y apt-get install -y --no-install-recommends msodbcsql18 && \
+    ACCEPT_EULA=Y apt-get install -y --no-install-recommends $ODBC_DRIVER && \
     rm -rf /var/lib/apt/lists/* /usr/share/doc /usr/share/man && \
     apt-get clean
 
@@ -53,7 +61,10 @@ COPY --from=build-image /srcdir /app
 ENV PATH="/virtualenv/bin:$PATH"
 ENV VIRTUAL_ENV="/virtualenv"
 ENV LD_LIBRARY_PATH="/opt/oracle/instantclient"
+# IPv6 support is not enabled by default, only bind IPv4
+ENV QE_HOST="0.0.0.0"
 
 EXPOSE 9560/tcp
-# IPv6 support is not enabled by default, only bind IPv4
-ENTRYPOINT ["query-exporter", "/config.yaml", "-H", "0.0.0.0"]
+VOLUME /config
+WORKDIR /config
+ENTRYPOINT ["query-exporter"]