diff --git a/conftest.py b/conftest.py new file mode 100644 index 0000000..a214f82 --- /dev/null +++ b/conftest.py @@ -0,0 +1,15 @@ +import pytest +from quart import Quart + + +@pytest.fixture +def app(): + app = Quart("testapp") + @app.route + async def index(): + return 'hi' + return app + +@pytest.fixture +def client(app): + return app.test_client() \ No newline at end of file diff --git a/pylintrc b/pylintrc new file mode 100644 index 0000000..61d7324 --- /dev/null +++ b/pylintrc @@ -0,0 +1,577 @@ +[MASTER] + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code. +extension-pkg-whitelist= + +# Add files or directories to the blacklist. They should be base names, not +# paths. +ignore=CVS + +# Add files or directories matching the regex patterns to the blacklist. The +# regex matches against base names, not paths. +ignore-patterns=test_.* + +# Python code to execute, usually for sys.path manipulation such as +# pygtk.require(). +#init-hook= + +# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the +# number of processors available to use. +jobs=1 + +# Control the amount of potential inferred values when inferring a single +# object. This can help the performance when dealing with large functions or +# complex, nested conditions. +limit-inference-results=100 + +# List of plugins (as comma separated values of python modules names) to load, +# usually to register additional checkers. +load-plugins= + +# Pickle collected data for later comparisons. +persistent=yes + +# Specify a configuration file. +#rcfile= + +# When enabled, pylint would attempt to guess common misconfiguration and emit +# user-friendly hints instead of false-positive error messages. +suggestion-mode=yes + +# Allow loading of arbitrary C extensions. Extensions are imported into the +# active Python interpreter and may run arbitrary code. +unsafe-load-any-extension=no + + +[MESSAGES CONTROL] + +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED. +confidence= + +# Disable the message, report, category or checker with the given id(s). You +# can either give multiple identifiers separated by comma (,) or put this +# option multiple times (only on the command line, not in the configuration +# file where it should appear only once). You can also use "--disable=all" to +# disable everything first and then reenable specific checks. For example, if +# you want to run only the similarities checker, you can use "--disable=all +# --enable=similarities". If you want to run only the classes checker, but have +# no Warning level messages displayed, use "--disable=all --enable=classes +# --disable=W". +disable=print-statement, + parameter-unpacking, + unpacking-in-except, + old-raise-syntax, + backtick, + long-suffix, + old-ne-operator, + old-octal-literal, + import-star-module-level, + non-ascii-bytes-literal, + raw-checker-failed, + bad-inline-option, + bad-continuation, + locally-disabled, + file-ignored, + suppressed-message, + useless-suppression, + deprecated-pragma, + use-symbolic-message-instead, + apply-builtin, + basestring-builtin, + buffer-builtin, + cmp-builtin, + coerce-builtin, + execfile-builtin, + file-builtin, + long-builtin, + raw_input-builtin, + reduce-builtin, + standarderror-builtin, + unicode-builtin, + xrange-builtin, + coerce-method, + delslice-method, + getslice-method, + setslice-method, + no-absolute-import, + old-division, + dict-iter-method, + dict-view-method, + next-method-called, + metaclass-assignment, + indexing-exception, + raising-string, + reload-builtin, + oct-method, + hex-method, + nonzero-method, + cmp-method, + input-builtin, + round-builtin, + intern-builtin, + unichr-builtin, + map-builtin-not-iterating, + zip-builtin-not-iterating, + range-builtin-not-iterating, + filter-builtin-not-iterating, + using-cmp-argument, + eq-without-hash, + div-method, + idiv-method, + rdiv-method, + exception-message-attribute, + invalid-str-codec, + sys-max-int, + bad-python3-import, + deprecated-string-function, + deprecated-str-translate-call, + deprecated-itertools-function, + deprecated-types-field, + next-method-defined, + dict-items-not-iterating, + dict-keys-not-iterating, + dict-values-not-iterating, + deprecated-operator-function, + deprecated-urllib-function, + xreadlines-attribute, + deprecated-sys-function, + exception-escape, + comprehension-escape, + cyclic-import, + duplicate-code, + unnecessary-pass, + ungrouped-imports, # Temporary, until Pylint bug is resolved. + import-outside-toplevel, + +# Enable the message, report, category or checker with the given id(s). You can +# either give multiple identifier separated by comma (,) or put this option +# multiple time (only on the command line, not in the configuration file where +# it should appear only once). See also the "--disable" option for examples. +enable=c-extension-no-member + + +[REPORTS] + +# Python expression which should return a note less than 10 (10 is the highest +# note). You have access to the variables errors warning, statement which +# respectively contain the number of errors / warnings messages and the total +# number of statements analyzed. This is used by the global evaluation report +# (RP0004). +evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) + +# Template used to display messages. This is a python new-style format string +# used to format the message information. See doc for all details. +#msg-template= + +# Set the output format. Available formats are text, parseable, colorized, json +# and msvs (visual studio). You can also give a reporter class, e.g. +# mypackage.mymodule.MyReporterClass. +output-format=text + +# Tells whether to display a full report or only the messages. +reports=no + +# Activate the evaluation score. +score=yes + + +[REFACTORING] + +# Maximum number of nested blocks for function / method body +max-nested-blocks=5 + +# Complete name of functions that never returns. When checking for +# inconsistent-return-statements if a never returning function is called then +# it will be considered as an explicit return statement and no message will be +# printed. +never-returning-functions=sys.exit + + +[LOGGING] + +# Format style used to check logging format string. `old` means using % +# formatting, while `new` is for `{}` formatting. +logging-format-style=old + +# Logging modules to check that the string format arguments are in logging +# function parameter format. +logging-modules=logging + + +[SPELLING] + +# Limits count of emitted suggestions for spelling mistakes. +max-spelling-suggestions=4 + +# Spelling dictionary name. Available dictionaries: none. To make it working +# install python-enchant package.. +spelling-dict= + +# List of comma separated words that should not be checked. +spelling-ignore-words= + +# A path to a file that contains private dictionary; one word per line. +spelling-private-dict-file= + +# Tells whether to store unknown words to indicated private dictionary in +# --spelling-private-dict-file option instead of raising a message. +spelling-store-unknown-words=no + + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +notes=FIXME, + + +[TYPECHECK] + +# List of decorators that produce context managers, such as +# contextlib.contextmanager. Add to this list to register other decorators that +# produce valid context managers. +contextmanager-decorators=contextlib.contextmanager + +# List of members which are set dynamically and missed by pylint inference +# system, and so shouldn't trigger E1101 when accessed. Python regular +# expressions are accepted. +generated-members= + +# Tells whether missing members accessed in mixin class should be ignored. A +# mixin class is detected if its name ends with "mixin" (case insensitive). +ignore-mixin-members=yes + +# Tells whether to warn about missing members when the owner of the attribute +# is inferred to be None. +ignore-none=yes + +# This flag controls whether pylint should warn about no-member and similar +# checks whenever an opaque object is returned when inferring. The inference +# can return multiple potential results while evaluating a Python object, but +# some branches might not be evaluated, which results in partial inference. In +# that case, it might be useful to still emit no-member and other checks for +# the rest of the inferred objects. +ignore-on-opaque-inference=yes + +# List of class names for which member attributes should not be checked (useful +# for classes with dynamically set attributes). This supports the use of +# qualified names. +ignored-classes=optparse.Values,thread._local,_thread._local + +# List of module names for which member attributes should not be checked +# (useful for modules/projects where namespaces are manipulated during runtime +# and thus existing member attributes cannot be deduced by static analysis. It +# supports qualified module names, as well as Unix pattern matching. +ignored-modules=alembic.context, alembic.op + +# Show a hint with possible names when a member name was not found. The aspect +# of finding the hint is based on edit distance. +missing-member-hint=yes + +# The minimum edit distance a name should have in order to be considered a +# similar match for a missing member name. +missing-member-hint-distance=1 + +# The total number of similar names that should be taken in consideration when +# showing a hint for a missing member. +missing-member-max-choices=1 + + +[VARIABLES] + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid defining new builtins when possible. +additional-builtins= + +# Tells whether unused global variables should be treated as a violation. +allow-global-unused-variables=yes + +# List of strings which can identify a callback function by name. A callback +# name must start or end with one of those strings. +callbacks=cb_, + _cb + +# A regular expression matching the name of dummy variables (i.e. expected to +# not be used). +dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ + +# Argument names that match this expression will be ignored. Default to name +# with leading underscore. +ignored-argument-names=_.*|^ignored_|^unused_|args|kwargs + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io + + +[FORMAT] + +# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. +expected-line-ending-format= + +# Regexp for a line that is allowed to be longer than the limit. +ignore-long-lines=^\s*(# )??$ + +# Number of spaces of indent required inside a hanging or continued line. +indent-after-paren=4 + +# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 +# tab). +indent-string=' ' + +# Maximum number of characters on a single line. +max-line-length=115 + +# Maximum number of lines in a module. +max-module-lines=1000 + +# List of optional constructs for which whitespace checking is disabled. `dict- +# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. +# `trailing-comma` allows a space between comma and closing bracket: (a, ). +# `empty-line` allows space-only lines. +no-space-check=trailing-comma, + dict-separator + +# Allow the body of a class to be on the same line as the declaration if body +# contains single statement. +single-line-class-stmt=no + +# Allow the body of an if to be on the same line as the test if there is no +# else. +single-line-if-stmt=no + + +[SIMILARITIES] + +# Ignore comments when computing similarities. +ignore-comments=yes + +# Ignore docstrings when computing similarities. +ignore-docstrings=yes + +# Ignore imports when computing similarities. +ignore-imports=no + +# Minimum lines number of a similarity. +min-similarity-lines=4 + + +[BASIC] + +# Naming style matching correct argument names. +argument-naming-style=snake_case + +# Regular expression matching correct argument names. Overrides argument- +# naming-style. +#argument-rgx= + +# Naming style matching correct attribute names. +attr-naming-style=snake_case + +# Regular expression matching correct attribute names. Overrides attr-naming- +# style. +#attr-rgx= + +# Bad variable names which should always be refused, separated by a comma. +bad-names=foo, + bar, + baz, + toto, + tutu, + tata + +# Naming style matching correct class attribute names. +class-attribute-naming-style=any + +# Regular expression matching correct class attribute names. Overrides class- +# attribute-naming-style. +#class-attribute-rgx= + +# Naming style matching correct class names. +class-naming-style=PascalCase + +# Regular expression matching correct class names. Overrides class-naming- +# style. +#class-rgx= + +# Naming style matching correct constant names. +const-naming-style=UPPER_CASE + +# Regular expression matching correct constant names. Overrides const-naming- +# style. +#const-rgx= + +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=-1 + +# Naming style matching correct function names. +function-naming-style=snake_case + +# Regular expression matching correct function names. Overrides function- +# naming-style. +#function-rgx= + +# Good variable names which should always be accepted, separated by a comma. +good-names=i, + j, + k, + ex, + Run, + _, + app, + blueprint, + logger + +# Include a hint for the correct naming format with invalid-name. +include-naming-hint=no + +# Naming style matching correct inline iteration names. +inlinevar-naming-style=any + +# Regular expression matching correct inline iteration names. Overrides +# inlinevar-naming-style. +#inlinevar-rgx= + +# Naming style matching correct method names. +method-naming-style=snake_case + +# Regular expression matching correct method names. Overrides method-naming- +# style. +#method-rgx= + +# Naming style matching correct module names. +module-naming-style=snake_case + +# Regular expression matching correct module names. Overrides module-naming- +# style. +#module-rgx= + +# Colon-delimited sets of names that determine each other's naming style when +# the name regexes allow several styles. +name-group= + +# Regular expression which should only match function or class names that do +# not require a docstring. +no-docstring-rgx=^_ + +# List of decorators that produce properties, such as abc.abstractproperty. Add +# to this list to register other decorators that produce valid properties. +# These decorators are taken in consideration only for invalid-name. +property-classes=abc.abstractproperty + +# Naming style matching correct variable names. +variable-naming-style=snake_case + +# Regular expression matching correct variable names. Overrides variable- +# naming-style. +#variable-rgx= + + +[STRING] + +# This flag controls whether the implicit-str-concat-in-sequence should +# generate a warning on implicit string concatenation in sequences defined over +# several lines. +check-str-concat-over-line-jumps=no + + +[IMPORTS] + +# Allow wildcard imports from modules that define __all__. +allow-wildcard-with-all=no + +# Analyse import fallback blocks. This can be used to support both Python 2 and +# 3 compatible code, which means that the block might have code that exists +# only in one or another interpreter, leading to false positives when analysed. +analyse-fallback-blocks=no + +# Deprecated modules which should not be used, separated by a comma. +deprecated-modules=optparse,tkinter.tix + +# Create a graph of external dependencies in the given file (report RP0402 must +# not be disabled). +ext-import-graph= + +# Create a graph of every (i.e. internal and external) dependencies in the +# given file (report RP0402 must not be disabled). +import-graph= + +# Create a graph of internal dependencies in the given file (report RP0402 must +# not be disabled). +int-import-graph= + +# Force import order to recognize a module as part of the standard +# compatibility libraries. +known-standard-library= + +# Force import order to recognize a module as part of a third party library. +known-third-party=enchant + + +[CLASSES] + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__, + __new__, + setUp + +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict, + _fields, + _replace, + _source, + _make + +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls + +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=cls + + +[DESIGN] + +# Maximum number of arguments for function / method. +max-args=5 + +# Maximum number of attributes for a class (see R0902). +max-attributes=20 + +# Maximum number of boolean expressions in an if statement. +max-bool-expr=5 + +# Maximum number of branch for function / method body. +max-branches=12 + +# Maximum number of locals for function / method body. +max-locals=15 + +# Maximum number of parents for a class (see R0901). +max-parents=7 + +# Maximum number of public methods for a class (see R0904). +max-public-methods=20 + +# Maximum number of return / yield for function / method body. +max-returns=6 + +# Maximum number of statements in function / method body. +max-statements=50 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=2 + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when being caught. Defaults to +# "BaseException, Exception". +overgeneral-exceptions=BaseException, + Exception diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..3e657bb --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,3 @@ +[tool.black] +line-length = 115 +target-version = ["py37"] diff --git a/quart_prometheus_logger.py b/quart_prometheus_logger.py index 5d86851..7de9544 100644 --- a/quart_prometheus_logger.py +++ b/quart_prometheus_logger.py @@ -2,11 +2,14 @@ from __future__ import annotations import logging +import uuid from typing import TYPE_CHECKING, Callable, Dict, List, Optional, Union -from prometheus_client import CONTENT_TYPE_LATEST, REGISTRY, Counter, Histogram, generate_latest + +from prometheus_client import CONTENT_TYPE_LATEST, Counter, Histogram, generate_latest, CollectorRegistry from quart import Response, g, request from quart.exceptions import HTTPException, HTTPStatusException -from .utils import now_utc + +from utils import now_utc if TYPE_CHECKING: from quart import Quart @@ -48,6 +51,8 @@ def linear_bucket(start: int, width: int, count: int) -> List[int]: *linear_bucket(1000000, 10000, 5), ) +EntityID = Union[str, uuid.UUID] + class PrometheusRegistry: """A prometheus logger. @@ -66,6 +71,7 @@ def __init__(self, app: Optional[Quart] = None, metrics_endpoint: str = "root"): self._collectors: Dict[str, MetricType] = {} self._custom_labeler: Optional[Callable[["LocalProxy"], Dict[str, str]]] = None self._custom_label_names: List[str] = [] + self._registry = CollectorRegistry() self._register_collectors() if app: self.init_app(app, metrics_endpoint) @@ -73,7 +79,7 @@ def __init__(self, app: Optional[Quart] = None, metrics_endpoint: str = "root"): def init_app(self, app: Quart, metrics_endpoint: str): """Register an application.""" - def start_request(): + def on_request_start(): if request.path == "/metrics": return g.start = now_utc() # type: ignore # This is a valid use of Quart's global object @@ -82,7 +88,7 @@ def start_request(): request.content_length or 0 ) - def end_request(response): + def on_request_end(response: Response): if request.path == "/metrics": return response if not hasattr(g, "start"): @@ -105,17 +111,27 @@ def end_request(response): ).inc() return response - def abort_with_error(exc: Union[HTTPException, Exception]) -> Response: + def on_request_error(exc: Union[HTTPException, Exception]) -> Response: if isinstance(exc, HTTPException): response = exc.get_response() else: response = Response("", 500) - return end_request(response) + return on_request_end(response) self.app = app - app.before_request(start_request) - app.after_request(end_request) - app.register_error_handler(HTTPStatusException, abort_with_error) + app.before_request( + on_request_start, + on_request_start.__name__, + ) + app.after_request( + on_request_end, + on_request_end.__name__, + ) + app.register_error_handler( + HTTPStatusException, + on_request_error, # type: ignore + on_request_error.__name__, + ) app.add_url_rule("/metrics", metrics_endpoint, view_func=self.render) def _register_collectors(self): @@ -127,32 +143,42 @@ def _register_collectors(self): "http_requests", "Total number of requests", ["method", "path", "status", *self._custom_label_names], + registry=self._registry, ), Counter( "http_requests_errors", "Total number of error requests", ["method", "path", "status", *self._custom_label_names], + registry=self._registry, ), Histogram( "http_request_duration_seconds", "The amount of time spent handling requests", ["path", *self._custom_label_names], + registry=self._registry, ), Histogram( "http_request_size_bytes", "The size of requests", ["path", *self._custom_label_names], buckets=REQUEST_BUCKETS, + registry=self._registry, ), Histogram( "http_response_size_bytes", "The size of responses", ["path", *self._custom_label_names], buckets=RESPONSE_BUCKETS, + registry=self._registry, ), ) } + def _reset_metrics(self): + """Unregister all collectors from the registry.""" + for _, collector in self._collectors.items(): + self._registry.unregister(collector) + def custom_route_labeler( self, labeler: Callable[["LocalProxy"], Dict[str, str]], label_names: List[str] ) -> None: @@ -160,13 +186,13 @@ def custom_route_labeler( This will reset all metrics. Conventionally it's called when the extension is first registered - :param labeler: The handler function to invoke. It must return a dict of key-value labels. + :param labeler: The handler function to invoke. It must accept a request proxy, from which values for the custom label can be pulled. It must return + a dict of key-value labels. :param label_names: The possible label names emitted by the labeler. """ self._custom_labeler = labeler self._custom_label_names = label_names - for _, collector in self._collectors.items(): - REGISTRY.unregister(collector) + self._reset_metrics() self._register_collectors() def get(self, name: str) -> MetricType: @@ -181,4 +207,3 @@ def get(self, name: str) -> MetricType: def render(): """Render the stats.""" return Response(generate_latest(), mimetype=CONTENT_TYPE_LATEST) - diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..fae10a7 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,28 @@ +[metadata] +description-file = README.md + +[aliases] +test = pytest + +[tool:pytest] +addopts = --cov-config=setup.cfg --cov=. --cov-report=term-missing . + +[coverage:run] +omit = tests/*, setup.py + +[tool:isort] +profile=black +line_length=115 +balanced_wrapping=True +forced_separate= +no_lines_before=LOCALFOLDER + + +[mypy-prometheus_client] +ignore_missing_imports = True + +[mypy-pytest] +ignore_missing_imports = True + +[mypy-setuptools] +ignore_missing_imports = True \ No newline at end of file diff --git a/setup.py b/setup.py index cd2e529..06fddac 100644 --- a/setup.py +++ b/setup.py @@ -1,50 +1,47 @@ -"""quart-prometheus-logger""" +"""quart-prometheus-logger.""" from setuptools import setup -REQUIREMENTS = [ - 'Quart>=0.9.1', - 'prometheus_client==0.7.1' -] +REQUIREMENTS = ["Quart>=0.9.1", "prometheus_client==0.7.1"] setup( - name='quart-prometheus-logger', - version='1.0', - url='https://github.com/sparkmeter/quart-prometheus-logger', - license='MIT', - author='Sparkmeter Systems Engineering', - author_email='syseng@sparkmeter.io', - description='Log Prometheus metrics for your Quart application', - long_description=open('README.md').read(), - py_modules=['quart_prometheus_logger'], + name="quart-prometheus-logger", + version="1.0", + url="https://github.com/sparkmeter/quart-prometheus-logger", + license="MIT", + author="Sparkmeter Systems Engineering", + author_email="syseng@sparkmeter.io", + description="Log Prometheus metrics for your Quart application", + long_description=open("README.md").read(), + py_modules=["quart_prometheus_logger"], zip_safe=False, include_package_data=True, - platforms='any', + platforms="any", install_requires=REQUIREMENTS, tests_require=[ - 'pytest', + "pytest", ], extras_require={ - 'dev': [ - 'asynctest==0.13.0', - 'black==20.8b1', - 'isort==5.4.2', - 'mypy==0.781', - 'mypy-extensions==0.4.3', - 'pip-tools==4.5.1', - 'pylint==2.6.0', - 'pytest==4.3.1', - 'pytest-cov==2.7.1', - 'pytest-asyncio==0.10.0', + "dev": [ + "asynctest==0.13.0", + "black==20.8b1", + "isort==5.4.2", + "mypy==0.781", + "mypy-extensions==0.4.3", + "pip-tools==4.5.1", + "pylint==2.6.0", + "pytest==4.3.1", + "pytest-cov==2.7.1", + "pytest-asyncio==0.10.0", ] }, classifiers=[ - 'Environment :: Web Environment', - 'Intended Audience :: Developers', - 'License :: OSI Approved :: BSD License', - 'Operating System :: OS Independent', - 'Programming Language :: Python', - 'Topic :: Internet :: WWW/HTTP :: Dynamic Content', - 'Topic :: Software Development :: Libraries :: Python Modules' - ] -) \ No newline at end of file + "Environment :: Web Environment", + "Intended Audience :: Developers", + "License :: OSI Approved :: MIT", + "Operating System :: OS Independent", + "Programming Language :: Python", + "Topic :: Internet :: WWW/HTTP :: Dynamic Content", + "Topic :: Software Development :: Libraries :: Python Modules", + ], +) diff --git a/tests/test_quart_prometheus_logger.py b/tests/test_quart_prometheus_logger.py new file mode 100644 index 0000000..7a50769 --- /dev/null +++ b/tests/test_quart_prometheus_logger.py @@ -0,0 +1,32 @@ +import pytest +import pytest_asyncio +import quart + +from quart_prometheus_logger import PrometheusRegistry +from prometheus_client import REGISTRY + + +def test_init_app(app): + registry = PrometheusRegistry() + metrics_endpoint = "root" + registry.init_app(app, metrics_endpoint) + assert "prometheus_error_handler" in app.error_handler_spec + assert "prometheus_before_request_callback" in app.before_request_funcs + assert "prometheus_after_request_callback" in app.after_request_funcs + + +def test_init(app): + registry = PrometheusRegistry(app=app) + assert "prometheus_error_handler" in app.error_handler_spec + assert "prometheus_before_request_callback" in app.before_request_funcs + assert "prometheus_after_request_callback" in app.after_request_funcs + + +@pytest.mark.asyncio +async def test_customer_labeler(app, client): + registry = PrometheusRegistry(app=app) + custom_label = lambda _: {"custom_label": 1} + registry.custom_route_labeler(custom_label, ["custom_label"]) + await client.get("/") + for _, collector in registry._collectors.items(): + assert "custom_label" in collector._labelnames diff --git a/utils.py b/utils.py index 4d71a39..2fbc025 100644 --- a/utils.py +++ b/utils.py @@ -1,5 +1,6 @@ from datetime import datetime, time, timezone + def now_utc() -> datetime: """Get a timezone-aware representation of now().""" return datetime.now(timezone.utc)