This is an automated email from the ASF dual-hosted git repository. sunzesong pushed a commit to branch jmx_user_guide in repository https://gitbox.apache.org/repos/asf/incubator-iotdb.git
commit 4dd1fd0fec2d164aca0a3d4a712d3f2b58a0ea7e Author: samperson1997 <[email protected]> AuthorDate: Sat May 9 11:36:21 2020 +0800 Update JMX User Guide document --- docs/UserGuide/6-System Tools/3-JMX Tool.md | 43 ++++++++++++------------ docs/zh/UserGuide/6-System Tools/3-JMX Tool.md | 45 +++++++++++++------------- 2 files changed, 45 insertions(+), 43 deletions(-) diff --git a/docs/UserGuide/6-System Tools/3-JMX Tool.md b/docs/UserGuide/6-System Tools/3-JMX Tool.md index 9bc1d1f..12dc711 100644 --- a/docs/UserGuide/6-System Tools/3-JMX Tool.md +++ b/docs/UserGuide/6-System Tools/3-JMX Tool.md @@ -23,32 +23,33 @@ Java VisualVM is a tool that provides a visual interface for viewing detailed information about Java applications while they are running on a Java Virtual Machine (JVM), and for troubleshooting and profiling these applications. -## Config - -JMX authenticate configuration is `true` by default, so you need to edit JMX user name and password in `iotdb-engine.properties`. Related configurations are: +## Usage -* jmx\_user +Step1: Fetch IoTDB-sever. -|Name| jmx\_user | -|:---:|:---| -|Description| User name of JMX | -|Type| String | -|Default| admin | -|Effective|After restart system| +Step2: Edit configuration. -* jmx\_password +* IoTDB is LOCAL +View `$IOTDB_HOME/conf/jmx.password`, and use default user or add new users here. +If new users are added, remember to edit `$IOTDB_HOME/conf/jmx.access` and add new users' access -|Name| jmx\_password | -|:---:|:---| -|Description| User password of JMX | -|Type| String | -|Default| password | -|Effective|After restart system| +* IoTDB is not LOCAL +Edit `$IOTDB_HOME/conf/iotdb-env.sh`, and modify config below: +``` +JMX_LOCAL="false" +JMX_IP="the_real_iotdb_server_ip" # Write the actual IoTDB IP address +``` +View `$IOTDB_HOME/conf/jmx.password`, and use default user or add new users here. +If new users are added, remember to edit `$IOTDB_HOME/conf/jmx.access` and add new users' access -## Usage +Step 3: Start IoTDB-server. -Step1: Start sever. +Step 4: Use jvisualvm +1. Make sure jdk is installed +2. Open jvisualvm +3. Right-click at the left navigation area -> Add JMX connection +<img style="width:100%; max-width:400px; max-height:600px; margin-left:auto; margin-right:auto; display:block;" src="https://user-images.githubusercontent.com/19167280/81462914-5738c580-91e8-11ea-94d1-4ff6607e7e2c.png";> -Step2: Build connection. For local monitor, connection doesn't need to be built manually. For remote monitor, you can add your own ip address, and config the port. For IoTDB, port is `31999`. +4. Fill in information and log in as below: +<img style="width:100%; max-width:400px; max-height:600px; margin-left:auto; margin-right:auto; display:block;" src="https://user-images.githubusercontent.com/19167280/81462914-5738c580-91e8-11ea-94d1-4ff6607e7e2c.png";> -Step3: Start monitoring. By double clicking your connection ip address, you can see the detailed execution information about the application. diff --git a/docs/zh/UserGuide/6-System Tools/3-JMX Tool.md b/docs/zh/UserGuide/6-System Tools/3-JMX Tool.md index 30ad328..32fd6f3 100644 --- a/docs/zh/UserGuide/6-System Tools/3-JMX Tool.md +++ b/docs/zh/UserGuide/6-System Tools/3-JMX Tool.md @@ -23,32 +23,33 @@ Java VisualVM提供了一个可视化的界面，用于查看Java应用程序在Java虚拟机（JVM）上运行的详细信息，并对这些应用程序进行故障排除和分析。 -## 配置 - -JMX 访问权限认证设置默认打开，因此你需要编辑`iotdb-engine.properties`中的 JMX 用户名和密码。相关配置项包括： - -* jmx\_user +## 使用 -|名字| jmx\_user | -|:---:|:---| -|描述| JMX配置中的用户名 | -|类型| String | -|默认值| admin | -|改后生效方式|重启服务器生效| +第一步：获得IoTDB-server。 -* jmx\_password +第二步：编辑配置文件 -|名字| jmx\_password | -|:---:|:---| -|描述| JMX配置中的密码 | -|类型| String | -|默认值| password | -|改后生效方式|重启服务器生效| +* IoTDB在本地 +查看`$IOTDB_HOME/conf/jmx.password`，使用默认用户或者在此添加新用户 +若新增用户，编辑`$IOTDB_HOME/conf/jmx.access`，添加新增用户权限 -## 使用 +* IoTDB不在本地 +编辑`$IOTDB_HOME/conf/iotdb-env.sh` +修改以下参数： +``` +JMX_LOCAL="false" +JMX_IP="the_real_iotdb_server_ip" # 填写实际IoTDB的IP地址 +``` +查看`$IOTDB_HOME/conf/jmx.password`，使用默认用户或者在此添加新用户 +若新增用户，编辑`$IOTDB_HOME/conf/jmx.access`，添加新增用户权限 -第一步：启动IoTDB server。 +第三步：启动IoTDB-server。 -第二步：建立连接。对于本地的监控，不需要手动配置连接。对于远程的监控，可以添加远程的ip地址，并将端口配置为`31999`。 +第四步：使用jvisualvm +1. 确保安装jdk +2. 打开jvisualvm +3. 在左侧导航栏空白处右键 -> 添加JMX连接 +<img style="width:100%; max-width:400px; max-height:600px; margin-left:auto; margin-right:auto; display:block;" src="https://user-images.githubusercontent.com/19167280/81462914-5738c580-91e8-11ea-94d1-4ff6607e7e2c.png";> -第三步：开始监控。双击你所建立的ip地址，就可以看到执行应用的详细信息。 +4. 填写信息进行登录，按下图分别填写连接 -> 安全凭证 -> 勾选”不要求SSL连接” -> 确定 +<img style="width:100%; max-width:400px; max-height:600px; margin-left:auto; margin-right:auto; display:block;" src="https://user-images.githubusercontent.com/19167280/81462914-5738c580-91e8-11ea-94d1-4ff6607e7e2c.png";>
![https://user-images.githubusercontent.com/19167280/81462914-5738c580-91e8-11ea-94d1-4ff6607e7e2c.png"](https://user-images.githubusercontent.com/19167280/81462914-5738c580-91e8-11ea-94d1-4ff6607e7e2c.png"){kind=link}