Neo4j instance requirements
In order to be managed by NOM, a Neo4j instance must:
-
be running a Neo4j Enterprise Edition v4.4.0 or higher (including all 5.x versions).
Query log collection
Log manager is only compatible with Neo4j version 5+. |
For the query log collection feature to work correctly, db.logs.query.enabled
needs to be set to INFO
or VERBOSE
in the neo4j.conf file.
Also, make sure that the config value db.logs.query.threshold
is set to a reasonable value, 0
, commented out or is removed.
This setting acts as an lower bound for any completed query to appear in the logs.
Thus, if this value is set too high, the queries you want to monitor might not get logged.
Setting this value to zero will log every query.
Metrics collection
For the metrics collection feature to work correctly. these configuration values need to be set in the neo4j.conf file.:
User privileges
The agent logs on to the DBMS with the configured user to enable certain features such as viewing relationship and label types, managing privileges, and viewing configuration values. If you do not want to use the built-in admin user, a role with the minimum set of privileges required for full functionality can be created with:
CREATE ROLE `operator`;
GRANT ACCESS ON DATABASE * TO `operator`;
GRANT MATCH {*} ON GRAPH * NODE * TO `operator`;
GRANT MATCH {*} ON GRAPH * RELATIONSHIP * TO `operator`;
GRANT SHOW CONSTRAINT ON DATABASE * TO `operator`;
GRANT SHOW INDEX ON DATABASE * TO `operator`;
GRANT EXECUTE PROCEDURE * ON DBMS TO `operator`;
GRANT EXECUTE ADMIN PROCEDURES ON DBMS TO `operator`;
GRANT SHOW SERVERS ON DBMS TO `operator`;
// Required for security manager:
GRANT USER MANAGEMENT ON DBMS TO `operator`;
GRANT ROLE MANAGEMENT ON DBMS TO `operator`;
GRANT PRIVILEGE MANAGEMENT ON DBMS TO `operator`;
Was this page helpful?