circonus_annotation – создание аннотации в circonus
Описание
- Создать событие аннотации с заданной категорией, названием и описанием. Дополнительно можно указать начало, конец или продолжительность.
Требования
Ниже перечислены требования к хосту, на котором выполняется данный модуль.
- requests (либо >= 2.0.0 для Python 3, либо >= 1.0.0 для Python 2)
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_key - / обязательно | Ключ API Circonus | |
| category - / обязательно | Категория аннотации | |
| description - / обязательно | Описание аннотации | |
| duration - | Значение по умолчанию: 0 | Продолжительность аннотации в секундах |
| start - | Значение по умолчанию: "I(now)" | Маркер времени Unix начала события |
| stop - | Значение по умолчанию: "I(now) + I(duration)" | Маркер времени Unix окончания события |
| title - / обязательно | Название аннотации |
Примечания
Примечание
- Режим проверки (check mode) не поддерживается.
Примеры
# Create a simple annotation event with a source, defaults to start and end time of now
- circonus_annotation:
api_key: XXXXXXXXXXXXXXXXX
title: App Config Change
description: This is a detailed description of the config change
category: This category groups like annotations
# Create an annotation with a duration of 5 minutes and a default start time of now
- circonus_annotation:
api_key: XXXXXXXXXXXXXXXXX
title: App Config Change
description: This is a detailed description of the config change
category: This category groups like annotations
duration: 300
# Create an annotation with a start_time and end_time
- circonus_annotation:
api_key: XXXXXXXXXXXXXXXXX
title: App Config Change
description: This is a detailed description of the config change
category: This category groups like annotations
start_time: 1395940006
end_time: 1395954407
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| annotation complex | успех | детали созданной аннотации | |
| _cid строка | успех | идентификатор аннотации Пример: /annotation/100000 | |
| _created целое число | успех | маркер времени создания Пример: 1502236928 | |
| _last_modified целое число | успех | маркер времени последнего изменения Пример: 1502236928 | |
| _last_modified_by строка | успех | производитель последнего изменения Пример: /user/1000 | |
| category строка | успех | категория созданной аннотации Пример: alerts | |
| description строка | успех | описание созданной аннотации Пример: Хост отключён. | |
| rel_metrics список | успех | Массив метрик, связанных с этой аннотацией, каждая метрика — строка. Пример: ['54321_kbps'] | |
| start целое число | успех | маркер времени, с которого применяется аннотация Пример: Хост отключён. | |
| stop строка | успех | маркер времени, с которого аннотация заканчивается Пример: Хост отключён. | |
| title строка | успех | название созданной аннотации Пример: ПРЕДУПРЕЖДЕНИЕ | |
Статус
- Гарантируется отсутствие обратной совместимости интерфейса модуля. [превью]
- Данный модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Nick Harring (@NickatEpic)
Подсказка
Если вы заметили какие-либо проблемы в данной документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/circonus_annotation_module.html
