QuantumLeap: a FIWARE Generic Enabler to support the usage of NGSIv2 (and NGSI-LD experimentally) data in time-series databases
QuantumLeap is the first implementation of an API that supports the storage of FIWARE NGSIv2 data into a time series database. It currently also experimentally supports the injection of NGSI-LD in a backward compatible way with NGSI-v2 API. I.e. you can retrieve NGSI-LD stored data via NGSI v2 API and retrieve data will be describe following NGSI v2 format.
QuantumLeap is not a real time API, its purpose is to process notifications received from the Context Broker and to create temporal records for them. In general, the whole FIWARE stack, being based on a micro-service architecture, cannot be regarded as real time in case you have requirements on guaranteed delivery in a given amount of time.
However, even though hard real time may not be FIWARE's forte, in our experience a properly tuned FIWARE stack can perform extremely well and handle very demanding IoT workloads without a glitch - you just need to configure your infrastructure to handle that :)
Want to know more? Refer to the docs or checkout the Extra Resources below.
This project is contributed to FIWARE by Martel Innovate as part of its Orchestra Cities platform. You can find more FIWARE components in the FIWARE catalogue.
|:books: Documentation||:mortar_board: Academy||:whale: Docker Hub||:dart: Roadmap|
Refer to the Installation Guide.
QuantumLeap supports both Crate DB and Timescale as time-series DB backends. The following versions are currently covered in tests (see .circleci/config.yml):
13+ Timescale extension
2.3.0+ Postgis extension
As regards caching feature, QuantumLeap has been tested with Redis
Integration with Orion Context Broker is tested from version
Automated tests, to avoid too long testing time, are not combining all possible versions. This anyhow should not be an issue given that component integrations are not depending on each other. In general, only latest version listed is actively supported.
PR #373 introduced basic support for NGSI-LD. In short this means that using the current endpoint you are able to store NGSI-LD payloads with few caveats (see #398)
Docker images are available on docker hub:
latestrefers to the last release. This behaviour will be introduced since
edgerefers to the version in master, this behaviour is introduced since
*.*.*refers to specific releases.
CrateDB versions > 4.6 is affected by log4 security issue.
We recommend to update your deployments to CrateDB 4.6.5.
For CrateDB versions >= 3.2.0 it is possible to mitigate
the issue setting
or by setting the environment variable
Refer to the User Manual.
Refer to the Troubleshooting section.
Refer to the Contributing section and to the contribution guidelines.
The following is a collection of external guides and pages where you may find additional documentation about QuantumLeap. Note that these guides could be outdated (so could the official docs!), so we appreciate all efforts to keep consistency.
Orchestra Cities QuantumLeap has been adopted by the FIWARE community and is one of the core components that make up the FIWARE core context management stack. The companies listed below use QuantumLeap as part of their IoT solutions. If you would like to add your company to this list, please mention it in this issue or create a PR to update the list.
The following projects are linked to Orchestra Cities QuantumLeap, if you want to list it here, add your information on this issue or create a PR to update the list.
NGSI Go is a CLI supporting QL
Contact us if you need Enterprise Support for your QuantumLeap installation.
QuantumLeap is licensed under the MIT License
© 2017-2021 Martel Innovate