Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/orchestracities/ngsi-timeseries-api

QuantumLeap: a FIWARE Generic Enabler to support the usage of NGSIv2 (and NGSI-LD experimentally) data in time-series databases
https://github.com/orchestracities/ngsi-timeseries-api

cratedb fiware ngsi ngsi-ld quantum-leap quantumleap timescale timescaledb timeseries

Last synced: about 1 month ago
JSON representation

QuantumLeap: a FIWARE Generic Enabler to support the usage of NGSIv2 (and NGSI-LD experimentally) data in time-series databases

Host: GitHub
URL: https://github.com/orchestracities/ngsi-timeseries-api
Owner: orchestracities
License: mit
Created: 2017-03-14T17:57:45.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2024-05-05T16:45:13.000Z (about 2 months ago)
Last Synced: 2024-05-31T12:10:53.935Z (about 1 month ago)
Topics: cratedb, fiware, ngsi, ngsi-ld, quantum-leap, quantumleap, timescale, timescaledb, timeseries
Language: Python
Homepage: https://quantumleap.rtfd.io/
Size: 11.7 MB
Stars: 37
Watchers: 12
Forks: 48
Open Issues: 103
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Roadmap: docs/roadmap.md

Lists

awesome - QuantumLeap - A mechanism for supporting the storage of NGSI data into a time series database (CrateDB). (FIWARE Catalogue / Core Context Management)

README

        # QuantumLeap

