Skip to content
This repository was archived by the owner on Apr 22, 2023. It is now read-only.

Create monitoring-node-js-overview.md #91

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions documentation/0000-template/monitoring-node-js-overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
- **Start Date:** 2018-09-12
- **PR:** (leave this empty)
- **Issue:** [#0000](link-to-issue) (remove if no associated issue)
- **Keywords:** monitoring, node.js, perofrmance, cpu, memory
- **Summary:** A high-level overview on monitoring Node.js.

# Monitoring Node.js – Overview

When you're deploying a Node.js application to production, you're likely going to want to monitor it for non-typical behavior. Whether you're monitoring CPU usage, heap usage, garbage collection, asynchronous activity, or any of the other key metrics for Node.js applications, you're going to need to implement additional monitoring tooling to actually get the information you need.

## What is contained within?

In our monitoring guides, authors will show readers how to effectively use different tooling that can enable readers to effectively monitor their applications.

### Key Terminology
There is some key terminology you'll want to know before digging into our guides.

* **CPU usage:** How much CPU is being used by your Node.js process.
* **Heap usage:** How much heap (memory) is being used by your Node.js process.
* **Garbage Collection (GC):** Automatic memory management, clearing old and unused memory.
<!-- Don't hesitate to PR more terms if you feel the need / think there are some missing! -->

If there's a term that's referenced but not defined, please don't hesitate to open a PR against this article's source to start the process of adding it (even if you don't know the exact definition!)

## What's next?
Monitoring Node.js in production is often an essential task for teams that have code that needs to be performant without issue. Monitoring tooling can help with that, but isn't always _obvious_ how to set up. Hopefully our Monitoring guides can help you get set up with effective monitoring tooling.