Skip to content

Commit d91c46f

Browse files
renetapopovarecrwplay
authored andcommitted
editorial review part 2
1 parent fc89d2c commit d91c46f

File tree

7 files changed

+121
-117
lines changed

7 files changed

+121
-117
lines changed

README.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This repository contains the AsciiDoc and other sources to build the link:{docs-
77

88
== Installation
99

10-
To build these docs locally you will need link:https://nodejs.org/en/download/package-manager/[Node & NPM^] installed.
10+
To build these docs locally you need link:https://nodejs.org/en/download/package-manager/[Node & NPM^] installed.
1111

1212
To install the dependencies run:
1313

@@ -26,15 +26,15 @@ To preview the docs, run:
2626
npm run start
2727
----
2828

29-
This will build a set of HTML files in `build/site` and then serve them through an express server at http://localhost:8000.
30-
The start script will also listen for changes and automatically rebuild the files automatically.
31-
You will still need to refresh the page to view the changes.
29+
This builds a set of HTML files in `build/site` and then serves them through an express server at http://localhost:8000.
30+
The start script also listens for changes and automatically rebuilds the files.
31+
You still need to refresh the page to view the changes.
3232

3333

3434
== Contributing
3535

3636
To make changes to this repository, please create a fork of this repo and a new branch to stage your changes.
37-
Your branch should be prefixed with the version number, for example `5.0-feature-to-document`.
37+
Your branch should be prefixed with the version number, for example, `5.0-feature-to-document`.
3838

3939
When you are finished with your changes push the branch to your fork and create a Pull Request.
4040
Please add at least one approver.

modules/ROOT/pages/jmx-metrics.adoc

Lines changed: 23 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -6,45 +6,44 @@
66

77
This topic describes how to access JMX for Neo4j DBMS to monitor metrics.
88

9-
Neo4j provides different levels of monitoring facilities in order to supply a continuous overview of the system's health.
9+
Neo4j provides different levels of monitoring facilities to supply a continuous overview of the system's health.
1010
For a description of the monitoring options, see link:{neo4j-docs-base-uri}/operations-manual/{page-version}/monitoring[Neo4j Operations Manual -> Monitoring].
1111
Many of the metrics are exposed through link:https://www.oracle.com/java/technologies/javase/javamanagement.html[JMX^].
1212

1313
[NOTE]
1414
====
15-
Please note that the available JMX MBeans and their names have been updated in Neo4j 4.0.
16-
Beans that duplicate metrics or monitoring options, described in link:{neo4j-docs-base-uri}/operations-manual/{page-version}/monitoring[Neo4j Operations Manual -> Monitoring], have been removed.
15+
The available JMX MBeans and their names have been updated in Neo4j 4.0.
16+
Beans that duplicate metrics or monitoring options, described in link:{neo4j-docs-base-uri}/operations-manual/{page-version}/monitoring/metrics/reference/#jvm-metrics[Neo4j Operations Manual -> Monitoring], have been removed.
1717
====
1818

19-
2019
[[jmx-remote]]
2120
== Adjusting remote JMX access to Neo4j
2221

23-
Per default, the Neo4j Enterprise Server edition does not allow remote JMX connections.
22+
By default, the Neo4j Enterprise edition does not allow remote JMX connections.
2423
To enable this feature, you need to enable JMX Remote Management and also configure JMX for secure remote access, in the link:{neo4j-docs-base-uri}/operations-manual/{page-version}/configuration/neo4j-conf[_conf/neo4j.conf_ file].
2524

2625

2726
[[enable-jmx-remote]]
2827
=== Enable JMX Remote Management
2928

3029
Add the following lines to the _conf/neo4j.conf_ file to enable JMX Remote Management.
31-
If you run into issues with automatic host name discovery, you can uncomment the following configuration line:
30+
If you run into issues with automatic hostname discovery, you can uncomment the following configuration line:
3231

33-
`+dbms.jvm.additional=-Djava.rmi.server.hostname=$THE_NEO4J_SERVER_HOSTNAME+`
32+
`+server.jvm.additional=-Djava.rmi.server.hostname=$THE_NEO4J_SERVER_HOSTNAME+`
3433

3534
[source, properties]
3635
----
37-
dbms.jvm.additional=-Dcom.sun.management.jmxremote.port=3637
38-
dbms.jvm.additional=-Dcom.sun.management.jmxremote.authenticate=true
39-
dbms.jvm.additional=-Dcom.sun.management.jmxremote.ssl=false
36+
server.jvm.additional=-Dcom.sun.management.jmxremote.port=3637
37+
server.jvm.additional=-Dcom.sun.management.jmxremote.authenticate=true
38+
server.jvm.additional=-Dcom.sun.management.jmxremote.ssl=false
4039
41-
# Some systems cannot discover host name automatically, and need this line configured:
42-
# dbms.jvm.additional=-Djava.rmi.server.hostname=$THE_NEO4J_SERVER_HOSTNAME
40+
# Some systems cannot discover the hostname automatically, and need this line configured:
41+
# server.jvm.additional=-Djava.rmi.server.hostname=$THE_NEO4J_SERVER_HOSTNAME
4342
----
4443

4544
[IMPORTANT]
4645
====
47-
Although SSL for JMX Remote Management is disabled throughout this document, to configure it based on your requirements you can follow the instructions in the link:https://docs.oracle.com/en/java/javase/11/management/monitoring-and-management-using-jmx-technology.html[Java SE 11 Monitoring and Management Guide^].
46+
Although SSL for JMX Remote Management is disabled throughout this document, to configure it based on your requirements, you can follow the instructions in the link:https://docs.oracle.com/en/java/javase/11/management/monitoring-and-management-using-jmx-technology.html[Java SE 11 Monitoring and Management Guide^].
4847
====
4948

5049

@@ -54,7 +53,7 @@ Although SSL for JMX Remote Management is disabled throughout this document, to
5453
Password authentication is enabled by default in JMX Remote Management.
5554
You can find information about setting up authentication with LDAP and file-based approach in the following sections.
5655

57-
Please refer to the link:https://docs.oracle.com/en/java/javase/11/management/monitoring-and-management-using-jmx-technology.html[Java SE 11 Monitoring and Management Guide^] for more options, including configuration steps for SSL client authentication.
56+
Refer to the link:https://docs.oracle.com/en/java/javase/11/management/monitoring-and-management-using-jmx-technology.html[Java SE 11 Monitoring and Management Guide^] for more options, including configuration steps for SSL client authentication.
5857

5958

6059
[[ldap]]
@@ -104,8 +103,8 @@ After finishing your JAAS configuration, configure JMX to use it by adding the f
104103

105104
[source, properties]
106105
----
107-
dbms.jvm.additional=-Dcom.sun.management.jmxremote.login.config=Neo4jJMXConfig
108-
dbms.jvm.additional=-Djava.security.auth.login.config=/absolute/path/to/conf/jmx.ldap
106+
server.jvm.additional=-Dcom.sun.management.jmxremote.login.config=Neo4jJMXConfig
107+
server.jvm.additional=-Djava.security.auth.login.config=/absolute/path/to/conf/jmx.ldap
109108
----
110109

111110
With this setup, you can connect to JMX monitoring of the Neo4j server using `<IP-OF-SERVER>:3637`, with a valid username and password defined in your LDAP directory.
@@ -116,18 +115,18 @@ With this setup, you can connect to JMX monitoring of the Neo4j server using `<I
116115

117116
[IMPORTANT]
118117
====
119-
The file-based password authentication stores the password in clear-text and is intended only for development use.
118+
The file-based password authentication stores the password in clear text and is intended only for development use.
120119
====
121120

122121
You can set your password for JMX remote access and save it in the _conf/jmx.password_ configuration file.
123-
Please note that on Unix-based systems, the _jmx.password_ file needs to be owned by the user that will run the server, and have permissions set to `0600`.
122+
Note that on Unix-based systems, the _jmx.password_ file needs to be owned by the user that runs the server, and has permissions set to `0600`.
124123

125124
[source, properties]
126125
----
127126
monitorRole password_to_be_changed
128127
----
129128

130-
Next, configure access level and save it in _conf/jmx.access_ configuration file.
129+
Next, configure the access level and save it in _conf/jmx.access_ configuration file.
131130

132131
[source, properties]
133132
----
@@ -138,8 +137,8 @@ Finally, configure JMX to use the completed password and access files by adding
138137

139138
[source, properties]
140139
----
141-
dbms.jvm.additional=-Dcom.sun.management.jmxremote.password.file=/absolute/path/to/conf/jmx.password
142-
dbms.jvm.additional=-Dcom.sun.management.jmxremote.access.file=/absolute/path/to/conf/jmx.access
140+
server.jvm.additional=-Dcom.sun.management.jmxremote.password.file=/absolute/path/to/conf/jmx.password
141+
server.jvm.additional=-Dcom.sun.management.jmxremote.access.file=/absolute/path/to/conf/jmx.access
143142
----
144143

145144
With this setup, you can connect to JMX monitoring of the Neo4j server using `<IP-OF-SERVER>:3637`, with the username `monitor`, and the password `password_to_be_changed`.
@@ -167,11 +166,11 @@ Connect to the process running your Neo4j database instance:
167166
.Connecting JConsole to the Neo4j Java process
168167
image::jconsole_connect1.png[alt="Connecting with JConsole", width=300]
169168

170-
Now, beside the MBeans exposed by the JVM, you will see be default `neo4j.metrics` section in the MBeans tab.
171-
Under that, you will have access to all the monitoring information exposed by Neo4j.
169+
Besides the MBeans, exposed by the JVM, you also see be default `neo4j.metrics` section in the MBeans tab.
170+
Under that, you have access to all the monitoring information exposed by Neo4j.
172171

173172
For opening JMX to remote monitoring access, please see <<jmx-remote>> and link:https://docs.oracle.com/en/java/javase/11/management/monitoring-and-management-using-jmx-technology.html#GUID-805517EC-2D33-4D61-81D8-4D0FA770D1B8[the JMX documention^].
174173

175-
.Neo4j MBeans View
174+
.Neo4j MBeans view
176175
image::jconsole_beans1.png[alt="Neo4j MBeans view", width=600]
177176

0 commit comments

Comments
 (0)