chore: add README for OpenTSDB bridge

This commit is contained in:
firest 2023-04-18 10:24:39 +08:00
parent 0b46acda87
commit 540518eac3
3 changed files with 34 additions and 14 deletions

View File

@ -1,9 +1,36 @@
emqx_bridge_opentsdb
=====
# EMQX OpenTSDB Bridge
An OTP application
[OpenTSDB](http://opentsdb.net) is a distributed, scalable Time Series Database (TSDB) written on top of HBase.
Build
-----
OpenTSDB was written to address a common need: store, index and serve metrics collected from computer systems (network gear, operating systems, applications) at a large scale, and make this data easily accessible and graphable.
$ rebar3 compile
OpenTSDB allows you to collect thousands of metrics from tens of thousands of hosts and applications, at a high rate (every few seconds).
OpenTSDB will never delete or downsample data and can easily store hundreds of billions of data points.
The application is used to connect EMQX and OpenTSDB. User can create a rule and easily ingest IoT data into OpenTSDB by leveraging the
[EMQX Rules](https://docs.emqx.com/en/enterprise/v5.0/data-integration/rules.html).
# Documentation
- Refer to [EMQX Rules](https://docs.emqx.com/en/enterprise/v5.0/data-integration/rules.html)
for the EMQX rules engine introduction.
# HTTP APIs
- Several APIs are provided for bridge management, which includes create bridge,
update bridge, get bridge, stop or restart bridge and list bridges etc.
Refer to [API Docs - Bridges](https://docs.emqx.com/en/enterprise/v5.0/admin/api-docs.html#tag/Bridges) for more detailed information.
# Contributing
Please see our [contributing.md](../../CONTRIBUTING.md).
# License
EMQ Business Source License 1.1, refer to [LICENSE](BSL.txt).

View File

@ -115,11 +115,7 @@ case "${WHICH_APP}" in
export PROFILE='emqx'
fi
;;
apps/emqx_bridge_opents)
## ensure enterprise profile when testing ee applications
export PROFILE='emqx-enterprise'
;;
*)
*)
export PROFILE="${PROFILE:-emqx}"
;;
esac

View File

@ -72,9 +72,6 @@ describe_app() {
runner="docker"
fi
case "${app}" in
apps/emqx_bridge_opents)
profile='emqx-enterprise'
;;
apps/*)
if [[ -f "${app}/BSL.txt" ]]; then
profile='emqx-enterprise'