Skip to content

Commit

Permalink
added quickstart, features changed
Browse files Browse the repository at this point in the history
  • Loading branch information
yaroslaff committed Dec 8, 2020
1 parent 7a21f52 commit f5703a1
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 5 deletions.
23 changes: 19 additions & 4 deletions User/Features.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,22 @@
# Особенности и функции okerr

## Зачем нужен okerr?

### Для менеджеров проекта
Okerr позволяет сократить потери от технических проблем.

- Предсказуемые проблемы (кончается срок действия сертификата, доменного имени или место на диске) - предсказываются.
- Свершившиеся проблемы (сервер недоступен, страничка выдает ошибку, итд) обнаруживаются быстро, может быть даже быстрее, чем пользователи их заметят.
- Если проблема не была предсказана и обнаружена - после исправления можно создать нужные индикаторы, чтобы второй раз это не случилось.
- Подозрительные аномалии (сегодняшний файл бэкапа оказался меньше, чем вчерашний; количество новых заказов в базе данных меньше, чем обычно) так же обнаруживаются и можно разобраться, по какой причине это случилось.
- Если же проблема все таки случилась, публичная страница статуса покажет пользователям, что вы в курсе проблемы, уже чините и когда ждать исправления, а так же сможет оповестить их, когда проблема будет исправлена.

### Для программистов и админов
- Okerr помогает отлаживать сложные и непонятные проблемы. Легко создать собственную проверку, которая будет периодически выполняться и быстро оповестит, чтобы увидеть проблему, пока она еще не "ушла".
- Открытая архитектура позволяет легко интегрировать в собственное ПО, а простой HTTP API позволяет легко управляться даже с большим количеством индикаторов. Все в открытом коде, как мы любим.

## Легко попробовать!
Не нужно устанаваливать серверное ПО, можно использовать наш [сервер okerr](https://okerr.com/). Даже не требуется регистрироваться, можно использовать демонстрационную учетную запись.
Не нужно устанаваливать серверное ПО, можно использовать наш [сервер okerr](https://cur.okerr.com/). Даже не требуется регистрироваться, можно использовать [демонстрационную учетную запись](https://cur.okerr.com/demologin).

Если вам нужно выполнять *опциональные* локальные провеки (изнутри сервера, например, отслеживать свободное место на диске), то нужно поставить маленький питоновский пакет.

Expand Down Expand Up @@ -55,8 +70,8 @@

[Полный список встроенных проверок](https://okerrupdate.readthedocs.io/ru/latest/basic-okerrmod-modules.html).

### Логические индикаторы
Логические индикаторы позволяют отслеживать сложны логические условия на основе обычных индикатоов. Например:
### Логические индикаторы (lambda)
Логические индикаторы позволяют отслеживать сложныe логические условия на основе обычных индикаторов. Например:
- Сервер X может выключаться для регламентных работ с 3:00 до 5:00 утра
- Можно иметь до 2 выключенных(поломанных) серверов, если еще как минимум 3 сервера работают

Expand All @@ -77,4 +92,4 @@ Okerr - беслатное ПО с открытыми исходными код

Если ваше ПО написано на Python или Shell скрипты, вы можете использовать [okerrupdate](https://github.com/yaroslaff/okerrupdate). Так же можно использовать любую HTTP библиотеку для любого языка программирования.

Модули проверок (для okerrmod) используют очень простой интерфейс и могут быть написаны на любом языке программирования.
Модули проверок (для okerrmod) используют очень простой интерфейс и могут быть написаны на любом языке программирования. Большинство нестандартных проверок можно написать в виде shell команд или скриптов.
24 changes: 24 additions & 0 deletions User/Quickstart.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Быстрый старт

Рекомендуется начать знакомство по этой схеме.

## Демо-аккаунт
Если вам хочется, можете сразу начать с исследования демо-аккаунта, без регистрации.
[Вход в демо аккаунт](https://cur.okerr.com/demologin). Этот этап можно пропустить.

## Прочитайте введение
Желательно прочитать [введение](Introduction).

## Зарегистрируйте свой аккаунт в okerr
[Зарегистрируйтесь](https://cur.okerr.com/signup) в okerr. Для входа в okerr можете всегда использовать [этот адрес](https://cur.okerr.com/).

## Тренинг
Пройдите короткий тренинг. После входа в okerr откройте профиль по ссылке с вашим емейлом в правом верхнем углу.
Из профиля есть ссылка на тренинг.

По завершении тренинга вы получите все основные знания по okerr а так же бесплатный и неограниченный по времени тариф более высокого уровня.

В случае любых затруднений с тренингом - пожалуйста [создайте тикет](https://okerr.freshdesk.com/) или просто [напишите на почту](mailto:support@okerr.com). Мы будем рады помочь! Обычно отвечаем в течении 1-2 часов.



3 changes: 2 additions & 1 deletion index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Если есть вопросы - спросите нас через `freshdesk <https://okerr.freshdesk.com/support/home>`_
или откройте `issue <https://github.com/yaroslaff/okerr-dev/issues>`_ на github,
или просто напишите `мне лично <mailto:yaroslaff@gmail.com>`_.
или просто напишите `мне лично <mailto:info@okerr.com>`_.

Okerr - проект с открытым кодом, и документация к okerr - тоже. Вы можете свободно редактировать эту документацию
как публичный проект `okerr-doc-ru <https://github.com/yaroslaff/okerr-doc-ru>`_ на github.
Expand All @@ -19,6 +19,7 @@ Okerr - проект с открытым кодом, и документация
:titlesonly:

User/Features
User/Quickstart
User/Introduction
User/Indicators
cm/index
Expand Down

0 comments on commit f5703a1

Please sign in to comment.