これは Cepheus-CEP の管理ガイドです。
Requirements¶
- JAVA 8
- Maven 2 (ビルド専用)
ソースからのビルド¶
Githubからコードを入手する :
git clone https://github.com/Orange-OpenSource/fiware-cepheus.git
cd fiware-cepheus/cepheus-cep
スタンドアロンの JAR と Debian パッケージをビルドするには、maven が必要です :
mvn clean package
インストール¶
Cepheus-CEP をインストールするには、スタンドアロンの JAR をダウンロードするだけです。
Maven を使った Sonatype Central repository リポジトリからのダウンロード¶
maven がある場合、次のコマンドを実行できます :
mvn dependency:get -DgroupId=com.orange.cepheus -DartifactId=cepheus-cep -Dversion=XXXX -Dtransitive=false
ここで、XXXXは、1.0.1-SNAPSHOT や LATEST のようなインストールしたいバージョンです。
wget を使った Sonatype Central repository リポジトリからのダウンロード¶
maven をインストールしていない場合でも、wget やブラウザを使用してスタンドアロン JAR をダウンロードできます :
wget -O cepheus-cep.jar "https://oss.sonatype.org/service/local/artifact/maven/redirect?r=snapshots&g=com.orange.cepheus&a=cepheus-cep&v=LATEST"
実行¶
Cepheus-CEP は SpringBoot アプリケーションです。次の方法で maven を使ってソースから直接実行することもできます :
mvn spring-boot:run
またはスタンドアロン JAR から :
java -jar cepheus-cep.jar
Debian パッケージ¶
Cepheus-CEP は Debian と Raspbian システムでの展開を容易にするために、あらかじめ設定された Debian パッケージにも含まれています。
ダウンロード¶
wget を使用して Sonatype Central repository リポジトリからDebianパッケージをダウンロードしてください :
wget -O cepheus-cep.deb "https://oss.sonatype.org/service/local/artifact/maven/redirect?r=snapshots&g=com.orange.cepheus&a=cepheus-cep&v=LATEST&p=deb"
インストール¶
dpkg を使用してインストールします :
dpkg -i cepheus-cep.deb
パッケージは自動的に以下のようになります :
/usr/lib/cepheus下にスタンドアロンのJARを配置/etc/cepheus/cep.properties下に設定ファイルの設定/etc/init.d/cepheus-cep下にcepheus-cepinit.d 起動スクリプトを追加- マシンの起動時に
cepheus-cepを ポート8080で開始 /var/log/cepheus/cep.log下にログを置く/var/cepheus/cep.json下にデータを置く
実行¶
Cepheus-CEP デーモンを起動および停止するには、共通の service コマンドを使用します :
service cepheus-cep start
service cepheus-cep stop
service cepheus-cep restart
設定¶
いくつかのアプリケーション設定を編集するには :
- ソースからビルドするときの
src/main/resources/application.propertiesファイル - Debianパッケージの
/etc/cepheus/cep.propertiesような外部設定
これはアプリケーション・プロパティの短いリストです :
| Name | Description | Default value |
|---|---|---|
| server.port | port used | 8080 |
| data.path | path to store data | /tmp/ |
| subscriptionManager.periodicity | Periodicity of the subscription manager task | 300000 |
| subscriptionManager.duration | Duration of a NGSI subscription | PT1H |
| logging.level.com.orange.cepheus.cep | log level | INFO |
すべてのプロパティとデフォルト値は、src/main/resources/application.properties を確認してください。
コマンドライン・パラメータ¶
コマンドラインからすべてのアプリケーション・プロパティを変更することができます :
java -jar cepheus-cep.jar --property=value
例 :
java -jar cepheus-cep.jar --server.port=8080 --data.path=/var/cepheus/
外部設定ファイル¶
アプリケーションのパッケージ化後にアプリケーション・プロパティをカスタマイズする場合は、外部プロパティファイルのデフォルトのプロパティをオーバーライドできます。
次のいずれかを実行できます :
- 現在のパス
.または./config/下にapplication.propertiesを置く -
または
--spring.config.locationを使用してファイルのカスタムの場所を指定します :java -jar cepheus.cep.jar --spring.config.location=/etc/cepheus/cep.properties
データファイル¶
Cepheus-CEP は起動時にデータをロードし、データの更新を1つの JSON ファイルに保存します。
データファイルのデフォルトの場所は、data.file プロパティによって定義されます。
この Cepheus-CEP プロセスには、このファイルに対する書き込みアクセス権が必要です。
メトリクスとヘルス¶
アプリケーション・プロパティが持つ、Spring Boot アクチュエータ /info, /health そして /metrics エンドポイントを有効にすることができます :
endpoints.info.enabled=true
endpoints.metrics.enabled=true
endpoints.health.enabled=true
メトリックには、次のデータと各 EPL 文のメトリックが含まれます :
cpuTime, wallTime, numInput, numOutputIStream
ユーザ・ガイド¶
完全なユーザ&プログラミング・ガイドはここにあります