Skip to content
This repository has been archived by the owner on Nov 16, 2023. It is now read-only.

microsoft/azure-nodejs-logpoints-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

52 Commits
 
 
 
 
 
 
 
 

LogPoints for Node.js on Azure

What are Logpoints?

Logpoints are dynamic log statements that you can insert into your Node.js application when running on Azure (as a web app for container environment).

Logpoints help you to at realtime print values of objects and variables you are interested in to standard out of the container. With Logpoints, we provide a mechanism for you to debug your application with minimal overhead allowing you to quickly understand and resolve issues with your application.

How does Logpoints work?

The core part of the logpoints experience is an agent that runs alongside your application within the AppServices environment. This agent is listening to commands from a logpoints client (e.g. VS Code). The client will request actions on the agent like attaching to a process, fetch scripts from application server, setting/removing logpoints on scripts running on your application server.

Logpoints Architecture

When a client requests a debug session, the agent will put your application process into debug mode for the duration of the session. After that you can download scripts, set logpoints and have them be evaluated whenever that code is executed by your application. Once your session is closed/disconnected, the agent will put your application back into non-debug mode.

Limitations

  1. LogPoints can only be set from VS Code.
  2. Currently logpoints will only work within Linux based Web Apps for Containers experience within Azure AppServices.
  3. Applications must be running on Node 8.8.1
  4. Custom Docker images for Logpoints are built on top of the existing Azure AppServices Dockerfile. Additions include changes required to configure and start the logpoints agent.
  5. The Docker images are available only on the Azure Container registry noted in the sections below.
  6. Actions done on Azure web portal (e.g. restarting app, deleting app, changing configuration, etc.) while also using the VS Code extension can put your logpoints session in a bad state. This could mean logpoints are not longer set, invalid or crash your application.
  7. Using invalid LogPoints expression can cause your app to crash. Take a look at the Logpoint expression section below for examples and recommendations when setting logpoints.
  8. Do not use logpoints with an application that contains debugger statments in it's source code. The logpoints debugger might pause your application indefinetly.

Documentation

Contributing & Feedback

Have a question or feedback?

Please send all feedback/questions to the logpoints@microsoft.com. The template after you click on the email link sometimes might not be properly formatted. Sorry for the inconvenience.

License

By using this software you agree to the license terms and privacy statement.

License for documentation:

Copyright © Microsoft Corporation
All rights reserved.
Creative Commons Attribution 4.0 License (International): https://creativecommons.org/licenses/by/4.0/legalcode

About

Instructions for setting up LogPoints on Azure

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published