newrelic-experimentalnewrelic-experimental
28

Newrelic Nestjs Integration

screenshot of Newrelic Nestjs Integration

Sample dockerized NestJs framework service integration with New Relic Node.js Agent showing how to instrument the app in order to use all the Agent’s features (like Service Maps or Distributed Tracing)

Github

Overview

The New Relic NestJs Integration Example App is an innovative solution for developers looking to instrument their NestJS microservices with New Relic's APM capabilities. This example showcases two microservices, a parent and a child, seamlessly communicating within a Dockerized environment. Leveraging New Relic's powerful monitoring tools, users can visualize application performance metrics and gain deeper insights into their services.

This repository offers a straightforward setup process, requiring just a Docker installation and a New Relic account. It provides an entire architecture built around NestJS, making it a practical reference for developers wanting to improve their application's observability while experimenting with containerized microservices.

Features

  • Seamless Integration: The app includes built-in New Relic APM agents for both the parent and child microservices, ensuring easy and effective performance monitoring.

  • Dockerized Architecture: With a simple docker-compose up, you can deploy the entire microservices architecture locally or on remote servers, streamlining your development process.

  • Example Endpoints: The parent service showcases multiple RESTful endpoints to interact with, such as creating a cat and retrieving all created cats, which are invaluable for testing and validation.

  • Configured for New Relic: Readily available configuration files allow for straightforward input of your New Relic License Key and application name, simplifying the setup process.

  • Distributed Tracing: After enabling the integration, users can track requests across microservices, providing insights into the entire request lifecycle and identifying any potential bottlenecks.

  • Experimental Repository: While primarily a guide for instrumentation, the repository also serves as a sandbox for developers eager to explore the integration of NestJS and New Relic.

  • Real-Time Metrics: Users can visualize application performance in real time through the New Relic platform, enabling better decision-making and optimization.