Skip to content

Commit

Permalink
Merge d17b9dc into 45aff7a
Browse files Browse the repository at this point in the history
  • Loading branch information
chicco785 committed Feb 2, 2021
2 parents 45aff7a + d17b9dc commit f705c4b
Show file tree
Hide file tree
Showing 37 changed files with 118 additions and 109 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Expand Up @@ -62,7 +62,7 @@ the conversation.
"FIWARE Individual Contributor License Agreement"
[conduct]: ./CODE_OF_CONDUCT.md
"Contributor Covenant Code of Conduct"
[gi]: https://github.com/smartsdk/ngsi-timeseries-api/issues
[gi]: https://github.com/orchestracities/ngsi-timeseries-api/issues
"GitHub Issues"
[pr]: https://github.com/smartsdk/ngsi-timeseries-api/pulls
[pr]: https://github.com/orchestracities/ngsi-timeseries-api/pulls
"GitHub Pull Requests"
2 changes: 1 addition & 1 deletion CREDITS
Expand Up @@ -14,6 +14,6 @@ Major contributing authors (with help of `git shortlog -sn`) include:
- ohylli

For a complete list, see
https://github.com/smartsdk/ngsi-timeseries-api/graphs/contributors
https://github.com/orchestracities/ngsi-timeseries-api/graphs/contributors

