├── prometheus_data_generator ├── __init__.py └── main.py ├── requirements.txt ├── .dockerignore ├── setup.cfg ├── setup.py ├── Dockerfile ├── tox.ini ├── kubernetes ├── service.yml ├── servicemonitor.yml ├── configmap.yml └── deployment.yml ├── config.yml ├── Makefile ├── .gitignore ├── README.md └── COPYING /prometheus_data_generator/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | Flask==2.3.2 2 | prometheus-client==0.17.1 3 | PyYAML==6.0.1 4 | 5 | -------------------------------------------------------------------------------- /.dockerignore: -------------------------------------------------------------------------------- 1 | # ignore everything 2 | * 3 | # selectively add specific files/dirs 4 | !prometheus_data_generator/* 5 | !config.yml 6 | !requirements.txt 7 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [tool:pytest] 2 | pep8ignore = 3 | __init__.py ALL 4 | flakes-ignore = 5 | prometheus-data-generator/__init__.py ALL 6 | tests/__init__.py ALL 7 | setup.py ALL 8 | 9 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | from setuptools import setup 4 | 5 | VERSION = '0.2' 6 | 7 | setup( 8 | name='prometheus-data-generator', 9 | version=VERSION, 10 | description='', 11 | license="GPLv3", 12 | install_requires=["flask", "prometheus_client", "pyyaml"], 13 | ) 14 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM python:3.9-slim-buster 2 | 3 | 4 | COPY requirements.txt ./tmp/ 5 | RUN pip install --no-cache-dir -r /tmp/requirements.txt 6 | 7 | RUN useradd --create-home appuser 8 | USER appuser 9 | WORKDIR /home/appuser 10 | COPY . . 11 | 12 | CMD [ "python", "./prometheus_data_generator/main.py" ] 13 | -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- 1 | [tox] 2 | envlist = py37 3 | 4 | [testenv] 5 | deps = 6 | pdbpp 7 | pytest 8 | pytest-sugar 9 | pytest-cov 10 | pytest-pep8 11 | pytest-flakes 12 | -r requirements.txt 13 | commands = python3 -m pytest --cov-report term-missing --cov prometheus_data_generator tests/ --flakes --pep8 -r s 14 | -------------------------------------------------------------------------------- /kubernetes/service.yml: -------------------------------------------------------------------------------- 1 | --- 2 | apiVersion: v1 3 | kind: Service 4 | metadata: 5 | name: prometheus-data-generator 6 | labels: 7 | app: prometheus-data-generator 8 | spec: 9 | ports: 10 | - port: 9000 11 | protocol: TCP 12 | targetPort: 9000 13 | name: metrics 14 | selector: 15 | app: prometheus-data-generator 16 | -------------------------------------------------------------------------------- /kubernetes/servicemonitor.yml: -------------------------------------------------------------------------------- 1 | --- 2 | apiVersion: monitoring.coreos.com/v1 3 | kind: ServiceMonitor 4 | metadata: 5 | labels: 6 | app: prometheus-data-generator 7 | prometheus: kube-prometheus 8 | # this label is needed in case of using default kube-prometheus-stack helm chart 9 | # so that prometheus picks this up 10 | app.kubernetes.io/managed-by: Helm 11 | name: prometheus-data-generator 12 | spec: 13 | endpoints: 14 | - interval: 10s 15 | path: /metrics/ 16 | port: metrics 17 | selector: 18 | matchLabels: 19 | app: prometheus-data-generator 20 | -------------------------------------------------------------------------------- /config.yml: -------------------------------------------------------------------------------- 1 | --- 2 | config: 3 | - name: number_of_fruits 4 | description: The number of fruits we have. 5 | type: gauge 6 | labels: [name, color] 7 | sequence: 8 | - time: 5 9 | values: 0-20 10 | operation: inc 11 | labels: 12 | name: apple 13 | color: red 14 | - eval_time: 5 15 | operation: set 16 | labels: 17 | name: apple 18 | color: red 19 | - time: 5 20 | eval_time: 1 21 | values: 0-20 22 | operation: inc 23 | labels: 24 | name: apple 25 | color: green 26 | - time: 5 27 | eval_time: 1 28 | values: 0-5 29 | operation: dec 30 | labels: 31 | name: apple 32 | color: green 33 | - time: 5 34 | eval_time: 1 35 | value: 3 36 | operation: inc 37 | labels: 38 | name: apple 39 | color: yellow 40 | -------------------------------------------------------------------------------- /kubernetes/configmap.yml: -------------------------------------------------------------------------------- 1 | --- 2 | apiVersion: v1 3 | kind: ConfigMap 4 | metadata: 5 | name: prometheus-data-generator 6 | data: 7 | config.yml: | 8 | --- 9 | config: 10 | - name: number_of_fruits 11 | description: The number of fruits we have. 12 | type: gauge 13 | labels: [name, color] 14 | sequence: 15 | - time: 5 16 | values: 0-20 17 | operation: inc 18 | labels: 19 | name: apple 20 | color: red 21 | - eval_time: 5 22 | operation: set 23 | labels: 24 | name: apple 25 | color: red 26 | - time: 5 27 | eval_time: 1 28 | values: 0-20 29 | operation: inc 30 | labels: 31 | name: apple 32 | color: green 33 | - time: 5 34 | eval_time: 1 35 | values: 0-5 36 | operation: dec 37 | labels: 38 | name: apple 39 | color: green 40 | - time: 5 41 | eval_time: 1 42 | value: 3 43 | operation: inc 44 | labels: 45 | name: apple 46 | color: yellow 47 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: help 2 | VERSION:=$(shell grep VERSION setup.py | head -n1 | cut -d"'" -f2) 3 | 4 | help: 5 | @echo "Please use 'make ' where is one of" 6 | @echo " clean remove *.pyc files, __pycache__ and *.egg-info directories" 7 | @echo " test execute tests" 8 | @echo " build build the docker image" 9 | @echo " push push the docker image" 10 | @echo "Check the Makefile to know exactly what each target is doing." 11 | 12 | clean: 13 | @echo "Deleting '*.pyc', '__pycache__' and '*.egg-info'..." 14 | find . -name '*.pyc' -delete 15 | find . -name '__pycache__' -type d | xargs rm -fr 16 | find . -name '*.egg-info' -type d | xargs rm -fr 17 | rm -fr dist build 18 | 19 | test: 20 | docker run --name test-prometheus-data-generator --tty -v `pwd`:/tox --rm \ 21 | alexperezpujol/tox:latest tox 22 | 23 | docker-build: 24 | docker build -t littleangryclouds/prometheus-data-generator . 25 | 26 | docker-push: 27 | @docker tag littleangryclouds/prometheus-data-generator:latest littleangryclouds/prometheus-data-generator:$(VERSION) 28 | @docker push littleangryclouds/prometheus-data-generator:latest 29 | @docker push littleangryclouds/prometheus-data-generator:$(VERSION) 30 | 31 | all: clean test build 32 | -------------------------------------------------------------------------------- /kubernetes/deployment.yml: -------------------------------------------------------------------------------- 1 | --- 2 | apiVersion: apps/v1 3 | kind: Deployment 4 | metadata: 5 | labels: 6 | app: prometheus-data-generator 7 | name: prometheus-data-generator 8 | spec: 9 | replicas: 1 10 | selector: 11 | matchLabels: 12 | app: prometheus-data-generator 13 | template: 14 | metadata: 15 | labels: 16 | app: prometheus-data-generator 17 | spec: 18 | containers: 19 | - image: littleangryclouds/prometheus-data-generator:0.2 20 | imagePullPolicy: IfNotPresent 21 | env: 22 | - name: PDG_CONFIG 23 | value: /pdg/config.yml 24 | name: prometheus-data-generator 25 | ports: 26 | - containerPort: 9000 27 | protocol: TCP 28 | livenessProbe: 29 | httpGet: 30 | path: / 31 | port: 9000 32 | scheme: HTTP 33 | readinessProbe: 34 | httpGet: 35 | path: / 36 | port: 9000 37 | scheme: HTTP 38 | resources: 39 | limits: 40 | cpu: 100m 41 | memory: 100Mi 42 | requests: 43 | cpu: 50m 44 | memory: 50Mi 45 | volumeMounts: 46 | - name: config 47 | mountPath: /pdg/ 48 | - image: quay.io/coreos/configmap-reload:v0.0.1 49 | args: 50 | - -webhook-url=http://localhost:9000/-/reload 51 | - -volume-dir=/pdg/ 52 | - -webhook-method=GET 53 | name: config-reloader 54 | resources: 55 | limits: 56 | cpu: 5m 57 | memory: 10Mi 58 | requests: 59 | cpu: 5m 60 | memory: 10Mi 61 | volumeMounts: 62 | - name: config 63 | mountPath: /pdg/ 64 | readOnly: true 65 | volumes: 66 | - name: config 67 | configMap: 68 | name: prometheus-data-generator 69 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | 2 | # Created by https://www.gitignore.io/api/python 3 | 4 | ### Python ### 5 | # Byte-compiled / optimized / DLL files 6 | __pycache__/ 7 | *.py[cod] 8 | *$py.class 9 | 10 | # C extensions 11 | *.so 12 | 13 | # Distribution / packaging 14 | .Python 15 | build/ 16 | develop-eggs/ 17 | dist/ 18 | downloads/ 19 | eggs/ 20 | .eggs/ 21 | lib/ 22 | lib64/ 23 | parts/ 24 | sdist/ 25 | var/ 26 | wheels/ 27 | *.egg-info/ 28 | .installed.cfg 29 | *.egg 30 | MANIFEST 31 | 32 | # PyInstaller 33 | # Usually these files are written by a python script from a template 34 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 35 | *.manifest 36 | *.spec 37 | 38 | # Installer logs 39 | pip-log.txt 40 | pip-delete-this-directory.txt 41 | 42 | # Unit test / coverage reports 43 | htmlcov/ 44 | .tox/ 45 | .coverage 46 | .coverage.* 47 | .cache 48 | nosetests.xml 49 | coverage.xml 50 | *.cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | 63 | # Flask stuff: 64 | instance/ 65 | .webassets-cache 66 | 67 | # Scrapy stuff: 68 | .scrapy 69 | 70 | # Sphinx documentation 71 | docs/_build/ 72 | 73 | # PyBuilder 74 | target/ 75 | 76 | # Jupyter Notebook 77 | .ipynb_checkpoints 78 | 79 | # pyenv 80 | .python-version 81 | 82 | # celery beat schedule file 83 | celerybeat-schedule 84 | 85 | # SageMath parsed files 86 | *.sage.py 87 | 88 | # Environments 89 | .env 90 | .venv 91 | env/ 92 | venv/ 93 | ENV/ 94 | env.bak/ 95 | venv.bak/ 96 | 97 | # Spyder project settings 98 | .spyderproject 99 | .spyproject 100 | 101 | # Rope project settings 102 | .ropeproject 103 | 104 | # mkdocs documentation 105 | /site 106 | 107 | # mypy 108 | .mypy_cache/ 109 | 110 | ### Python Patch ### 111 | .venv/ 112 | 113 | ### Python.VirtualEnv Stack ### 114 | # Virtualenv 115 | # http://iamzed.com/2009/05/07/a-primer-on-virtualenv/ 116 | [Bb]in 117 | [Ii]nclude 118 | [Ll]ib 119 | [Ll]ib64 120 | [Ll]ocal 121 | [Ss]cripts 122 | pyvenv.cfg 123 | pip-selfcheck.json 124 | 125 | 126 | # End of https://www.gitignore.io/api/python 127 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # prometheus-data-generator 2 | 3 | Creates arbitrary prometheus metrics. 4 | 5 | ## Why use this? 6 | 7 | When creating Grafana dashboards or Prometheus alerts, it is common to make 8 | mistakes. You define a threshold that they have to meet, but when modified the 9 | next time you may forget those thresholds. 10 | 11 | Using this tool, you can create data with the format you want and 12 | thus being able to base alerts and graphics on data that resemble reality. 13 | 14 | To use this, you'll create a configuration file in which you will define a 15 | metric name, description, type and labels and sequences of certain operations. 16 | 17 | For example, you'll be able to create a alarm called `http_requests` with the 18 | labels `{path=/login/, return_code=200}` which will be updated as you wish. 19 | 20 | ## Configuration 21 | 22 | There's an example configuration file called `config.yml` in the root of the 23 | repository. It has the next format: 24 | 25 | ``` yaml 26 | config: 27 | - name: number_of_fruits 28 | description: The number of fruits we have. 29 | type: gauge 30 | labels: [name, color] 31 | sequence: 32 | - time: 5 33 | eval_time: 5 34 | values: 0-20 35 | operation: inc 36 | labels: 37 | name: apple 38 | color: red 39 | - time: 5 40 | eval_time: 5 41 | values: 0-20 42 | operation: inc 43 | labels: 44 | name: apple 45 | color: green 46 | - time: 5 47 | eval_time: 5 48 | values: 0-5 49 | operation: dec 50 | labels: 51 | name: apple 52 | color: green 53 | - time: 5 54 | eval_time: 5 55 | value: 3 56 | operation: inc 57 | labels: 58 | name: apple 59 | color: yellow 60 | ``` 61 | 62 | The generated metric will be like this: 63 | 64 | ``` text 65 | number_of_fruits{color="red",name="apple"} 14.0 66 | number_of_fruits{color="green",name="apple"} 10.0 67 | number_of_fruits{color="yellow",name="apple"} 4.0 68 | ``` 69 | 70 | ### Supported keywords 71 | 72 | - `name`: The [metric 73 | name](https://prometheus.io/docs/instrumenting/writing_clientlibs/#metric-names). 74 | [**Type**: string] [**Required**] 75 | - `description`: The description to be shown as 76 | [HELP](https://prometheus.io/docs/instrumenting/writing_clientlibs/#metric-description-and-help). 77 | [**Type**: string] [**Required**] 78 | - `type`: It should be one of the supported metric types, which you can see in the next section. 79 | [**Type**: string] [**Required**] 80 | - `labels`: The labels that will be used with the metric. [**Type**: list of 81 | strings] [**Optional**] 82 | - `sequence.eval_time`: Number of seconds that the sequence will be running. 83 | [**Type**: int] [**Required**] 84 | - `sequence.interval`: The interval of seconds between each operation will be 85 | performed. 1 second is a sane number. [**Type**: int] [**Required**] 86 | - `sequence.value`: The value that the operation will apply. It must be a single 87 | value. You must choose between `value` and `values`. [**Type**: int] [**Optional**] 88 | - `sequence.values`: The range of values that will randomly be choosed and the 89 | operation will apply. It must be two values separed by a dash. You must choose 90 | between `value` and `values`. [**Type**: string (int-int / float-float)] [**Optional**] 91 | - `sequence.operation`: The operation that will be applied. It only will be used 92 | with the gauge type, and you can choose between `inc`, `dec` or `set`. [**Optional**] 93 | - `sequence.labels`: The labels of the sequence. They must be used if `labels` 94 | are declared. [**Optional**] 95 | 96 | ### Supported metric types 97 | 98 | The ones defined [here](https://prometheus.io/docs/concepts/metric_types/). 99 | - Counter 100 | - Gauge 101 | - Histogram 102 | - Summary 103 | 104 | ## Manual use 105 | 106 | ```bash 107 | git clone https://github.com/little-angry-clouds/prometheus-data-generator.git 108 | virtualenv -p python3 venv 109 | pip install -r requirements.txt 110 | python prometheus_data_generator/main.py 111 | curl localhost:9000/metrics/ 112 | ``` 113 | 114 | ## Use in docker 115 | 116 | ``` bash 117 | wget https://raw.githubusercontent.com/little-angry-clouds/prometheus-data-generator/master/config.yml 118 | docker run -ti -v `pwd`/config.yml:/config.yml -p 127.0.0.1:9000:9000 \ 119 | littleangryclouds/prometheus-data-generator 120 | curl localhost:9000/metrics/ 121 | ``` 122 | 123 | ## Use in kubernetes 124 | 125 | There's some example manifests in the `kubernetes` directory. There's defined a 126 | service, configmap, deployment (with 127 | [configmap-reload](https://github.com/jimmidyson/configmap-reload) configured) 128 | and a Service Monitor to be used with the [prometheus 129 | operator](https://github.com/coreos/prometheus-operator). 130 | 131 | You may deploy the manifests: 132 | 133 | ``` bash 134 | kubectl create namespace prom-data-gen 135 | kubectl -n prom-data-gen apply -f kubernetes/ 136 | kubectl -n prom-data-gen port-forward service/prometheus-data-generator 9000:9000 137 | curl localhost:9000/metrics/ 138 | ``` 139 | 140 | You can edit the configmap as you wish and the configmap-reload will 141 | eventually reload the configuration without killing the pod. 142 | 143 | ## Generate prometheus alerts unit tests 144 | 145 | TODO 146 | 147 | ## Tests 148 | 149 | TODO 150 | -------------------------------------------------------------------------------- /prometheus_data_generator/main.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | import time 4 | import random 5 | import threading 6 | import logging 7 | from os import _exit, environ 8 | import yaml 9 | from flask import Flask, Response 10 | from prometheus_client import Gauge, Counter, Summary, Histogram 11 | from prometheus_client import generate_latest, CollectorRegistry 12 | 13 | 14 | if "PDG_LOG_LEVEL" in environ: 15 | supported_log_levels = ["INFO", "ERROR", "DEBUG"] 16 | if environ["PDG_LOG_LEVEL"].upper() not in supported_log_levels: 17 | logging.basicConfig( 18 | level=logging.INFO, 19 | format="%(asctime)s.%(msecs)03d %(levelname)s - %(funcName)s: %(message)s", 20 | datefmt="%Y-%m-%d %H:%M:%S", 21 | ) 22 | logger = logging.getLogger("prometheus-data-generator") 23 | logging.basicConfig( 24 | format="%(asctime)s.%(msecs)03d %(levelname)s - %(funcName)s: %(message)s", 25 | datefmt="%Y-%m-%d %H:%M:%S", 26 | ) 27 | logger = logging.getLogger("prometheus-data-generator") 28 | logger.setLevel(environ["PDG_LOG_LEVEL"].upper()) 29 | else: 30 | logging.basicConfig( 31 | level=logging.INFO, 32 | format="%(asctime)s.%(msecs)03d %(levelname)s - %(funcName)s: %(message)s", 33 | datefmt="%Y-%m-%d %H:%M:%S", 34 | ) 35 | logger = logging.getLogger("prometheus-data-generator") 36 | 37 | 38 | def read_configuration(): 39 | """ 40 | Read configuration from the environmental variable PDG_PATH. 41 | """ 42 | # TODO validate the yaml 43 | if "PDG_CONFIG" in environ: 44 | path = environ["PDG_CONFIG"] 45 | else: 46 | path = "config.yml" 47 | config = yaml.safe_load(open(path)) 48 | return config 49 | 50 | 51 | class PrometheusDataGenerator: 52 | def __init__(self): 53 | """ 54 | Initialize the flask endpoint and launch the function that will throw 55 | the threads that will update the metrics. 56 | """ 57 | self.app = Flask(__name__) 58 | self.serve_metrics() 59 | self.init_metrics() 60 | 61 | def init_metrics(self): 62 | """ 63 | Launch the threads that will update the metrics. 64 | """ 65 | self.threads = [] 66 | self.registry = CollectorRegistry() 67 | self.data = read_configuration() 68 | for metric in self.data["config"]: 69 | if "labels" in metric: 70 | labels = metric["labels"] 71 | else: 72 | labels = [] 73 | if metric["type"].lower() == "counter": 74 | instrument = Counter( 75 | metric["name"], 76 | metric["description"], 77 | labels, 78 | registry=self.registry 79 | ) 80 | elif metric["type"].lower() == "gauge": 81 | instrument = Gauge( 82 | metric["name"], 83 | metric["description"], 84 | labels, 85 | registry=self.registry 86 | ) 87 | elif metric["type"].lower() == "summary": 88 | instrument = Summary( 89 | metric["name"], 90 | metric["description"], 91 | labels, 92 | registry=self.registry 93 | ) 94 | elif metric["type"].lower() == "histogram": 95 | # TODO add support to overwrite buckets 96 | instrument = Histogram( 97 | metric["name"], 98 | metric["description"], 99 | labels, 100 | registry=self.registry 101 | ) 102 | else: 103 | logger.warning( 104 | "Unknown metric type {type} for metric {name}, ignoring.".format(**metric) 105 | ) 106 | 107 | t = threading.Thread( 108 | target=self.update_metrics, 109 | args=(instrument, metric) 110 | ) 111 | t.start() 112 | self.threads.append(t) 113 | 114 | def update_metrics(self, metric_object, metric_metadata): 115 | """ 116 | Updates the metrics. 117 | 118 | Arguments: 119 | metric_object: a Prometheus initialized object. It can be a Gauge, 120 | Counter, Histogram or Summary. 121 | metric_metadata: the configuration related to the initialzed Prometheus 122 | object. It comes from the config.yml. 123 | """ 124 | self.stopped = False 125 | while True: 126 | if self.stopped: 127 | break 128 | for sequence in metric_metadata["sequence"]: 129 | if self.stopped: 130 | break 131 | 132 | if "labels" in sequence: 133 | labels = [key for key in sequence["labels"].values()] 134 | else: 135 | labels = [] 136 | 137 | if "eval_time" in sequence: 138 | timeout = time.time() + sequence["eval_time"] 139 | else: 140 | logger.warning( 141 | "eval_time for metric {} not set, setting default to 1.".format(metric_metadata["name"]) 142 | ) 143 | timeout = time.time() + 1 144 | 145 | 146 | logger.debug( 147 | "Changing sequence in {} metric".format(metric_metadata["name"]) 148 | ) 149 | 150 | if "interval" in sequence: 151 | interval = sequence["interval"] 152 | else: 153 | logger.warning( 154 | "interval for metric {} not set, setting default to 1.".format(metric_metadata["name"]) 155 | ) 156 | interval = 1 157 | 158 | while True: 159 | if self.stopped: 160 | break 161 | 162 | if time.time() > timeout: 163 | break 164 | 165 | if "value" in sequence: 166 | value = sequence["value"] 167 | if isinstance(value, float): 168 | value = float(value) 169 | else: 170 | value = int(value) 171 | 172 | elif "values" in sequence: 173 | if "." in sequence["values"].split("-")[0]: 174 | initial_value = float(sequence["values"].split("-")[0]) 175 | end_value = float(sequence["values"].split("-")[1]) 176 | value = random.uniform(initial_value, end_value) 177 | else: 178 | initial_value = int(sequence["values"].split("-")[0]) 179 | end_value = int(sequence["values"].split("-")[1]) 180 | value = random.randrange(initial_value, end_value) 181 | 182 | if metric_metadata["type"].lower() == "gauge": 183 | try: 184 | operation = sequence["operation"].lower() 185 | except: 186 | logger.error( 187 | "You must set an operation when using Gauge" 188 | ) 189 | _exit(1) 190 | if operation == "inc": 191 | if labels == []: 192 | metric_object.inc(value) 193 | else: 194 | metric_object.labels(*labels).inc(value) 195 | elif operation == "dec": 196 | if labels == []: 197 | metric_object.dec(value) 198 | else: 199 | metric_object.labels(*labels).dec(value) 200 | elif operation == "set": 201 | if labels == []: 202 | metric_object.set(value) 203 | else: 204 | metric_object.labels(*labels).set(value) 205 | 206 | elif metric_metadata["type"].lower() == "counter": 207 | if labels == []: 208 | metric_object.inc(value) 209 | else: 210 | metric_object.labels(*labels).inc(value) 211 | elif metric_metadata["type"].lower() == "summary": 212 | if labels == []: 213 | metric_object.observe(value) 214 | else: 215 | metric_object.labels(*labels).observe(value) 216 | elif metric_metadata["type"].lower() == "histogram": 217 | if labels == []: 218 | metric_object.observe(value) 219 | else: 220 | metric_object.labels(*labels).observe(value) 221 | time.sleep(interval) 222 | 223 | def serve_metrics(self): 224 | """ 225 | Main method to serve the metrics. It's used mainly to get the self 226 | parameter and pass it to the next function. 227 | """ 228 | @self.app.route("/") 229 | def root(): 230 | """ 231 | Exposes a blank html page with a link to the metrics. 232 | """ 233 | page = "Metrics" 234 | return page 235 | 236 | @self.app.route("/metrics/") 237 | def metrics(): 238 | """ 239 | Plain method to expose the prometheus metrics. Every time it's 240 | called it will recollect the metrics and generate the rendering. 241 | """ 242 | metrics = generate_latest(self.registry) 243 | return Response(metrics, 244 | mimetype="text/plain", 245 | content_type="text/plain; charset=utf-8") 246 | 247 | @self.app.route("/-/reload") 248 | def reload(): 249 | """ 250 | Stops the threads and restarts them. 251 | """ 252 | self.stopped = True 253 | for thread in self.threads: 254 | thread.join() 255 | self.init_metrics() 256 | logger.info("Configuration reloaded. Metrics will be restarted.") 257 | return Response("OK") 258 | 259 | def run_webserver(self): 260 | """ 261 | Launch the flask webserver on a thread. 262 | """ 263 | threading.Thread( 264 | target=self.app.run, 265 | kwargs={"port": "9000", "host": "0.0.0.0"} 266 | ).start() 267 | 268 | 269 | if __name__ == "__main__": 270 | PROM = PrometheusDataGenerator() 271 | PROM.run_webserver() 272 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------