https://github.com/usetech/openmetrics-liveness-probe

https://github.com/usetech/openmetrics-liveness-probe

Last synced: 9 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/usetech/openmetrics-liveness-probe
• Owner: Usetech
• License: mit
• Created: 2022-08-02T13:18:43.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-03-16T14:20:46.000Z (about 3 years ago)
• Last Synced: 2024-11-19T16:00:57.467Z (over 1 year ago)
• Language: Python
• Size: 90.8 KB
• Stars: 8
• Watchers: 5
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![PyPI pyversions](https://img.shields.io/pypi/pyversions/openmetrics-liveness-probe.svg)](https://pypi.python.org/pypi/openmetrics-liveness-probe/) [![PyPI license](https://img.shields.io/pypi/l/openmetrics-liveness-probe.svg)](https://pypi.python.org/pypi/openmetrics-liveness-probe/) [![PyPI version fury.io](https://badge.fury.io/py/openmetrics-liveness-probe.svg)](https://pypi.python.org/pypi/openmetrics-liveness-probe/) [![build](https://github.com/Usetech/openmetrics-liveness-probe/actions/workflows/ci.yml/badge.svg)](https://github.com/Usetech/openmetrics-liveness-probe/actions/workflows/ci.yml?branch=main)

openmetrics-liveness-probe

============

Библиотека для получения времени, когда сервис в последний раз считался живым.

Результат экспортируется в формате OpenMetrics. Пример вывода:

```

# HELP liveness_probe_unixtime Unixtime последней liveness probe

# TYPE liveness_probe_unixtime gauge

liveness_probe_unixtime{service="test"} 1.659455742252334e+09

```

В многопоточном режиме:

```

# HELP liveness_probe_unixtime Multiprocess metric

# TYPE liveness_probe_unixtime gauge

liveness_probe_unixtime{pid="12821",service="example"} 1.6596198592194734e+09

liveness_probe_unixtime{pid="13521",service="example"} 1.6796198592194734e+09

```

Для начала необходимо объявить переменные окружения:

```

OPENMETRICS_LIVENESS_PROBE_ENABLED=True

OPENMETRICS_LIVENESS_PROBE_HOST=0.0.0.0

OPENMETRICS_LIVENESS_PROBE_PORT=8000

OPENMETRICS_LIVENESS_PROBE_SERVICE_NAME=example

OPENMETRICS_LIVENESS_PROBE_NAME_POSTFIX=liveness_probe_unixtime

OPENMETRICS_LIVENESS_PROBE_ENABLE_DEFAULT_PROMETHEUS_METRICS=False

PROMETHEUS_MULTIPROC_DIR=None

```

Все переменные по-умолчанию будут равны значениям, указанным в списке выше, Но переменная окружения ``SERVICE_NAME`` должна быть обязательно изменена.

Переменная окружения ``ENABLE_DEFAULT_PROMETHEUS_METRICS`` включает метрики по-умолчанию доступные в ``prometheus_client``: 

``PROCESS_COLLECTOR``, ``PLATFORM_COLLECTOR``, ``GC_COLLECTOR``.    

По-умолчанию их отображение выключено.

Переменная окружения ``PROMETHEUS_MULTIPROC_DIR`` позволяет запускать prometheus сервер в многопоточном режиме. По умолчанию эта переменная равна ``None.`` Для активации этого режима нужно задать путь для переменной окружения ``PROMETHEUS_MULTIPROC_DIR``, например: ``/tmp``.

# Содержание

- [Установка](#Установка)



## Установка

Описание установки

- pip 

```

pip install openmetrics_liveness_probe

```