Ayudaría mucho si apoyaras este proyecto con una ⭐ en Github!
Este proyecto contiene distintos ejemplos para conectarse a un broker RabbitMQ - basado en el protocolo AMQP 0-9-1 - usando distintos ejemplos en lenguaje Python.
Para que este servicio funcione deberías contar con un broker RabbitMQ corriendo previo a la ejecución del servicio. Si no sabés como hacerlo, el proyecto Service AMQP Broker de nuestra organización de Github tiene toda la información necesaria para correrlo dentro del ecosistema Docker.
Para que entiendas el alcance de este proyecto, es recomendable que leas la Introducción a AMQP y la Introducción a RabbitMQ que se encuentran publicadas en nuestra web.
Para correr este proyecto es necesario que instales Docker y Docker Compose.
Mira cómo instalar las dependencias
En este artículo publicado en nuestra web están los detalles para instalar Docker y Docker Compose en una máquina Linux. Si querés instalar ambas herramientas en una Raspberry Pi podés seguir este artículo de nuestra web que te muestra todos los pasos necesarios.
En caso que quieras instalar las herramientas en otra plataforma o tengas algún incoveniente, podes leer la documentación oficial de Docker y también la de Docker Compose.
Continua con la descarga del código cuando tengas las dependencias instaladas y funcionando.
Para descargar el código, lo más conveniente es que realices un fork de este proyecto a tu cuenta personal haciendo click en este link. Una vez que ya tengas el fork a tu cuenta, descargalo con este comando (acordate de poner tu usuario en el link):
git clone https://github.com/USER/service-amqp-samples.git
En caso que no tengas una cuenta en Github podes clonar directamente este repo.
Cuando tengas el código descargado, desde una terminal en la raíz del proyecto ejecuta el comando docker-compose build amqp-samples que se va encargar de compilar la imagen con los ejemplos en tu máquina (este proceso puede durar unos minutos dependiento tu conexión a internet).
Una vez que haya compilado, ejecuta el comando docker-compose up que va a correr el comando por defecto del servicio y te va a mostrar una lista con las muestras disponibles para que ejecutes. Deberías ver una salida similar a la siguiente:
Starting to run Service AMQP Samples
/$$$$$$ /$$ /$$$$$$ /$$$$$$$$
/$$__ $$ | $$ |_ $$_/ |__ $$__/
| $$ \__/ /$$$$$$ /$$$$$$ /$$$$$$ | $$ /$$$$$$| $$
| $$ /$$$$/$$__ $|_ $$_/ /$$__ $$ | $$ /$$__ $| $$
| $$|_ $| $$ \ $$ | $$ | $$ \ $$ | $$ | $$ \ $| $$
| $$ \ $| $$ | $$ | $$ /$| $$ | $$ | $$ | $$ | $| $$
| $$$$$$| $$$$$$/ | $$$$| $$$$$$/ /$$$$$| $$$$$$| $$
\______/ \______/ \___/ \______/ |______/\______/|__/
SERVICE AMQP SAMPLES
--------------------
################################################################################
In this repo there are many samples to connect to RabbitMQ broker.
Each sample includes help message invoking it with -h flag.
Default exchange:
Producer:
- docker-compose run amqp-samples python samples/default_exchange/producer.py
Consumer:
- docker-compose run amqp-samples python samples/default_exchange/consumer.py
Direct exchange:
Producer:
- docker-compose run amqp-samples python samples/direct_exchange/producer.py
Consumer:
- docker-compose run amqp-samples python samples/direct_exchange/consumer.py
Fanout exchange:
Producer:
- docker-compose run amqp-samples python samples/fanout_exchange/producer.py
Consumer:
- docker-compose run amqp-samples python samples/fanout_exchange/consumer.py
Topic exchange:
Producer:
- docker-compose run amqp-samples python samples/topic_exchange/producer.py
Consumer:
- docker-compose run amqp-samples python samples/topic_exchange/consumer.py
HTTP integration:
Entities declaration:
- docker-compose run amqp-samples python samples/http_integration/create_exchange.py
- docker-compose run amqp-samples python samples/http_integration/create_queue.py
- docker-compose run amqp-samples python samples/http_integration/create_binding.py
Producer:
- docker-compose run amqp-samples python samples/http_integration/send_message.py
Consumer:
- docker-compose run amqp-samples python samples/http_integration/get_messages.py
Generic AMQP clients:
Producer:
- docker-compose run amqp-samples python samples/generic_samples/producer.py -h
Consumer:
- docker-compose run amqp-samples python samples/generic_samples/consumer.py -h
################################################################################
Si ves esta salida significa que el servicio se encuentra corriendo adecuadamente. Podés leer la información útil para tener un mejor entendimiento de la aplicación.
En esta sección vas a encontrar información que te va a servir para tener un mayor contexto.
Mira todos los detalles
En la carpeta samples se encuentran todos los ejemplos disponibles. Cada uno de los ejemplos de muestra dispone de un HELP accediendo al script con el flah -h o --help que te van a mostrar como debes invocarlo para correr adecuadamente.
La configuración para conectarse al broker AMQP está alojada en el archivo env. Podés cambiarla escribiendo en este archivo directamente. Si por casualidad llegás a borrar la configuración, podés copiar y modificar esta:
RABBITMQ_HOSTNAME=localhost
RABBITMQ_PORT=5672
RABBITMQ_USER=gotoiot
RABBITMQ_PASS=gotoiot
RABBITMQ_VHOST=/
Así mismo, todos los script de ejemplo están preparados para funcionar con valores por defecto que están definidos de la siguiente manera:
rabbitmq_hostname = os.getenv("RABBITMQ_HOSTNAME", "localhost")
rabbitmq_port = int(os.getenv('RABBITMQ_PORT', 5672))
rabbitmq_user = os.getenv("RABBITMQ_USER", "gotoiot")
rabbitmq_pass = os.getenv("RABBITMQ_PASS", "gotoiot")
rabbitmq_vhost = os.getenv("RABBITMQ_VHOST", "/")La mejor forma de probar los ejemplos es iniciar un consumidor de cualquier tipo de exchange en una terminal y en otra iniciar un productor del mismo tipo de exchange. Los mensajes enviados desde el productor deberían aparecer en el consumidor. Si bien es posible parametrizar cada uno de los scripts, con utilizar los valores por defecto se pueden realizar todas las pruebas necesarias.
Para este ejemplo vamos a crear un consumidor del exchange gotoiot.direct utilizando la routing key event.maintenance. Abri una terminal y ejecuta el siguiente comando:
docker-compose run amqp-samples \
python samples/direct_exchange/consumer.py gotoiot.direct event.maintenance
Por otro lado, en otra terminal, vamos a lanzar un productor de datos hacia el exchange gotoiot.direct utilizando la routing key event.maintenance con el mensaje '{"sensor_disconected":true}'. Abri una terminal y ejecuta el siguiente comando:
docker-compose run amqp-samples \
python samples/direct_exchange/producer.py gotoiot.direct event.maintenance '{"sensor_disconected":true}'
Luego de enviar el mensaje, en la terminal del consumidor deberías ver un mensaje similar al siguiente:
Connecting to RabbitMQ: amqp://gotoiot:gotoiot@rabbitmq:5672
Binding exchange 'gotoiot.direct' to queue 'amq.gen-jcY' with routing key 'event.maintenance'
Starting to consume from 'amq.gen-jcYv3-wzHJmbsKhETSWtNA' with 'event.maintenance' routing_key...To exit press CTRL+C
Received message: b'{"sensor_disconected":true}'
Para facilitar el uso de los clientes, acá hay algunos comandos que te pueden ser de utilidad.
Consumir de un host:
docker-compose run amqp-samples \
python samples/generic_client/consumer.py \
-H HOSTNAME \
-p PORT \
-u USER \
-P PASS \
-v VHOST \
-e EXCHANGE \
-t EXCHANGE_TYPE \
-r ROUTING_KEY \
-q QUEUE
Publicar en un exchange:
docker-compose run amqp-samples \
python samples/generic_client/producer.py \
-H HOSTNAME \
-p PORT \
-u USER \
-P PASS \
-v VHOST \
-e EXCHANGE \
-t EXCHANGE_TYPE \
-m MESSAGE
Mira la lista de tecnologías usadas en el proyecto
- Docker - Ecosistema que permite la ejecución de contenedores de software.
- Docker Compose - Herramienta que permite administrar múltiples contenedores de Docker.
- Python - Lenguaje en el que están realizados los servicios.
- Pika - Biblioteca de Python para interactuar con RabbitMQ.
Si estás interesado en el proyecto y te gustaría sumar fuerzas para que siga creciendo y mejorando, podés abrir un hilo de discusión para charlar tus propuestas en este link. Así mismo podés leer el archivo Contribuir.md de nuestra Wiki donde están bien explicados los pasos para que puedas enviarnos pull requests.
Goto IoT es una plataforma que publica material y proyectos de código abierto bien documentados junto a una comunidad libre que colabora y promueve el conocimiento sobre IoT entre sus miembros. Acá podés ver los links más importantes:
- Sitio web: Donde se publican los artículos y proyectos sobre IoT.
- Github de Goto IoT: Donde están alojados los proyectos para descargar y utilizar.
- Comunidad de Goto IoT: Donde los miembros de la comunidad intercambian información e ideas, realizan consultas, solucionan problemas y comparten novedades.
- Twitter de Goto IoT: Donde se publican las novedades del sitio y temas relacionados con IoT.
- Wiki de Goto IoT: Donde hay información de desarrollo complementaria para ampliar el contexto.
Si te gustó este proyecto y quisieras apoyarlo, cualquiera de estas acciones estaría más que bien para nosotros:
- Apoyar este proyecto con una ⭐ en Github para llegar a más personas.
- Sumarte a nuestra comunidad abierta y dejar un feedback sobre qué te pareció el proyecto.
- Seguirnos en twitter y dejar algún comentario o like.
- Compartir este proyecto con otras personas.
Las colaboraciones principales fueron realizadas por:
- Agustin Bassi: Ideación, puesta en marcha y mantenimiento del proyecto.
También podés mirar todas las personas que han participado en la lista completa de contribuyentes.
Este proyecto está bajo Licencia (MIT). Podés ver el archivo LICENSE.md para más detalles sobre el uso de este material.
Copyright © Goto IoT 2021 - Website - Group - Github - Twitter - Wiki