Health check endpoints in Express - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a health check endpoint in an Express app?

A health check endpoint is a simple URL route that returns a quick response to show the app is running and healthy. It helps monitoring tools know the app is alive.

beginner

Why should health check endpoints return fast responses?

Fast responses ensure monitoring tools get quick feedback about the app's status without slowing down the app or causing timeouts.

beginner

Which HTTP status code is commonly used for a successful health check response?

HTTP status code 200 means OK and is commonly used to show the app is healthy.

beginner

How can you create a basic health check endpoint in Express?

Use app.get('/health', (req, res) => res.status(200).send('OK')) to create a simple route that returns 'OK' with status 200.

intermediate

What extra checks can a health check endpoint perform besides just responding?

It can check database connections, external services, or disk space to confirm the app's full health, not just if it is running.

What is the main purpose of a health check endpoint in Express?

A To confirm the app is running and healthy

B To serve the main website content

C To handle user login

D To store user data

Health check endpoints are designed to quickly confirm the app is alive and working.

Which HTTP method is typically used for health check endpoints?

A PUT

B POST

C GET

D DELETE

GET is used because health checks just request status without changing data.

What status code should a healthy Express app return on its health check endpoint?

A 200

B 500

C 404

D 302

200 means OK and signals the app is healthy.

Which of these is NOT a good practice for health check endpoints?

A Respond quickly

B Perform heavy database queries

C Return simple status messages

D Use a dedicated route like '/health'

Heavy queries slow down health checks and can cause false failures.

How can health check endpoints help in real-life app monitoring?

A By sending marketing emails

B By storing user passwords

C By updating the app automatically

D By showing if the app is down or slow

Health checks let monitoring systems detect downtime or performance issues.

Explain how to create a simple health check endpoint in Express and why it is useful.

Think about a quick way to tell if your app is alive.

Describe what additional checks a health check endpoint might perform beyond just responding with 'OK'.

Consider what else affects app health besides just running.

Practice

1. What is the main purpose of a health check endpoint in an Express app?

easy

A. To serve static files like images

B. To confirm the app is running and responsive

C. To handle user login requests

D. To connect to the database

Solution

1. Step 1: Understand what a health check endpoint does

   A health check endpoint is a simple route that tells if the app is alive and working.

2. Step 2: Compare options to this purpose

   Only To confirm the app is running and responsive matches this purpose. Other options are unrelated to health checks.

3. Final Answer:

   To confirm the app is running and responsive -> Option B

4. Quick Check:

   Health check = Confirm app running [OK]

Hint: Health check endpoints just say if app is alive [OK]

Common Mistakes:

• Thinking health check handles user data
• Confusing health check with static file serving
• Assuming it manages database connections

2. Which of the following is the correct syntax to create a simple health check GET route in Express?

easy

A. app.listen('/health', () => console.log('OK'));

B. app.post('/health', (req, res) => res.send('OK'));

C. app.get('/health', (req, res) => res.send('OK'));

D. app.use('/health', (req, res) => res.send('OK'));

Solution

1. Step 1: Identify the HTTP method for health check

   Health checks use GET requests to check status, so app.get is correct.

2. Step 2: Check syntax correctness

   app.get('/health', (req, res) => res.send('OK')); uses app.get with path '/health' and sends 'OK' response correctly.

3. Final Answer:

   app.get('/health', (req, res) => res.send('OK')); -> Option C

4. Quick Check:

   GET route with res.send('OK') = app.get('/health', (req, res) => res.send('OK')); [OK]

Hint: Health checks use GET routes with res.send('OK') [OK]

Common Mistakes:

• Using POST instead of GET
• Using app.use instead of app.get
• Trying to listen on a route path

3. What will be the output when a client sends a GET request to the following Express route?

app.get('/health', (req, res) => {
  res.status(200).send('Service is up');
});

medium

A. HTTP 200 OK with body 'Service is up'

B. HTTP 404 Not Found

C. HTTP 500 Internal Server Error

D. No response, request times out

Solution

1. Step 1: Analyze the route handler

   The route listens for GET on '/health' and sends status 200 with text 'Service is up'.

2. Step 2: Determine the HTTP response

   The client receives status 200 OK and the string 'Service is up' in the response body.

3. Final Answer:

   HTTP 200 OK with body 'Service is up' -> Option A

4. Quick Check:

   Status 200 + send text = HTTP 200 OK with body 'Service is up' [OK]

Hint: res.status(200).send('text') sends 200 OK with that text [OK]

Common Mistakes:

• Assuming 404 if route exists
• Confusing status codes
• Expecting no response or error

4. Identify the error in this health check endpoint code and choose the fix:

app.get('/health', (req, res) => {
  res.sendStatus(200);
  res.send('OK');
});

medium

A. Remove res.send('OK') because res.sendStatus ends response

B. Change res.sendStatus(200) to res.status(200)

C. Add next() call after res.sendStatus(200)

D. Change app.get to app.post

Solution

1. Step 1: Understand res.sendStatus behavior

   res.sendStatus(200) sends status and ends the response immediately.

2. Step 2: Identify why res.send('OK') causes error

   Calling res.send after response ended causes an error. So remove the second send.

3. Final Answer:

   Remove res.send('OK') because res.sendStatus ends response -> Option A

4. Quick Check:

   One response per request = Remove res.send('OK') because res.sendStatus ends response [OK]

Hint: Only send one response per request [OK]

Common Mistakes:

• Sending multiple responses in one route
• Confusing res.sendStatus and res.status
• Adding next() unnecessarily

5. You want your Express app's health check endpoint to return JSON with status and uptime in seconds. Which code correctly implements this?

hard

A. app.get('/health', (req, res) => {
res.json('status: ok, uptime: ' + process.uptime());
});

B. app.get('/health', (req, res) => {
res.send('status: ok, uptime: ' + process.uptime());
});

C. app.get('/health', (req, res) => {
res.status(200).send({ status: 'ok', uptime: process.uptime() });
});

D. app.get('/health', (req, res) => {
res.json({ status: 'ok', uptime: process.uptime() });
});

Solution

1. Step 1: Understand JSON response method

   res.json sends a JSON object with correct headers automatically.

2. Step 2: Check each option's response format

   app.get('/health', (req, res) => { res.json({ status: 'ok', uptime: process.uptime() }); }); sends a JSON object with keys 'status' and 'uptime' correctly. app.get('/health', (req, res) => { res.send('status: ok, uptime: ' + process.uptime()); }); sends a string, not JSON. app.get('/health', (req, res) => { res.status(200).send({ status: 'ok', uptime: process.uptime() }); }); sends an object with res.send but may not set JSON headers properly. app.get('/health', (req, res) => { res.json('status: ok, uptime: ' + process.uptime()); }); sends a string inside res.json, which is incorrect.

3. Final Answer:

   app.get('/health', (req, res) => { res.json({ status: 'ok', uptime: process.uptime() }); }); -> Option D

4. Quick Check:

   Use res.json with object for JSON response [OK]

Hint: Use res.json({key: value}) to send JSON response [OK]

Common Mistakes:

• Sending JSON as string instead of object
• Using res.send with object without headers
• Confusing res.json and res.send