We would like to thank everyone who contributed to QuantumLeap, also to those who helped discuss and mature the core ideas.
2 changes: 1 addition & 1 deletion Dockerfile
Expand Up @@ -37,5 +37,5 @@ ENTRYPOINT ["python", "app.py"]
# $ docker run -it --rm \
# -p 8668:8668 \
# -v $(pwd)/gunicorn.conf.py:/gunicorn.conf.py
# smartsdk/quantumleap --config /gunicorn.conf.py
# orchestracities/quantumleap --config /gunicorn.conf.py
#
14 changes: 7 additions & 7 deletions README.md
@@ -1,13 +1,13 @@
# 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/smartsdk/ngsi-timeseries-api.svg)](https://opensource.org/licenses/MIT)
[![Docker Status](https://img.shields.io/docker/pulls/smartsdk/quantumleap.svg)](https://hub.docker.com/r/smartsdk/quantumleap/)
[![License: MIT](https://img.shields.io/github/license/orchestracities/ngsi-timeseries-api.svg)](https://opensource.org/licenses/MIT)
[![Docker Status](https://img.shields.io/docker/pulls/orchestracities/quantumleap.svg)](https://hub.docker.com/r/orchestracities/quantumleap/)
[![Support](https://img.shields.io/badge/support-ask-yellowgreen.svg)](https://ask.fiware.org/questions/)
<br/>
[![Documentation badge](https://img.shields.io/readthedocs/quantumleap.svg)](https://quantumleap.readthedocs.io/en/latest/)
[![Build Status](https://travis-ci.com/smartsdk/ngsi-timeseries-api.svg?branch=master)](https://travis-ci.com/smartsdk/ngsi-timeseries-api)
[![Coverage Status](https://coveralls.io/repos/github/smartsdk/ngsi-timeseries-api/badge.svg?branch=master)](https://coveralls.io/github/smartsdk/ngsi-timeseries-api?branch=master)
[![Build Status](https://travis-ci.com/orchestracities/ngsi-timeseries-api.svg?branch=master)](https://travis-ci.com/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/static/badges/statuses/quantum-leap.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)
Expand Down Expand Up @@ -37,7 +37,7 @@ or checkout the Extra Resources below.
This project is part of [FIWARE](https://www.fiware.org). 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) | :whale: [Docker Hub](https://hub.docker.com/r/smartsdk/quantumleap/) | :dart: [Roadmap](https://github.com/smartsdk/ngsi-timeseries-api/blob/master/docs/roadmap.md) |
| :books: [Documentation](https://quantumleap.rtfd.io/) | :mortar_board: [Academy](https://fiware-academy.readthedocs.io/en/latest/core/quantum-leap) | :whale: [Docker Hub](https://hub.docker.com/r/orchestracities/quantumleap/) | :dart: [Roadmap](https://github.com/orchestracities/ngsi-timeseries-api/blob/master/docs/roadmap.md) |
|---|---|---|---|

## Contents
Expand All @@ -61,9 +61,9 @@ the following versions:
- Timescale backend: Postgres version `10.*` or `11.*` +
Timescale extension `1.3.*` + Postgis extension `2.5.*`.

PR [#373](https://github.com/smartsdk/ngsi-timeseries-api/pull/373) introduced
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/smartsdk/ngsi-timeseries-api/issue/398))
you are able to store NGSI-LD payloads with few caveats (see [#398](https://github.com/orchestracities/ngsi-timeseries-api/issue/398))

## Usage

Expand Down
2 changes: 1 addition & 1 deletion docker/docker-compose.yml
Expand Up @@ -16,7 +16,7 @@ services:
retries: 3

quantumleap:
image: ${QL_IMAGE:-smartsdk/quantumleap}
image: ${QL_IMAGE:-orchestracities/quantumleap}
ports:
- "8668:8668"
depends_on:
Expand Down
2 changes: 1 addition & 1 deletion docs/manuals.ja/admin/check.md
Expand Up @@ -138,7 +138,7 @@ Postman を使用しない場合は、以下の同等の curl コマンドを使
データが失われたりする可能性があります。
常にそうであるように、自動化は慎重に使用してください。

[ここ](https://github.com/smartsdk/ngsi-timeseries-api/blob/master/src/tests/test_integration.py)
[ここ](https://github.com/orchestracities/ngsi-timeseries-api/blob/master/src/tests/test_integration.py)
にテストスクリプトがあります。デプロイに応じて、設定する必要のある入力変数に
注意してください。これらは、コア・サービスを見つけるための URL を示します。
デフォルトでは、すべてのサービスはローカルの Docker ベースのデプロイで
Expand Down
8 changes: 4 additions & 4 deletions docs/manuals.ja/admin/index.md
Expand Up @@ -25,7 +25,7 @@ docker-compose --version
```

QuantumLeap の Docker イメージは、
[https://hub.docker.com/r/smartsdk/quantumleap/](https://hub.docker.com/r/smartsdk/quantumleap/)
[https://hub.docker.com/r/orchestracities/quantumleap/](https://hub.docker.com/r/orchestracities/quantumleap/)
でホストされています。

今、あなたのシナリオに応じて、さまざまな展開オプションがあります。
Expand All @@ -40,7 +40,7 @@ QuantumLeap の実験をできるだけ早く開始するには、以下の手

**重要:** 本番環境ではこのアプローチを使用しないでください。

[このdocker-compose.yml](https://raw.githubusercontent.com/smartsdk/ngsi-timeseries-api/master/docker/docker-compose-dev.yml)
[このdocker-compose.yml](https://raw.githubusercontent.com/orchestracities/ngsi-timeseries-api/master/docker/docker-compose-dev.yml)
ファイルのコピーをダウンロードするか、またはローカル作成してください。
その後、起動してください :

Expand All @@ -54,7 +54,7 @@ $ docker-compose -f docker-compose-dev.yml up -d
```
$ docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
8cf0b544868d smartsdk/quantumleap "/bin/sh -c 'python …" 2 minutes ago Up 2 minutes 0.0.0.0:8668->8668/tcp docker_quantumleap_1
8cf0b544868d orchestracities/quantumleap "/bin/sh -c 'python …" 2 minutes ago Up 2 minutes 0.0.0.0:8668->8668/tcp docker_quantumleap_1
aa09dbcb8500 fiware/orion:1.13.0 "/usr/bin/contextBro…" 2 minutes ago Up 2 minutes (healthy) 0.0.0.0:1026->1026/tcp docker_orion_1
32709dbc5701 grafana/grafana "/run.sh" 2 minutes ago Up 2 minutes 0.0.0.0:3000->3000/tcp docker_grafana_1
ed9f8a60b6e8 crate:1.0.5 "/docker-entrypoint.…" 2 minutes ago Up 2 minutes 0.0.0.0:4200->4200/tcp, 0.0.0.0:4300->4300/tcp, 5432-5532/tcp docker_crate_1
Expand Down Expand Up @@ -129,5 +129,5 @@ QuantumLeap サービスを Kubernetes にデプロイするには、
をご覧ください。
Generic Enabler と外部依存関係の QL がどのバージョンで使用され、
テストされているかを確認するには、展開に使用される
[docker-compose-dev.yml](https://raw.githubusercontent.com/smartsdk/ngsi-timeseries-api/master/docker/docker-compose-dev.yml)
[docker-compose-dev.yml](https://raw.githubusercontent.com/orchestracities/ngsi-timeseries-api/master/docker/docker-compose-dev.yml)
ファイルをチェックアウトします。
2 changes: 1 addition & 1 deletion docs/manuals.ja/admin/ports.md
Expand Up @@ -22,6 +22,6 @@
|TCP | 6379 | Redisキャッシュ (ジオ・コーディングで使用) |

このリポジトリの
[docker-compose-dev.yml](https://raw.githubusercontent.com/smartsdk/ngsi-timeseries-api/master/docker/docker-compose-dev.yml)
[docker-compose-dev.yml](https://raw.githubusercontent.com/orchestracities/ngsi-timeseries-api/master/docker/docker-compose-dev.yml)
ファイル (実際にはデプロイに使用したものはもちろんのこと) で公開されている
ポートをいつでも調べることができます。
2 changes: 1 addition & 1 deletion docs/manuals.ja/user/contributing.md
Expand Up @@ -2,7 +2,7 @@

コントリビューションはプルリクエストの形でより歓迎します。

作業する[未解決の問題](https://github.com/smartsdk/ngsi-timeseries-api/issues)
作業する[未解決の問題](https://github.com/orchestracities/ngsi-timeseries-api/issues)
の1つを選択するか、自分の必要に応じて拡張機能を提供することができます。
いずれにしても、事前に連絡を取り、コントリビューションが現在の開発状況と一致する
ことを確認することをお勧めします。
Expand Down
6 changes: 3 additions & 3 deletions docs/manuals.ja/user/index.md
Expand Up @@ -283,11 +283,11 @@ NGSI 型 (したがって SQL 型) は値から派生します。次のロジッ
で説明する命名ガイドラインを遵守する必要があります

- 属性メタデータは依然として永続化されていません。
[Issue 12](https://github.com/smartsdk/ngsi-timeseries-api/issues/12)
[Issue 12](https://github.com/orchestracities/ngsi-timeseries-api/issues/12)
を参照してください

- 最近導入された単一の通知における複数のデータのサポート
([PR 191](https://github.com/smartsdk/ngsi-timeseries-api/pull/191) を参照)
([PR 191](https://github.com/orchestracities/ngsi-timeseries-api/pull/191) を参照)
が、依然として以下の制限が適用されます。単一のデータ・エンティティにエラーが
あると、すべてのセットが無効になります。大きなメッセージサイズに対する最適化は
ありません
Expand Down Expand Up @@ -427,5 +427,5 @@ address が都市名、番地、郵便番号を含む完全な住所であれば
コンテナに環境変数 `USE_GEOCODING``True` に設定し、環境変数 `REDIS_HOST`
`REDIS_PORT` をそれぞれ REDIS
インスタンスとそのアクセスポートの場所に設定する必要があります。 たとえば、
[docker-compose-dev.yml](https://raw.githubusercontent.com/smartsdk/ngsi-timeseries-api/master/docker/docker-compose-dev.yml)
[docker-compose-dev.yml](https://raw.githubusercontent.com/orchestracities/ngsi-timeseries-api/master/docker/docker-compose-dev.yml)
を参照してください。
2 changes: 1 addition & 1 deletion docs/manuals.ja/user/troubleshooting.md
Expand Up @@ -76,7 +76,7 @@ CrateDB が 3D 座標をサポートしていないという事実に関連し
## バグ・レポート

バグは、github リポジトリの
[issues](https://github.com/smartsdk/ngsi-timeseries-api/issues)
[issues](https://github.com/orchestracities/ngsi-timeseries-api/issues)
の形で報告する必要があります。

重複した issues を報告する前に、既に報告された issues を見てください :)
Expand Down
20 changes: 13 additions & 7 deletions docs/manuals/admin/benchmarks.md
Expand Up @@ -33,21 +33,27 @@ docker run -i --rm loadimpact/k6 run --vus 30 --duration 60s - < notify-load-tes
```

Tests shows that:
* caching metadata improves throughput of inserts , but usage of redis, has not the same impact as in memory
* the number of queries linked to metadata is not the only element affecting insert performance,

- caching metadata improves throughput of inserts , but usage of redis, has not the same impact as in memory

- the number of queries linked to metadata is not the only element affecting insert performance,
due to the nature of http request, up to QL v0.7.6, we created a db connection for each insert,
opening the connection takes time. From v0.8 we reuse existing connections. This proved to increase throughput of 100%
compared just to just redis caching.

System used for testing:
Mac2016 with 3.1 GhZ i7 (i.e. 4 cores) and 16GB Ram

* Baseline (v0.7.6): 44 req/s - 600 ms avg response time -
- Baseline (v0.7.6): 44 req/s - 600 ms avg response time -
(crate queries peak: select 111 q/sec, insert 54 q/sec)
* Redis caching: 60 req/s - (no data collected on response time)
* In memory caching: 95 req/s - (no data collected on response time)
* Redis caching + connection re-usage: 100 req/s - 200 ms avg response time

- Redis caching: 60 req/s - (no data collected on response time)

- In memory caching: 95 req/s - (no data collected on response time)

- Redis caching + connection re-usage: 100 req/s - 200 ms avg response time
(crate queries peak: select 7 q/sec, insert 142 q/sec)
* Connection re-usage (without any cache): 55 req/s - 400 ms avg response time

- Connection re-usage (without any cache): 55 req/s - 400 ms avg response time
(crate queries peak: select 177 q/sec, insert 86 q/sec)

2 changes: 1 addition & 1 deletion docs/manuals/admin/check.md
Expand Up @@ -132,7 +132,7 @@ integration tests that checks exactly this connection among core components.
with valuable data. If things go wrong in the test, it may leave garbage data
or can lead to data loses. As always, use automation with caution.

You can see the test script [here](https://github.com/smartsdk/ngsi-timeseries-api/blob/master/src/tests/test_integration.py).
You can see the test script [here](https://github.com/orchestracities/ngsi-timeseries-api/blob/master/src/tests/test_integration.py).
Pay attention to the input variables that, depending on your deployment, you
may need to configure. These indicate the URLs where to find the core services.
By default, it assumes all services run in a local docker-based deployment.
Expand Down
6 changes: 4 additions & 2 deletions docs/manuals/admin/configuration.md
Expand Up @@ -29,15 +29,17 @@ To configure QuantumLeap you can use the following environment variables:
| `LOGLEVEL` | Define the log level for all services (`DEBUG`, `INFO`, `WARNING` , `ERROR`) |

**NOTE**
* `DEFAULT_LIMIT`. This variable specifies the upper limit L of rows a query

- `DEFAULT_LIMIT`. This variable specifies the upper limit L of rows a query
operation is allowed to fetch from the database and return to client. The
actual number of rows will be the least of L and the client-specified limit
or L if the client didn't specify a limit. If not set through this variable,
L defaults to 10,000. This variable is read in on each API call to query
endpoints so it can be set dynamically and it will affect every subsequent
query operation. The variable string value you set should be convertible to
an integer, if not, the default value of 10,000 will be used instead.
* `KEEP_RAW_ENTITY`. If true, then each notified entity will be stored in its

- `KEEP_RAW_ENTITY`. If true, then each notified entity will be stored in its
entirety as JSON in an additional column of the corresponding entity table.
(This may result in the table needing up to 10x more storage.) If false, the
JSON will only be stored (as detailed earlier) in case the conversion from
Expand Down
8 changes: 4 additions & 4 deletions docs/manuals/admin/index.md
Expand Up @@ -19,7 +19,7 @@ To check it works, you should be able to successfully run...
docker-compose --version
```

The QuantumLeap Docker Image is hosted at [https://hub.docker.com/r/smartsdk/quantumleap/](https://hub.docker.com/r/smartsdk/quantumleap/).
The QuantumLeap Docker Image is hosted at [https://hub.docker.com/r/orchestracities/quantumleap/](https://hub.docker.com/r/orchestracities/quantumleap/).

Now, depending on your scenario, you have different deployment options. See
from the sections below which fits yours. After installation, you can check
Expand All @@ -33,7 +33,7 @@ QuantumLeap ASAP.

**Important:** Do not use this approach for production environments.

Download (or create locally) a copy of [this docker-compose.yml](https://raw.githubusercontent.com/smartsdk/ngsi-timeseries-api/master/docker/docker-compose-dev.yml)
Download (or create locally) a copy of [this docker-compose.yml](https://raw.githubusercontent.com/orchestracities/ngsi-timeseries-api/master/docker/docker-compose-dev.yml)
file. Then start it up:

```
Expand All @@ -46,7 +46,7 @@ After a while, check that all containers are up and running:
```
$ docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
8cf0b544868d smartsdk/quantumleap "/bin/sh -c 'python …" 2 minutes ago Up 2 minutes 0.0.0.0:8668->8668/tcp docker_quantumleap_1
8cf0b544868d orchestracities/quantumleap "/bin/sh -c 'python …" 2 minutes ago Up 2 minutes 0.0.0.0:8668->8668/tcp docker_quantumleap_1
aa09dbcb8500 fiware/orion:1.13.0 "/usr/bin/contextBro…" 2 minutes ago Up 2 minutes (healthy) 0.0.0.0:1026->1026/tcp docker_orion_1
32709dbc5701 grafana/grafana "/run.sh" 2 minutes ago Up 2 minutes 0.0.0.0:3000->3000/tcp docker_grafana_1
ed9f8a60b6e8 crate:1.0.5 "/docker-entrypoint.…" 2 minutes ago Up 2 minutes 0.0.0.0:4200->4200/tcp, 0.0.0.0:4300->4300/tcp, 5432-5532/tcp docker_crate_1
Expand Down Expand Up @@ -115,5 +115,5 @@ greater than `6.3.1`. More info of FIWARE releases can be seen [here](https://fo

To check which versions of the Generic Enablers and external dependencies QL is
used and tested, checkout the
[docker-compose-dev.yml](https://raw.githubusercontent.com/smartsdk/ngsi-timeseries-api/master/docker/docker-compose-dev.yml)
[docker-compose-dev.yml](https://raw.githubusercontent.com/orchestracities/ngsi-timeseries-api/master/docker/docker-compose-dev.yml)
file used for the deployment.
2 changes: 1 addition & 1 deletion docs/manuals/admin/ports.md
Expand Up @@ -22,5 +22,5 @@ are used within the cluster.
|TCP | 6379 | Redis cache (used by geocoding) |

For more info on ports numbers, you can always inspect the ports being exposed
in the [docker-compose-dev.yml](https://raw.githubusercontent.com/smartsdk/ngsi-timeseries-api/master/docker/docker-compose-dev.yml)
in the [docker-compose-dev.yml](https://raw.githubusercontent.com/orchestracities/ngsi-timeseries-api/master/docker/docker-compose-dev.yml)
file of this repo (actually the one you used to deploy, of course).

0 comments on commit f705c4b

Please sign in to comment.