apoc.log.stream

In APOC 2025.06 this procedure was migrated to the unsupported APOC Extended library. This means that if you are using APOC 2025.06 or later, the procedure is not available in Cypher 25 but can still be used with Cypher 5. For more information, see APOC and Cypher versions.

Details
Syntax	`apoc.log.stream(path [, config ]) :: (lineNo, line, path)`
Description	Returns the file contents from the given log, optionally returning only the last n lines. This procedure requires users to have an admin role.
Input arguments	Name	Type	Description
	`path`	`STRING`	The name of the log file to read.
	`config`	`MAP`	`{ last :: INTEGER }`. The default is: `{}`.
Return arguments	Name	Type	Description
	`lineNo`	`INTEGER`	The line number.
	`line`	`STRING`	The content of the line.
	`path`	`STRING`	The path to the log file.

Usage Examples

To use the apoc.log.stream procedure the user must have the admin role, otherwise the procedure throws with an error permission has not been granted for user 'xxx', to make sure that only the Administrator can access the logs, which could provide sensitive data.

The following returns the last 10 lines in neo4j.log:

CALL apoc.log.stream("neo4j.log", {last: 10});

Results
lineNo	line	path
12827	"2020-11-16 11:12:10.197+0000 WARN The client is unauthorized due to authentication failure."	"/home/markhneedham/.local/share/neo4j-relate/dbmss/dbms-8c3607ed-fe8d-42de-9be9-075d86babcfe/logs/neo4j.log"
12826	"2020-11-16 11:12:09.967+0000 WARN The client is unauthorized due to authentication failure."	"/home/markhneedham/.local/share/neo4j-relate/dbmss/dbms-8c3607ed-fe8d-42de-9be9-075d86babcfe/logs/neo4j.log"
12825	"2020-11-16 09:43:39.332+0000 INFO Called db.clearQueryCaches(): Query cache already empty."	"/home/markhneedham/.local/share/neo4j-relate/dbmss/dbms-8c3607ed-fe8d-42de-9be9-075d86babcfe/logs/neo4j.log"
12824	"2020-11-12 16:18:44.392+0000 INFO LabelPropagationStreamProc: overall memory usage 27 KiB"	"/home/markhneedham/.local/share/neo4j-relate/dbmss/dbms-8c3607ed-fe8d-42de-9be9-075d86babcfe/logs/neo4j.log"
12823	"2020-11-12 16:18:44.391+0000 INFO [neo4j.BoltWorker-5 [bolt] [/127.0.0.1:51704] ] LabelPropagation :: Finished"	"/home/markhneedham/.local/share/neo4j-relate/dbmss/dbms-8c3607ed-fe8d-42de-9be9-075d86babcfe/logs/neo4j.log"
12822	"2020-11-12 16:18:44.391+0000 INFO [gds-3] LabelPropagation 99%"	"/home/markhneedham/.local/share/neo4j-relate/dbmss/dbms-8c3607ed-fe8d-42de-9be9-075d86babcfe/logs/neo4j.log"
12821	"2020-11-12 16:18:44.391+0000 INFO [gds-3] LabelPropagation 98%"	"/home/markhneedham/.local/share/neo4j-relate/dbmss/dbms-8c3607ed-fe8d-42de-9be9-075d86babcfe/logs/neo4j.log"
12820	"2020-11-12 16:18:44.391+0000 INFO [gds-3] LabelPropagation 97%"	"/home/markhneedham/.local/share/neo4j-relate/dbmss/dbms-8c3607ed-fe8d-42de-9be9-075d86babcfe/logs/neo4j.log"
12819	"2020-11-12 16:18:44.391+0000 INFO [gds-3] LabelPropagation 96%"	"/home/markhneedham/.local/share/neo4j-relate/dbmss/dbms-8c3607ed-fe8d-42de-9be9-075d86babcfe/logs/neo4j.log"
12818	"2020-11-12 16:18:44.391+0000 INFO [gds-3] LabelPropagation 95%"	"/home/markhneedham/.local/share/neo4j-relate/dbmss/dbms-8c3607ed-fe8d-42de-9be9-075d86babcfe/logs/neo4j.log"