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 NameUnitDescription
neo4j_transaction_committed_totalTransaction CommittedNumber of transaction committed
neo4j_transaction_rollbacks_read_totalTransaction Rollbacks ReadNumber of transaction rollbacks read
neo4j_transaction_active_writeTransaction Active WriteNumber of transaction active write
neo4j_transaction_peak_concurrent_totalTransaction Peak ConcurrentNumber of transaction peak concurrent
neo4j_cypher_replan_events_totalCypher Replan EventsNumber of cypher replan events
neo4j_store_size_databaseStore Size DatabaseNumber of store size database
neo4j_pool_transaction_customers_total_usedPool Transaction Customers UsedNumber of pool transaction customers used
neo4j_pool_transaction_movies_total_usedPool Transaction Movies UsedNumber of pool transaction movies used
neo4j_transaction_committed_write_totalTransaction Committed WriteNumber of transaction committed write
neo4j_transaction_rollbacks_write_totalTransaction Rollbacks WriteNumber of transaction rollbacks write
neo4j_transaction_committed_read_totalTransaction Committed ReadNumber of transaction committed read
neo4j_ids_in_use_propertyIds In Use PropertyNumber of ids in use property
neo4j_transaction_rollbacks_totalTransaction RollbacksNumber of transaction rollbacks
neo4j_transaction_last_committed_tx_id_totalTransaction Last Committed Tx Id TotalNumber of transaction last committed tx id total
neo4j_store_size_totalStore Sizebytesstore size
neo4j_pool_transaction_system_total_usedPool Transaction System Usedpool transaction system used
neo4j_check_point_total_time_totalCheck Point Timecheck point time
neo4j_transaction_active_readTransaction Active Readtransaction active read
neo4j_ids_in_use_relationshipIds In Use RelationshipNumber of ids in use relationship
neo4j_check_point_durationCheck Point Durationmillisecondscheck point duration
neo4j_ids_in_use_nodeIds In Use NodeNumber of ids in use noden