Package: resilient-exporters
Resilient ExportersResilient-exporters abstracts away common tasks when sending or saving data from an application. It has been designed to send data to different targets and manage common issues for applications running on edge devices such as a Raspberry Pi or Nvidia Jetson Nano:Internet connection interruptions;Highly variable frequency of data transfers;If a connection is lost, it automatically saves the data and retries later when the connection is recovered and when a new request to send data is made. To avoid consuming too much memory or disk space, it has a specific configurable flush.If an application wants to send more data than is momentally manageable, it multiplies the transmission jobs (using multithreading, if available) and saves the data (queuing), to avoid back-pressure and reducing the application's speed.Of course, it can break if:the data to transmit isalmost alwaysmore important than the available bandwidth;the interruptions are too long compared to the available memory or disk space;We have designed it particularly for a Raspberry Pi 3B+ device running a Linux distribution.InstallationTo use the package:pip install resilient-exportersWith all the additional packages needed for the different exporters:pip install resilient-exporters[all]Dev installationIf you'd like to have a editable, up-to-date version of the files, do:git clone https://github.com/arbfay/resilient-exporters.git && \
pip install -e resilient-exporters/ && \
pip install -r resilient-exporters/dev_requirements.txtUsageCurrently supported:Text fileMongoDBElasticSearchPostgreSQLSome features for some exporters might be missing. Raise an issue on Github to ask for an implementation and help improve the package.Store in a filefromresilient_exportersimportFileExporterexporter=FileExporter(target_file="mydata.txt",max_lines=100)mydata="line of text"exporter.send(mydata)To MongoDBfromresilient_exportersimportMongoDBExporterexporter=MongoDBExporter(target_ip="127.0.0.1",target_port=27017,username="username",password="password",default_db="my_db",default_collection="my_collection")mydata={"field1":"value1"}exporter.send(mydata)To ElasticSearchfromresilient_exportersimportElasticSearchExporterexporter=ElasticSearchExporter(target_ip="127.0.0.1",default_index="my_index",use_ssl=True,ssl_certfile="/path/to/file",sniff_on_start=True)mydata={"field1":"value1"}exporter.send(mydata)To PostgreSQLfromresilient_exporters.exportersimportPostgreSQLExporterexporter=PostgreSQLExporter(target_host="myserver.domain.net",username="username",password="my-password",database="profiles",default_table="scientists")data={"name":"Richard Feynman","age":69}exporter.send(data)Multiple distant targets - PoolsEdge devices are more and more powerful, and are capable of managing multiple distant targets without much overhead thanks toresilient-exporters. If you're taking advantage of this, you might need sometimes to replicate data across different databases of the same type (e.g. NoSQL, document-based databases). However, if you use multiple exporters, all the features will be duplicated and can generate inefficiencies (multiple temporary files, multiple queues, etc.).Instead, useresilient_exporters.ExporterPoolwhich pools exportersandother pools to expose only onesendmethod for all the exporters and to ensure a more efficient management of the resources. To use it:fromresilient_exportersimportExporterPoolfromresilient_exportersimportMongoDBExporter,ElasticSearchExporterexporters=[MongoDBExporter(target_ip="127.0.1.10",target_port=1234,default_db="my_db",default_collection="my_collection"),ElasticSearchExporter(cloud_id="cloud id",api_key="api key",default_index="my_index")]pool=ExporterPool(exporters,use_memory=False)mydata={"metric":2}pool.send(mydata)Transform data before sendingTo transform data before it gets sent by an exporter or a pool, one can add a function that takes the input data and returns the transformed data:fromresilient_exportersimportMongoDBExporterdeftransform(data):data["metric"]=(data["metric"]/2)*.5returndataexporter=MongoDBExporter(target_ip="127.0.1.10",target_port=1234,default_db="my_db",default_collection="my_collection",transform=transform)mydata={"metric":2}exporter.send(mydata)NOTE: it can also be passed to a pool with the same key argumenttranformat initialisation. When doing so, transform functions of individual exporters will be superseded by the pool's transform function.Additional informationTheresilient_exporters.Exporteris at the core of the package. All the other exporters inherits from it.Exportermanages the export of data to a target, however each target need specific logic to send data. All these subclasses, such asFileExporterorMongoDBExporter, implements theExporter.sendmethod and manages the needed options. Some exporters might need additional packages to be usable:pymongoforMongoDBExporterelasticsearchforElasticSearchExporterpsycopg2forPostgreSQLExporterDocumentationMore documentation availablehere.Suggestions and contributionPlease open a GitHub issue for bugs or feature requests.
Contact the contributors for participating.