Repository: ignite Updated Branches: refs/heads/ignite-843-rc2 4dcaabec9 -> 97f2ab9d0
IGNITE-843 Fixed agent readme. Project: http://git-wip-us.apache.org/repos/asf/ignite/repo Commit: http://git-wip-us.apache.org/repos/asf/ignite/commit/97f2ab9d Tree: http://git-wip-us.apache.org/repos/asf/ignite/tree/97f2ab9d Diff: http://git-wip-us.apache.org/repos/asf/ignite/diff/97f2ab9d Branch: refs/heads/ignite-843-rc2 Commit: 97f2ab9d0d062bf410d88df1ac72c6b0162d98e8 Parents: 4dcaabe Author: Andrey <[email protected]> Authored: Wed Jan 20 18:00:57 2016 +0700 Committer: Andrey <[email protected]> Committed: Wed Jan 20 18:00:57 2016 +0700 ---------------------------------------------------------------------- modules/control-center-agent/README.txt | 110 +++++++++++++-------------- 1 file changed, 55 insertions(+), 55 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/ignite/blob/97f2ab9d/modules/control-center-agent/README.txt ---------------------------------------------------------------------- diff --git a/modules/control-center-agent/README.txt b/modules/control-center-agent/README.txt index 1fb94d2..1d62f68 100644 --- a/modules/control-center-agent/README.txt +++ b/modules/control-center-agent/README.txt @@ -5,82 +5,82 @@ Ignite Web Agent communicates with grid nodes via REST interface and connects to Two main functions of Ignite Web Agent: 1. Proxy between Ignite Web Console and Ignite Grid to execute SQL statements and collect metrics for monitoring. - You may need to specify URI for connect to Ignite REST server via "-n" option. + You may need to specify URI for connect to Ignite REST server via "-n" option. 2. Proxy between Ignite Web Console and user RDBMS to collect database metadata for later CacheTypeMetadata configuration. - You may need to copy JDBC driver into "./jdbc-drivers" subfolder or specify path via "-d" option. + You may need to copy JDBC driver into "./jdbc-drivers" subfolder or specify path via "-d" option. Usage example: - ignite-web-agent.sh + ignite-web-agent.sh Demo of Ignite Web Agent: - In order to simplify evaluation two demo modes were implemented: + In order to simplify evaluation two demo modes were implemented: - 1) Demo for metadata load from database. - In this mode an in-memory H2 database will started. - How to evaluate: - 1.1) Go to Ignite Web Console "Metadata" screen. - 1.2) Click "Load from demo database". - 1.3) Click "Next" button. You should see list of available schemas. - 1.4) Click "Next" button. You should see list of available tables. - 1.5) Click "Next" button. You should see metadata load options. - 1.6) Select some of them and click "Save". + 1) Demo for import domain model from database. + In this mode an in-memory H2 database will be started. + How to evaluate: + 1.1) Go to Ignite Web Console "Domain model" screen. + 1.2) Click "Demo". + 1.3) Click "Next" button. You should see list of available schemas. + 1.4) Click "Next" button. You should see list of available tables. + 1.5) Click "Next" button. You should see import options. + 1.6) Select some of them and click "Save". - 2) Demo for SQL. - In this mode internal Ignite node will be started. Cache created and populated with data. - How to evaluate: + 2) Demo for SQL. + How to evaluate: + In this mode internal Ignite node will be started. Cache created and populated with data. 2.1) Go to Ignite Web Console "SQL" menu and select "SQL demo" menu item. - 2.2) In "SQL demo" notebook paragraph enter SQL queries for tables: "Country, Department, Employee", "Parking, Car". + 2.2) "SQL demo" notebook contains preconfigured queries: "Simple query", "Query with aggregates", "Query with refresh rate". + 2.3) You can also execute any SQL queries for tables: "Country, Department, Employee", "Parking, Car". - For example: - 2.3) select "ParkingCache" cache, - 2.4) Enter SQL statement: - SELECT p.name, count(*) AS cnt - FROM "ParkingCache".Parking p - INNER JOIN "CarCache".Car c - ON (p.id) = (c.parkingId) - GROUP BY P.NAME - 2.5) Click "Execute" button. You should get some data in table. - 2.6) Click charts buttons to see auto generated charts. + For example: + 2.4) Enter SQL statement: + SELECT p.name, count(*) AS cnt + FROM "ParkingCache".Parking p + INNER JOIN "CarCache".Car c + ON (p.id) = (c.parkingId) + GROUP BY P.NAME + 2.5) Click "Execute" button. You should get some data in table. + 2.6) Click charts buttons to see auto generated charts. Configuration file: - Should be a file with simple line-oriented format as described here: http://docs.oracle.com/javase/7/docs/api/java/util/Properties.html#load(java.io.Reader) + Should be a file with simple line-oriented format as described here: http://docs.oracle.com/javase/7/docs/api/java/util/Properties.html#load(java.io.Reader) - Available entries names: - token - server-uri - node-uri - driver-folder + Available entries names: + token + server-uri + node-uri + driver-folder - Example configuration file: - token=1a2b3c4d5f - serverURI=wss://console.example.com:3001 + Example configuration file: + token=1a2b3c4d5f + serverURI=wss://console.example.com:3001 Security token: - 1) By default token will be included into downloaded agent zip. - 2) You can get/change token in your profile. + 1) By default token will be included into downloaded agent zip. + 2) You can get/change token in your profile. Ignite Web agent requirements: - 1) Ignite node should be started with REST server (move ignite-rest-http folder from lib/optional/ to lib/). - 2) Pass Ignite node REST server URI to agent. + 1) Ignite node should be started with REST server (move ignite-rest-http folder from lib/optional/ to lib/). + 2) Pass Ignite node REST server URI to agent. Options: - -h, --help - Print this help message - -c, --config - Path to configuration file - -d, --driver-folder - Path to folder with JDBC drivers, default value: ./jdbc-drivers - -n, --node-uri - URI for connect to Ignite REST server, default value: - http://localhost:8080 - -s, --server-uri - URI for connect to Ignite Web Console via web-socket protocol, default - value: wss://localhost:3001 - -t, --token - User's security token + -h, --help + Print this help message + -c, --config + Path to configuration file + -d, --driver-folder + Path to folder with JDBC drivers, default value: ./jdbc-drivers + -n, --node-uri + URI for connect to Ignite REST server, default value: + http://localhost:8080 + -s, --server-uri + URI for connect to Ignite Web Console via web-socket protocol, default + value: wss://localhost:3001 + -t, --token + User's security token Ignite Web Agent Build Instructions ============================================== If you want to build from sources run following command in Ignite project root folder: - mvn clean package -pl :ignite-control-center-agent -am -P control-center -DskipTests=true + mvn clean package -pl :ignite-control-center-agent -am -P control-center -DskipTests=true
