https://github.com/stscoundrel/neo4j-apoc-exporter
Prometheus exporter for Neo4j community edition (with Apoc)
https://github.com/stscoundrel/neo4j-apoc-exporter
apoc cypher graph-database java neo4j prometheus prometheus-exporter prometheus-metrics
Last synced: 19 days ago
JSON representation
Prometheus exporter for Neo4j community edition (with Apoc)
- Host: GitHub
- URL: https://github.com/stscoundrel/neo4j-apoc-exporter
- Owner: stscoundrel
- License: mit
- Created: 2025-04-30T07:04:36.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2025-05-05T11:07:19.000Z (25 days ago)
- Last Synced: 2025-05-05T12:24:47.952Z (25 days ago)
- Topics: apoc, cypher, graph-database, java, neo4j, prometheus, prometheus-exporter, prometheus-metrics
- Language: Java
- Homepage:
- Size: 34.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Neo4j/Apoc Prometheus Exporter
[Prometheus](https://prometheus.io/) exporter for [Neo4j](https://neo4j.com/) community edition, using [Apoc plugin](https://neo4j.com/labs/apoc/5/).
## Requirements
- Neo4j installation (community and enterprise should both work)
- Apoc Extended plugin installed.
## Installation
The exporter is provided as [Docker image](https://hub.docker.com/r/stscoundrel/neo4j-apoc-exporter/tags). You can also build the Jar yourself from sources and run that, should you have a special use case.
The image accepts the following environment variables:
- `NEO4J_URI`
- `NEO4J_USER`
- `NEO4J_PASSWORD`
- `EXPORTER_PORT`
In your Docker Compose:
```
neo4j-exporter:
image: stscoundrel/neo4j-apoc-exporter:v0.1.0
ports:
- "17687:17687"
environment:
- NEO4J_URI=bolt://neo4j:7687
- NEO4J_USER=neo4j
- NEO4J_PASSWORD=password
- EXPORTER_PORT=17687
```
In your prometheus.yml:
```
- job_name: 'neo4j'
scheme: http
static_configs:
- targets: ['neo4j-exporter:17687']
```
For example on usage with image from repo & Docker compose, see `example` folder.
## Metrics
The exporter exposes (at least) the following metrics:
```
neo4j_monitor_ids_relIds
neo4j_monitor_ids_nodeIds
neo4j_monitor_ids_propIds
neo4j_monitor_ids_relTypeIds
neo4j_monitor_store_propStoreSize
neo4j_monitor_store_nodeStoreSize
neo4j_monitor_store_logSize
neo4j_monitor_store_stringStoreSize
neo4j_monitor_store_arrayStoreSize
neo4j_monitor_store_totalStoreSize
neo4j_monitor_store_relStoreSize
neo4j_monitor_tx_peakTx
neo4j_monitor_tx_rolledBackTx
neo4j_monitor_tx_currentOpenedTx
neo4j_monitor_tx_totalOpenedTx
neo4j_monitor_tx_totalTx
neo4j_monitor_tx_lastTxId
```
Is a relevant metric missing that is available in community edition? Open an issue or PR.
## Motivation.
There is no simple way of exposing Prometheus metrics in community edition. If you are using enterprise edition, you can just enable Prometheus metrics. Same does not apply to community edition.
To expose at least some of the relevant metrics, this exporter uses Apocs monitor commands.