Metrics integration process

AuraDB Virtual Dedicated Cloud AuraDS Enterprise AuraDB Business Critical

Metrics integration is a two-step process:

  • Aura CMI setup

  • Customer APM integration

Aura CMI setup

  1. Log in to Aura as project admin.

  2. Make sure there is a dedicated Aura user to use for fetching metrics. You can either:

    • Create a new user:

      1. Invite a new user, selecting Metrics Reader as a role in Project > Users.

      2. Follow the invitation link and log in to Neo4j Aura.

      3. Confirm the project membership.

    • Or you can find an existing user in Project > Users and change its role to Metrics Reader

  3. Ensure you are logged in to Aura as the user selected in the previous step. In Account > API Keys, create new Aura API credentials. Save client secret.

Capabilities of users with the role Metrics Reader are limited to fetching the metrics and getting a read-only view of the project.

Customer APM integration

  1. Optionally configure interested endpoints as described in Metrics endpoint configuration before setting up the APM system.

  2. To set up an APM system to fetch Aura metrics, use the […​] in the table view and copy either the endpoint URL or Prometheus job configuration template (if configuring Prometheus).

    cmi apm config input

  3. Use OAuth2 type of authentication specifying the Client ID and Client Secret created in the previous step. For examples using Prometheus and Datadog, see Examples.

  4. Once metrics start flowing to APM system, statuses of used endpoints can be viewed in the Metrics integration table. (See the section about Metrics endpoint configuration below for an example of the status table)

Metrics endpoint configuration

To change the metrics endpoint configuration, you need to have the Project Admin role in the project.

Aura Metrics Integration setup offers two types of metrics endpoints to endpoint Aura instance metrics:

  • Project metrics endpoint - A single endpoint with Project level endpoint configuration that allows selecting which instance metrics to include.

  • Instance metrics endpoint - Individual endpoint for each of the instances in the Project with corresponding endpoint configuration.

cmi status table

Use the Settings button for an endpoint in the table to configure that endpoint.

Selecting endpoints

Selecting an endpoint is based on individual use cases.

In general, if there is a need to monitor the performance of a specific Aura instance in your project it’s better to use the instance endpoint.

If your goal is to monitor a subset of instances in the Project and you don’t want to configure an APM system for each endpoint, then configure the Project endpoint and select the instances you are interested in. Selecting only the relevant instances helps to improve the latency of the metrics endpoint and reduces the amount of data sent to the APM system.

  • Project endpoint configuration:

    cmi project config

    1. Selecting instances to include in project endpoint - This is a project endpoint specific setting which allows users to select instances this endpoint should report metrics for.

    2. Include new instances - This setting enables scraping for newly created instance without manually updating the Project endpoint configuration.

    3. Metrics granularity - This setting allows scraping more granular metrics (Comprehensive) for the instance(s) of this endpoint. Comprehensive metric values are labeled with cloud provider availability zone and Neo4j node type (primary/secondary) for more detailed observability.

  • Instance endpoint configuration allows configuring the Metrics granularity for the corresponding instance.

    cmi instance config

Endpoint configuration changes affect the metrics endpoints only after 5 minutes of submitting these changes from UI due to Metrics integration service caching.