Observability

Overview

Neurelo's Query Observability feature gives users clear visibility into the performance of their APIs. It offers detailed metrics for each API endpoint, so one can understand and track every data operation. This helps users keep an eye on performance, catch any issues, and make queries work better.

API Observability

Query observability can be enabled for an environment allowing one to track API and database query performance for different setups across dev, test, prod, etc. With this constant visibility, your endpoints always perform their best, making your data work more smoothly and securely.

The Observability feature provides insight into the performance of Neurelo APIs and the underlying database queries, meticulously recording every API call. With a customizable dashboard, users can effortlessly view hourly, daily, weekly, and monthly summaries of API activities, offering a range of features:

  1. Slowest operations

    • List of the slowest API operations with the ability to click into detailed insights for each operation, providing a comprehensive understanding of performance trends

  2. Response Codes

    • List of all API responses such as 200 (success), 400 (client error), 500 (failure) for the API invocations

  3. Total API calls

    • Total API calls is the cumulative number of API requests within a specified timeframe, providing an overview of usage and activity.

  4. API Usage

    • The API usage trend provides a snapshot of the variations in API calls over the selected time interval (hourly, daily, weekly, monthly). This feature helps track your API usage trends and understand usage patterns.

Accessing the observability dashboard for an environment

  • For a project, access the environment page by clicking the "Environments" option from the left sidebar. This will load the page with the list of environments deployed for that project.

  • Click on any specific environment and open the detailed environment page with the default view of APIs. From here, click on the Observability tab on this page. This will load the API observability details for this environment

Last updated