Jellyseer exporter for Prometheus
Go to file
Amazed 3b13f28dc8
All checks were successful
continuous-integration/drone/push Build is passing
2023-10-28 21:49:54 +02:00
src/jellyseer_exporter init 2023-10-22 16:59:09 +02:00
.drone.yml init 2023-10-22 16:59:09 +02:00
.gitignore init 2023-10-22 16:59:09 +02:00
docker-compose.yml Fix 2023-10-22 17:04:24 +02:00
Dockerfile Fix 2023-10-22 17:04:24 +02:00
jellyseer.yml init 2023-10-22 16:59:09 +02:00
pylintrc init 2023-10-22 16:59:09 +02:00
pyproject.toml init 2023-10-22 16:59:09 +02:00 Update 2023-10-28 21:49:54 +02:00
test-requirements.txt init 2023-10-22 16:59:09 +02:00

Prometheus Jellyseer Exporter

This is an exporter that exposes information gathered from Jellyseer for use by the Prometheus monitoring system.


Requires Python 3.9 or better.

Using docker

docker pull

Example: Display usage message:

docker run -it --rm --help

Example: Run the image with a mounted configuration file and published port:

docker run --init --name prometheus-jellyseer-exporter -d -p -v /path/to/jellyseer.yml:/etc/jellyseer.yml

Prometheus Jellyseer Exporter will now be reachable at http://localhost:9223/.


Visit http://localhost:9223/jellyseer?target= where 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.


Using jellyseer.yml config file

Example jellyseer.yml for token authentication:

  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:

- job_name: 'jellyseer'
   - targets:
     -  # Jellyseer server with Jellyseer exporter.
 metrics_path: /jellyseer
   module: [default]

Example config for Jellyseer exporter running on Prometheus host:

  - job_name: 'jellyseer'
      - targets:
        -  # Jellyseer server.
    metrics_path: /jellyseer
      module: [default]
      - source_labels: [__address__]
        target_label: __param_target
      - source_labels: [__param_target]
        target_label: instance
      - target_label: __address__
        replacement:  # Jellyseer exporter.