HippoClient

HippoClient 是一個介接 Hippo Manager 與安裝於 service 的 plugin，讓 microservice 達到監控與自動重啟的機制

項目結構

文件夾	說明
build-tool	service 的自動化安裝/移除 plugin 模組
cli	使用者操作介面
etc	cli 相關設定檔
plugin-templates	build tool 使用到的 template
example	示範程式碼，Demo 透過 hippo cli 操作 microservice

Installation

若為 MacOS 需安裝與 linux 一致的 getopt

brew install gnu-getopt
echo 'export PATH="/usr/local/opt/gnu-getopt/bin:$PATH"' >> ~/.bash_profile

安裝 python 環境與環境變數

執行./build-tool/install.sh

show parameters:

./build-tool/install.sh -h

[Installation]
    Usage: install.sh [OPTIONS]
    OPTIONS:
       -h|--help                             Show this message
       -a|--all                              Install all
       -p|--install-py                       Install Python
       -c|--install-cli-env                  Install Python Env for cli
       -t|--install-template-env             Install Python Env for template
       -v|--export-var                       Set up variable

run install.sh:

./build-tool/install.sh -a

填寫 CLI 相關設定

於 ./etc/cli-env.conf

[HippoManagerAPI]
host = localhost
port = 8080
base = /hippo/v0.2.0

填寫 plugin template 的 Kafka 相關資訊

於 ./plugin-templates/basic/etc/monitor.conf

name	description
KAFKA_HOST	kafka 的 host
HEALTH_TOPIC	傳送監控資訊的 topic

[kafka]
KAFKA_HOST=localhost:9092
HEALTH_TOPIC=service-health

HOW TO USE CLI

register

Usage

Usage: hippo register [OPTIONS]

Options

Options:
  -p, --project_home TEXT  [required]
  -s, --service_name TEXT  Service name, Default: last directory name from
                           ${project_home}
  -c, --run_cmd TEXT       command for run service, you can use
                           "{PROJECT_HOME}" variable to build command (e.g.
                           "python {PROJECT_HOME}/bin/message_client.py")
  --client_ip TEXT         Client server IP, Default: 192.168.0.106
  --api_host TEXT          hippo manager api host, Default: localhost
  --api_port TEXT          hippo manager api port, Default: 8080
  -h, --help               Show this message and exit.

Example

註冊一個 recommender-training 的 service

hippo register -p /Users/square_huang/test/recommender_system -s recommender-training

註冊一個 recommender-prediction 的 service，並加入 run command

hippo register -p /Users/square_huang/test/recommender_system -s recommender-prediction -c "sh /Users/square_huang/test/recommender_system/bin/mock_prediction.sh"

remove

Usage

Usage: hippo remove [OPTIONS]

Options

Options:
  --id TEXT          hippo id  [required]
  -f, --force        force stop and deregister if service is running
  -d, --del_service  delete service plugin from project
  --api_host TEXT    hippo manager api host, Default: localhost
  --api_port TEXT    hippo manager api port, Default: 8080
  -h, --help         Show this message and exit.

Example

取消註冊一個 service

若該 service 狀態為 running 時，將無法取消註冊

hippo remove --id 18d424b5f85790aad450d8d0f912ab28 

強制取消註冊一個 service

hippo remove --id 18d424b5f85790aad450d8d0f912ab28 -f

取消註冊一個 service，並刪除該 service 的 hippo plugin

hippo remove --id 18d424b5f85790aad450d8d0f912ab28 -d

start

Usage

Usage: hippo start [OPTIONS]

Options

Options:
  --id TEXT               hippo id  [required]
  -i, --interval INTEGER  sec
  --api_host TEXT         hippo manager api host, Default: localhost
  --api_port TEXT         hippo manager api port, Default: 8080
  -h, --help              Show this message and exit.

Example

啟動一個已註冊的 service

hippo start --id 6c58b631148c86d43e3b1c66bdb73d3f

啟動一個已註冊的 service ，並設定 監控區間 (interval)

hippo start --id 6c58b631148c86d43e3b1c66bdb73d3f -i 10

restart

Usage

Usage: hippo restart [OPTIONS]

Options

Options:
  --id TEXT               hippo id  [required]
  -i, --interval INTEGER  sec
  --api_host TEXT         hippo manager api host, Default: localhost
  --api_port TEXT         hippo manager api port, Default: 8080
  -h, --help              Show this message and exit.

Example

重新啟動一個正在執行的 service

hippo restart --id 6c58b631148c86d43e3b1c66bdb73d3f

重新啟動一個已註冊的 service ，並設定 監控區間 (interval)

hippo restart --id 6c58b631148c86d43e3b1c66bdb73d3f -i 10

stop

Usage

Usage: hippo stop [OPTIONS]

Options

Options:
  --id TEXT        hippo id  [required]
  --api_host TEXT  hippo manager api host, Default: localhost
  --api_port TEXT  hippo manager api port, Default: 8080
  -h, --help       Show this message and exit. 

Example

停止一個正在執行的 service

hippo-stop --id 6c58b631148c86d43e3b1c66bdb73d3f 

停止一個正在執行的 service，並刪除該 service 的 plugin

hippo-stop --id 6c58b631148c86d43e3b1c66bdb73d3f -d

status

Usage

Usage: hippo status

Options

Options:
  --id TEXT         hippo id
  --api_host TEXT   hippo manager api host, Default: localhost
  --api_port TEXT   hippo manager api port, Default: 8080
  -a, --all_mode    Get cluster status, Default: active
  -n, --node_mode   Get node (api_host) status
  -u, --user TEXT   filter by register user
  --client_ip TEXT  filter by client server IP
  -h, --help        Show this message and exit.

Example

查看 cluster 內所有的 service 狀態

hippo status
hippo status -u ubuntu
hippo status --client_ip 192.168.0.106

根據 id 查看 service 狀態

hippo status --id 6c58b631148c86d43e3b1c66bdb73d3f