init
All checks were successful
continuous-integration/drone Build is passing

This commit is contained in:
Amazed 2023-10-22 16:59:09 +02:00
commit a3805108e5
16 changed files with 1111 additions and 0 deletions

2
.drone.yml Normal file
View File

@ -0,0 +1,2 @@
kind: template
load: python.starlark

4
.gitignore vendored Normal file
View File

@ -0,0 +1,4 @@
build/
dist/
*.pyc
*.egg-info

39
Dockerfile Normal file
View File

@ -0,0 +1,39 @@
ARG alpine_version=3.18.4
FROM alpine:${alpine_version} as base
RUN apk update && apk upgrade
RUN apk add --no-cache \
ca-certificates \
py3-gunicorn \
py3-paramiko \
py3-pip \
py3-prometheus-client \
py3-requests \
py3-werkzeug \
py3-wheel \
py3-yaml \
python3
FROM base as builder
ADD . /src
WORKDIR /opt
RUN pip3 wheel --no-deps /src
FROM base as runtime
COPY --from=builder /opt /opt
RUN pip3 install --no-cache-dir --no-index /opt/*py3-none-any.whl && \
rm /opt/*py3-none-any.whl && \
addgroup -S -g 101 prometheus && \
adduser -D -H -S -G prometheus -u 101 prometheus
USER prometheus
EXPOSE 9224
ENTRYPOINT [ "/usr/bin/jellyseer_exporter" ]
CMD [ "/etc/jellyseer.yml" ]

86
README.md Normal file
View File

@ -0,0 +1,86 @@
# Prometheus Jellyseer Exporter
This is an exporter that exposes information gathered from Jellyseer for use by the Prometheus monitoring system.
## Installation
Requires Python 3.9 or better.
## Using docker
```
docker pull git.hipstercat.fr/hipstercat/jellyseer-exporter:main
```
Example: Display usage message:
```
docker run -it --rm git.hipstercat.fr/hipstercat/jellyseer-exporter:main --help
```
Example: Run the image with a mounted configuration file and published port:
```
docker run --init --name prometheus-jellyseer-exporter -d -p 127.0.0.1:9223:9223 -v /path/to/pve.yml:/etc/pve.yml git.hipstercat.fr/hipstercat/jellyseer-exporter:main
```
Prometheus Jellyseer Exporter will now be reachable at http://localhost:9223/.
## Usage
Visit http://localhost:9223/jellyseer?target=1.2.3.4 where 1.2.3.4
is the IP of the Jellyseer server to get metrics from. Specify the `module`
request parameter, to choose which module to use from the config file.
The `target` request parameter defaults to `localhost`. Hence if
`jellyseer_exporter` is deployed directly on the jellyseer host, `target`
can be omitted.
## Authentication
**Using jellyseer.yml config file**
Example `jellyseer.yml` for token authentication:
```yaml
default:
api_key: "your token"
verify_ssl: true
```
## Prometheus Configuration
The Jellyseer exporter can be deployed either directly on a Jellyseer server or
onto a separate machine.
Example config for Jellyseer exporter running on Jellyseer server:
```yaml
scrape_configs:
- job_name: 'jellyseer'
static_configs:
- targets:
- 192.168.1.2:9223 # Jellyseer server with Jellyseer exporter.
metrics_path: /pve
params:
module: [default]
```
Example config for Jellyseer exporter running on Prometheus host:
```yaml
scrape_configs:
- job_name: 'jellyseer'
static_configs:
- targets:
- 192.168.1.2 # Jellyseer server.
metrics_path: /jellyseer
params:
module: [default]
relabel_configs:
- source_labels: [__address__]
target_label: __param_target
- source_labels: [__param_target]
target_label: instance
- target_label: __address__
replacement: 127.0.0.1:9223 # Jellyseer exporter.
```

11
docker-compose.yml Normal file
View File

@ -0,0 +1,11 @@
services:
jellyfin_exporter:
image: git.hipstercat.fr/hipstercat/jellyseer-exporter:main
build:
context: .
dockerfile: Dockerfile
restart: always
volumes:
- ./jellyseer.yml:/etc/jellyseer.yml
ports:
- 9223:9223

3
jellyseer.yml Normal file
View File

@ -0,0 +1,3 @@
default:
api_key: xxxxxxxxxxxxx
verify_ssl: true

595
pylintrc Normal file
View File

@ -0,0 +1,595 @@
[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=
# Specify a score threshold to be exceeded before program exits with error.
fail-under=10
# 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=
# 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 module names) to load,
# usually to register additional checkers.
load-plugins=
# Pickle collected data for later comparisons.
persistent=yes
# 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,
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
# 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 score less than or equal to 10. You
# have access to the variables 'error', 'warning', 'refactor', and 'convention'
# which contain the number of messages in each category, as well as 'statement'
# which is the total number of statements analyzed. This score 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
[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
# Bad variable names regexes, separated by a comma. If names match any regex,
# they will always be refused
bad-names-rgxs=
# 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,
_
# Good variable names regexes, separated by a comma. If names match any regex,
# they will always be accepted
good-names-rgxs=
# 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=
[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*(# )?<?https?://\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=100
# 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
[LOGGING]
# The type of string formatting that logging methods do. `old` means using %
# formatting, `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
[MISCELLANEOUS]
# List of note tags to take in consideration, separated by a comma.
notes=FIXME,
XXX,
TODO
# Regular expression of note tags to take in consideration.
#notes-rgx=
[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
[SPELLING]
# Limits count of emitted suggestions for spelling mistakes.
max-spelling-suggestions=4
# Spelling dictionary name. Available dictionaries: none. To make it work,
# install the 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 the private dictionary; one word per line.
spelling-private-dict-file=
# Tells whether to store unknown words to the private dictionary (see the
# --spelling-private-dict-file option) instead of raising a message.
spelling-store-unknown-words=no
[STRING]
# This flag controls whether inconsistent-quotes generates a warning when the
# character used as a quote delimiter is used inconsistently within a module.
check-quote-consistency=no
# This flag controls whether the implicit-str-concat should generate a warning
# on implicit string concatenation in sequences defined over several lines.
check-str-concat-over-line-jumps=no
[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=
# 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
# List of decorators that change the signature of a decorated function.
signature-mutators=
[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_
# 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
[CLASSES]
# List of method names used to declare (i.e. assign) instance attributes.
defining-attr-methods=__init__,
__new__,
setUp,
__post_init__
# 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=7
# Maximum number of boolean expressions in an if statement (see R0916).
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
[IMPORTS]
# List of modules that can be imported at any level, not just the top level
# one.
allow-any-import-level=
# 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
# Couples of modules and preferred modules, separated by a comma.
preferred-modules=
[EXCEPTIONS]
# Exceptions that will emit a warning when being caught. Defaults to
# "BaseException, Exception".
overgeneral-exceptions=BaseException,
Exception

14
pyproject.toml Normal file
View File

@ -0,0 +1,14 @@
[project]
name = "prometheus-jellyseer-exporter"
version = "1.0.0"
dependencies = [
"prometheus_client>=0.0.11",
"requests",
"gunicorn",
"Werkzeug",
"pyyaml",
]
[project.scripts]
jellyseer_exporter = "jellyseer_exporter.cli:main"

View File

View File

@ -0,0 +1,2 @@
from jellyseer_exporter.cli import main
main()

44
src/jellyseer_exporter/cli.py Executable file
View File

@ -0,0 +1,44 @@
from argparse import ArgumentParser
import yaml
from jellyseer_exporter.http import start_http_server
from jellyseer_exporter.config import config_from_yaml
from jellyseer_exporter.collector import CollectorsOptions
def main():
"""
Main entry point.
"""
parser = ArgumentParser()
parser.add_argument('config', nargs='?', default='jellyseer.yml',
help='Path to configuration file (jellyseer.yml)')
parser.add_argument('port', nargs='?', type=int, default='9223',
help='Port on which the exporter is listening (9223)')
parser.add_argument('address', nargs='?', default='',
help='Address to which the exporter will bind')
parser.add_argument('--server.keyfile', dest='server_keyfile',
help='SSL key for server')
parser.add_argument('--server.certfile', dest='server_certfile',
help='SSL certificate for server')
params = parser.parse_args()
collectors = CollectorsOptions(
sessions=True
)
with open(params.config, encoding='utf-8') as handle:
config = config_from_yaml(yaml.safe_load(handle))
gunicorn_options = {
'bind': f'{params.address}:{params.port}',
'threads': 2,
'keyfile': params.server_keyfile,
'certfile': params.server_certfile,
}
if config.valid:
start_http_server(config, gunicorn_options, collectors)
else:
parser.error(str(config))

View File

@ -0,0 +1,40 @@
# pylint: disable=too-few-public-methods
import collections
from prometheus_client import CollectorRegistry, generate_latest
from prometheus_client.core import GaugeMetricFamily
from prometheus_client.registry import Collector
from .jellyseer import JellyseerAPI
CollectorsOptions = collections.namedtuple('CollectorsOptions', [
'sessions',
])
class SessionsCollector(Collector):
"""
Collects Jellyseer requests API
"""
def __init__(self, js):
self._js = js
def collect(self): # pylint: disable=missing-docstring
for req_type, count in self._js.api("GET", "api/v1/request/count").items():
gauge = GaugeMetricFamily(
f"jellyseer_requests_{req_type}",
f"Count of active {req_type} requests", value=count
)
yield gauge
def collect_jellyseer(config, host, options: CollectorsOptions):
"""Scrape a host and return prometheus text format for it"""
js = JellyseerAPI(host, **config)
registry = CollectorRegistry()
if options.sessions:
registry.register(SessionsCollector(js))
return generate_latest(registry)

View File

@ -0,0 +1,96 @@
"""
Config module for Jellyseer prometheus collector.
"""
from collections.abc import Mapping
def config_from_yaml(yaml):
"""
Given a dictionary parsed from a yaml file return a config object.
"""
if not isinstance(yaml, Mapping):
return ConfigInvalid(
"Not a dictionary. Check the syntax of the YAML config file."
)
modules = {
key: config_module_from_yaml(value) for
key, value in
yaml.items()
}
invalid = [
f" - {key}: {module}" for
key, module in
modules.items() if
not module.valid
]
if invalid:
return ConfigInvalid("\n".join(
["Invalid module config entries in config file"] + invalid
))
if not modules:
return ConfigInvalid("Empty dictionary. No modules specified.")
return ConfigMapping(modules)
def config_module_from_yaml(yaml):
"""
Given a dictionary parsed from a yaml file return a module config object.
"""
if not isinstance(yaml, Mapping):
return ConfigInvalid(
"Not a dictionary. Check the syntax of the YAML config file."
)
if not yaml:
return ConfigInvalid(
"Empty dictionary. No pve API parameters specified."
)
return ConfigMapping(yaml)
class ConfigMapping(Mapping):
"""
Valid config object.
"""
valid = True
def __init__(self, mapping):
super().__init__()
self._mapping = mapping
def __str__(self):
num = len(self._mapping)
keys = ", ".join(self._mapping.keys())
return f"Valid config: with {num} keys: {keys}"
def __getitem__(self, key):
return self._mapping[key]
def __iter__(self):
return iter(self._mapping)
def __len__(self):
return len(self._mapping)
class ConfigInvalid:
"""
Invalid config object.
"""
# pylint: disable=too-few-public-methods
valid = False
def __init__(self, error="Unspecified reason."):
self._error = error
def __str__(self):
return f"Invalid config: {self._error}"

View File

@ -0,0 +1,162 @@
import logging
import time
import gunicorn.app.base
from prometheus_client import CONTENT_TYPE_LATEST, Summary, Counter, generate_latest
from werkzeug.routing import Map, Rule
from werkzeug.wrappers import Request, Response
from werkzeug.exceptions import InternalServerError
from .collector import collect_jellyseer
class JellyseerExporterApplication:
"""
Jellyseer prometheus collector HTTP handler.
"""
# pylint: disable=no-self-use
def __init__(self, config, duration, errors, collectors):
self._config = config
self._duration = duration
self._errors = errors
self._collectors = collectors
self._log = logging.getLogger(__name__)
def on_jellyseer(self, module='default', target='localhost'):
"""
Request handler for /jellyseer route
"""
if module in self._config:
start = time.time()
output = collect_jellyseer(
self._config[module],
target,
self._collectors
)
response = Response(output)
response.headers['content-type'] = CONTENT_TYPE_LATEST
self._duration.labels(module).observe(time.time() - start)
else:
response = Response("Module '{module}' not found in config")
response.status_code = 400
return response
def on_metrics(self):
"""
Request handler for /metrics route
"""
response = Response(generate_latest())
response.headers['content-type'] = CONTENT_TYPE_LATEST
return response
def on_index(self):
"""
Request handler for index route (/).
"""
response = Response(
"""<html>
<head><title>Jellyseer Exporter</title></head>
<body>
<h1>Jellyseer Exporter</h1>
<p>Visit <code>/jellyseer?target=1.2.3.4</code> to use.</p>
</body>
</html>"""
)
response.headers['content-type'] = 'text/html'
return response
def view(self, endpoint, values, args):
"""
Werkzeug views mapping method.
"""
allowed_args = {
'jellyseer': ['module', 'target']
}
view_registry = {
'index': self.on_index,
'metrics': self.on_metrics,
'jellyseer': self.on_jellyseer,
}
params = dict(values)
if endpoint in allowed_args:
params.update({key: args[key] for key in allowed_args[endpoint] if key in args})
try:
return view_registry[endpoint](**params)
except Exception as error: # pylint: disable=broad-except
self._log.exception("Exception thrown while rendering view")
self._errors.labels(args.get('module', 'default')).inc()
raise InternalServerError from error
@Request.application
def __call__(self, request):
url_map = Map([
Rule('/', endpoint='index'),
Rule('/metrics', endpoint='metrics'),
Rule('/jellyseer', endpoint='jellyseer'),
])
urls = url_map.bind_to_environ(request.environ)
view_func = lambda endpoint, values: self.view(endpoint, values, request.args)
return urls.dispatch(view_func, catch_http_exceptions=True)
class StandaloneGunicornApplication(gunicorn.app.base.BaseApplication):
"""
Copy-paste from https://docs.gunicorn.org/en/stable/custom.html
"""
# 'init' and 'load' methods are implemented by WSGIApplication.
# pylint: disable=abstract-method
def __init__(self, app, options=None):
self.options = options or {}
self.application = app
super().__init__()
def load_config(self):
config = {key: value for key, value in self.options.items()
if key in self.cfg.settings and value is not None}
for key, value in config.items():
self.cfg.set(key.lower(), value)
def load(self):
return self.application
def start_http_server(config, gunicorn_options, collectors):
"""
Start a HTTP API server for Jellyseer prometheus collector.
"""
duration = Summary(
'jellyseer_collection_duration_seconds',
'Duration of collections by the Jellyseer exporter',
['module'],
)
errors = Counter(
'jellyseer_request_errors_total',
'Errors in requests to Jellyseer exporter',
['module'],
)
# Initialize metrics.
for module in config.keys():
# pylint: disable=no-member
errors.labels(module)
# pylint: disable=no-member
duration.labels(module)
app = JellyseerExporterApplication(config, duration, errors, collectors)
StandaloneGunicornApplication(app, gunicorn_options).run()

View File

@ -0,0 +1,11 @@
import requests
class JellyseerAPI:
def __init__(self, host: str, **config):
self.host = host
self.config = config
def api(self, method: str, path: str, params: dict = None):
url = f"https://{self.host}/{path}"
return requests.request(method, url, headers={"X-Api-Key": self.config["api_key"]}, params=params, verify=self.config["verify_ssl"]).json()

2
test-requirements.txt Normal file
View File

@ -0,0 +1,2 @@
pylint
pyflakes