rabbitmq – Получение сообщений из очереди RabbitMQ AMQP/AMQPS

Новая в версии 2.8.

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Краткое описание

Этот поиск использует базовый метод get для получения всех или ограниченного числа count, сообщений из очереди RabbitMQ.

Требования

Ниже перечислены требования к локальному узлу-мастеру, на котором выполняется этот поиск.

Пакет python pika https://pypi.org/project/pika/.

Параметры

Параметр	Варианты/Значения по умолчанию	Настройка	Комментарии
count -			Сколько сообщений собрать из очереди. Если не задано, по умолчанию извлекаются все сообщения из очереди.
queue - / обязательно			Очередь для получения сообщений.
url - / обязательно			Строка подключения URI для подключения к серверу AMQP/AMQPS RabbitMQ. Для получения дополнительной информации обратитесь к спецификации URI https://www.rabbitmq.com/uri-spec.html.

Примечания

Примечание

Этот поиск реализует BlockingChannel.basic_get для получения сообщений с сервера RabbitMQ.
После получения сообщения с сервера подтверждается получение сообщения, и сообщение на сервере удаляется.
Pika — это чисто Python-реализация протокола AMQP 0-9-1, которая пытается оставаться достаточно независимой от базовой библиотеки поддержки сети.
Дополнительную информацию о pika можно найти на https://pika.readthedocs.io/en/stable/.
Этот плагин протестирован с RabbitMQ. Другие серверы, основанные на протоколе AMQP 0.9.1, могут работать, но не протестированы/не гарантируются.
Присвоение возвращаемых сообщений переменной под vars может привести к неожиданным результатам, так как поиск оценивается каждый раз при обращении к переменной.
В настоящее время этот плагин обрабатывает только текстовые сообщения из очереди. При получении двоичных данных могут возникнуть неожиданные результаты.

Примеры

- name: Get all messages off a queue
  debug:
    msg: "{{ lookup('rabbitmq', url='amqp://guest:guest@192.168.0.10:5672/%2F', queue='hello') }}"


# If you are intending on using the returned messages as a variable in more than
# one task (eg. debug, template), it is recommended to set_fact.

- name: Get 2 messages off a queue and set a fact for re-use
  set_fact:
    messages: "{{ lookup('rabbitmq', url='amqp://guest:guest@192.168.0.10:5672/%2F', queue='hello', count=2) }}"

- name: Dump out contents of the messages
  debug:
    var: messages

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого поиска:

Ключ		Описание
_list список		Список словарей с ключами и значениями из очереди.
	content_type строка	Тип содержимого сообщения в очереди.
	delivery_mode строка	Режим доставки сообщения в очереди.
	delivery_tag строка	Тег доставки сообщения в очереди.
	exchange строка	Обмен, из которого пришло сообщение.
	headers словарь	Заголовки сообщения, возвращенного из очереди.
	json словарь	Если application/json указан в content_type, json будет загружен в переменные.
	message_count строка	message_count для сообщения в очереди.
	msg строка	Содержимое сообщения.
	redelivered логическое	Флаг redelivered. True, если сообщение доставлялось ранее.
	routing_key строка	routing_key сообщения в очереди.

Статус

Этот поиск не гарантирует обратную совместимость интерфейса. [превью]
Этот поиск поддерживается сообществом Ansible. [сообщество]

Авторы

John Imison <@Im0>

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ для улучшения.

Подсказка

Элементы конфигурации для каждого типа имеют порядок приоритета от низкого к высокому. Например, переменная, которая находится ниже в списке, переопределит переменную, расположенную выше.

© 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/plugins/lookup/rabbitmq.html