3slab/vdm-library-bundle

Standardize vdm block development

3.2.0 2024-01-02 16:46 UTC

Requires

• ext-json: *
• datadog/php-datadogstatsd: ^1.4
• symfony/console: ^5.4
• symfony/framework-bundle: ^5.4
• symfony/messenger: ^5.4
• symfony/serializer-pack: *
• symfony/stopwatch: ^5.4
• symfony/yaml: ^5.4

Requires (Dev)

• ext-curl: *
• ext-mbstring: *
• ext-xml: *
• phpunit/phpunit: ^9
• squizlabs/php_codesniffer: *

Suggests

• 3slab/vdm-library-amqp-transport-bundle: if you want use amqp as a source
• 3slab/vdm-library-doctrine-odm-transport-bundle: if you want use doctrine odm as a destination
• 3slab/vdm-library-doctrine-orm-transport-bundle: if you want use doctrine orm as a destination
• 3slab/vdm-library-elasticsearch-transport-bundle: if you want use elasticsearch as a destination
• 3slab/vdm-library-ftp-transport-bundle: if you want use ftp as a source
• 3slab/vdm-library-http-transport-bundle: if you want use http as a source
• koco/messenger-kafka: if you want use kafka transport
• phpoffice/phpspreadsheet: if you want to format excel files

proprietary

• Jonathan Bouzekri
• Julian Marié

README

Introduction

This is the Symfony bundle part of the VDM.library used as the foundation to build VDM.collect, VDM.compute and VDM.store components.

It provides services to integrate your instances of VDM.collect, VDM.compute and VDM.store components with all other core component of the VDM platform (VDM.backbone, VDM.control and VDM.flow)

Services

• VDM.collect HTTP pull
• VDM.collect FTP/SFTP
• VDM.backbone consumer
• VDM.backbone producer
• VDM.store Elasticsearch
• VDM.store Doctrine

Features

• Collect HTTP sources :
  • Retry on error
  • Monitoring of HTTP Responses
• Produce message to a broker with exit on error
• Consume message from a broker with exit on error
• Handle Message between consumption and production
• Monitoring :
  • Track usage (number of messages consumed, produced)
  • Track state (started, stopped, errored)
  • Track process metrics (memory, processing time)
  • Track dependencies metrics
    • http : sources states, response codes, response times, response size
    • ftp : source states, errors and file size

These features are built on top of the Symfony Framework and its messenger component

Documentation

• Concepts
• Getting started
• Consume :
  • RabbitMQ json
  • HTTP pull
  • Kafka
  • FTP/SFTP
• Produce :
  • Kafka
  • Elasticsearch
  • Doctrine ORM
  • Doctrine ODM
• Manual Tranport
• Monitoring
• Configuration Reference
• Docker
• Examples :
  • Setup a VDM.collect instance to pull meteo data
  • Setup a VDM.compute instance to process meteo data
  • Setup a VDM.store instance to store meteo data

Image:

export DOCKER_VDM_LIBRARY_VERSION=3.0.1
docker build -t 3slab/vdm-library-base:$DOCKER_VDM_LIBRARY_VERSION .
docker push 3slab/vdm-library-base:$DOCKER_VDM_LIBRARY_VERSION

License

This bundle is distributed around the MIT License