[![FIWARE Core Context Management](https://nexus.lab.fiware.org/static/badges/chapters/core.svg)](https://www.fiware.org/developers/catalogue/)

[![License: MIT](https://img.shields.io/github/license/orchestracities/ngsi-timeseries-api.svg)](https://opensource.org/licenses/MIT)

[![Docker badge](https://img.shields.io/badge/quay.io-fiware%2Fquantumleap-grey?logo=red%20hat&labelColor=EE0000)](https://quay.io/repository/fiware/quantumleap)

[![Support](https://img.shields.io/badge/support-ask-yellowgreen.svg)](https://ask.fiware.org/questions/)




[![Documentation badge](https://img.shields.io/readthedocs/quantumleap.svg)](https://quantumleap.readthedocs.io/en/latest/)

[![CircleCI](https://circleci.com/gh/orchestracities/ngsi-timeseries-api.svg?style=shield)](https://circleci.com/gh/orchestracities/ngsi-timeseries-api)

[![Coverage Status](https://coveralls.io/repos/github/orchestracities/ngsi-timeseries-api/badge.svg?branch=master)](https://coveralls.io/github/orchestracities/ngsi-timeseries-api?branch=master)

![Status](https://nexus.lab.fiware.org/repository/raw/public/badges/statuses/full.svg)

[![Swagger Validator](https://img.shields.io/swagger/valid/2.0/https/raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v2.0/json/petstore-expanded.json.svg)](https://app.swaggerhub.com/apis/smartsdk/ngsi-tsdb)

[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/4394/badge)](https://bestpractices.coreinfrastructure.org/projects/4394)

QuantumLeap is the first implementation of

[an API](https://app.swaggerhub.com/apis/smartsdk/ngsi-tsdb)

that supports the storage of

[FIWARE NGSIv2](https://fiware.github.io/specifications/ngsiv2/stable/)

data into a

[time series database](https://en.wikipedia.org/wiki/Time_series_database).

It currently also experimentally supports the injection of

[NGSI-LD](https://www.etsi.org/deliver/etsi_gs/CIM/001_099/009/01.01.01_60/gs_CIM009v010101p.pdf)

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](https://en.wikipedia.org/wiki/Real-time_computing)

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](https://quantumleap.readthedocs.io/en/latest/)

or checkout the Extra Resources below.

This project is contributed to [FIWARE](https://www.fiware.org) by

[Martel Innovate](https://www.martel-innovate.com/) as part of its

[Orchestra Cities](https://www.orchestracities.com/)

platform.

You can find more FIWARE components in the

[FIWARE catalogue](https://catalogue.fiware.org).

|  :books: [Documentation](https://quantumleap.rtfd.io/) | :mortar_board: [Academy](https://fiware-academy.readthedocs.io/en/latest/core/quantum-leap) |    [quay.io](https://quay.io/repository/fiware/quantumleap) | :dart: [Roadmap](https://github.com/orchestracities/ngsi-timeseries-api/blob/master/docs/roadmap.md) |

|---|---|---|---|

## Contents

- [Install](#install)

- [Usage](#usage)

- [Troubleshooting](#troubleshooting)

- [Contributing](#contributing)

- [Extra resources](#extra-resources)

- [Adopters](#adopters)

- [Linked projects](#linked-projects)

- [License](#license)

## Install

Refer to the

[Installation Guide](https://quantumleap.readthedocs.io/en/latest/admin/).

QuantumLeap supports both Crate DB and Timescale as time-series DB

backends. The following versions are currently covered in tests

(see [.circleci/config.yml](https://github.com/orchestracities/ngsi-timeseries-api/blob/master/.circleci/config.yml#L204)):

- Crate backend: Crate DB version `4.2.7` up to `4.6.7`

- Timescale backend: Postgres version `12` up to `13` +

  Timescale extension `1.7.5` up to `2.3.0` + Postgis extension `2.5.*`.

As regards caching feature, QuantumLeap has been tested with Redis `4.*` up

to `6.2.3`.

Integration with Orion Context Broker is tested from version `2.4.2`

up to `3.3.1`.

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](https://github.com/orchestracities/ngsi-timeseries-api/pull/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](https://github.com/orchestracities/ngsi-timeseries-api/issue/398))

### Docker Images

Docker images are available on

[docker hub](https://hub.docker.com/r/orchestracities/quantumleap/):

- `latest` refers to the last release. This behaviour will be introduced

    since `0.8.3` release.

- `edge` refers to the version in master, this behaviour is introduced

    since `0.8.3-dev` activities.

- `*.*.*` refers to specific releases.

- additionally (usage is not recommended), we release images

  for each branch.

### Security note

CrateDB versions > 4.6 is affected by [log4 security issue](https://www.lunasec.io/docs/blog/log4j-zero-day/).

We recommend to update your deployments to CrateDB 4.6.5.

For CrateDB versions >= 3.2.0 it is possible to [mitigate](https://www.lunasec.io/docs/blog/log4j-zero-day-mitigation-guide/#option-2-enable-formatmsgnolookups)

the issue setting  `-Dlog4j2.formatMsgNoLookups=true` via `CRATE_JAVA_OPTS`

or by setting the environment variable `LOG4J_FORMAT_MSG_NO_LOOKUPS=true`.

## Usage

Refer to the [User Manual](https://quantumleap.readthedocs.io/en/latest/user/using/).

## Troubleshooting

Refer to the

[Troubleshooting](https://quantumleap.readthedocs.io/en/latest/user/troubleshooting/)

section.

## Contributing

Refer to the

[Contributing](https://quantumleap.readthedocs.io/en/latest/user/contributing/)

section and to the [contribution guidelines](./CONTRIBUTING.md).

## Extra resources

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.

- [FIWARE Step-by-step](https://fiware-tutorials.readthedocs.io/en/latest/time-series-data/index.html)

- [Orchestra Cities Helm Charts](https://github.com/orchestracities/charts)

## Adopters

[Orchestra Cities](https://www.orchestracities.com/) QuantumLeap has been

adopted by the FIWARE community and is one of the core components that

make up the [FIWARE core context management stack](https://www.fiware.org/developers/catalogue/).

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](https://github.com/orchestracities/ngsi-timeseries-api/issues/436)

or create a PR to update the list.

|  |  |   |  |  |

|---|---|---|---|---|

## Linked projects

The following projects are linked to

[Orchestra Cities](https://www.orchestracities.com/) QuantumLeap,

if you want to list it here, add your information on this

[issue](https://github.com/orchestracities/ngsi-timeseries-api/issues/436)

or create a PR to update the list.

|  
 NGSI Go is a CLI supporting QL |  |   |  |

|---|---|---|---|

## Enterprise Support

Contact us

if you need Enterprise Support for your QuantumLeap installation.

---

## License

QuantumLeap is licensed under the [MIT](LICENSE) License

© 2017-2023 Martel Innovate