Neo4j is a graph database management system and an ACID-compliant transactional database with native graph storage and processing. Neo licenses Neo4j with these extensions under closed-source commercial terms.

Prerequisite

  1. Edit the neo4j.conf file as follows:
metrics.prometheus.enabled=true
metrics.prometheus.endpoint=localhost:2004
  1. The prometheus endpoint should be placed in the /opt/opsramp/agent/conf/app/neo4j/auto-monitoring.yaml file under the configs section.
  2. For Virtual machines, install the Linux agent.

Configuring the application

Virtual machine

Configure the application in the directory /opt/opsramp/agent/conf/app/discovery/auto-detection.yaml

- name: neo4j
  instance-checks:
    service-check:
      - neo4j
    process-check:
      - neo4j
    port-check:
      - 7474

Docker environment

Configure the application in the directory /opt/opsramp/agent/conf/app/discovery/auto-container-detection.yaml

- name: neo4j
  container-checks:
    image-check:
      - neo4j
    port-check:
      - 7474
  

Kubernetes environment

Configure the application in config.yaml

- name: neo4j
  container-checks:
    image-check:
      - neo4j
    port-check:
      - 7474
  

Validate

Go to Resources under the Infrastructure tab to check if your resources are onboarded and the metrics are collected.

Metrics

OpsRamp MetricMetric Display NameUnit
neo4j_transaction_committed_total

Number of transaction committed
Transaction Committed
neo4j_transaction_rollbacks_read_total

Number of transaction rollbacks read
Transaction Rollbacks Read
neo4j_transaction_active_write

Number of transaction active write
Transaction Active Write
neo4j_transaction_peak_concurrent_total

Number of transaction peak concurrent
Transaction Peak Concurrent
neo4j_cypher_replan_events_total

Number of cypher replan events
Cypher Replan Events
neo4j_store_size_database

Number of store size database
Store Size Database
neo4j_pool_transaction_customers_total_used

Number of pool transaction customers used
Pool Transaction Customers Used
neo4j_pool_transaction_movies_total_used

Number of pool transaction movies used
Pool Transaction Movies Used
neo4j_transaction_committed_write_total

Number of transaction committed write
Transaction Committed Write
neo4j_transaction_rollbacks_write_total

Number of transaction rollbacks write
Transaction Rollbacks Write
neo4j_transaction_committed_read_total

Number of transaction committed read
Transaction Committed Read
neo4j_ids_in_use_property

Number of ids in use property
Ids In Use Property
neo4j_transaction_rollbacks_total

Number of transaction rollbacks
Transaction Rollbacks
neo4j_transaction_last_committed_tx_id_total

Number of transaction last committed tx id total
Transaction Last Committed Tx Id Total
neo4j_store_size_total

store size
Store Sizebytes
neo4j_pool_transaction_system_total_used

pool transaction system used
Pool Transaction System Used
neo4j_check_point_total_time_total

check point time
Check Point Time
neo4j_transaction_active_read

transaction active read
Transaction Active Read
neo4j_ids_in_use_relationship

Number of ids in use relationship
Ids In Use Relationship
neo4j_check_point_duration

check point duration
Check Point Durationmilliseconds
neo4j_ids_in_use_node

Number of ids in use noden
Ids In Use Node