Skip to main content
Version: 0.8.x

Node.JS Interceptor

Installation

To begin the installation process, execute the following command:

npm install lunar-interceptor@1.1.x

Configuration

The only required configuration is the LUNAR_PROXY_HOST environment variable. This variable should be set to the host or IP of Lunar Proxy, including the port it is listening on.

For example:

export LUNAR_PROXY_HOST="localhost:8000"
note

This environment variable sets the host and port for Lunar Proxy. Set this to localhost:8000 if you're running Lunar Proxy in a local Docker container. The value assigned to LUNAR_PROXY_HOST should only include the hostname and port, without the HTTP prefix. For example, use localhost:8000 and not http://localhost:8000.

For more details and other configuration options, refer to our Configuration Guide

Usage

Import Lunar Interceptor into the application entry point at the beginning of the file.

require("lunar-interceptor")
# imports ...

# your code

Run Your App and Validate Proxy/Interceptor Linkage

Run your app and consume API traffic. Then, use the Discover command to validate that the requests were passed through Lunar Proxy, and that your installed interceptor is correctly listed.

kubectl exec <lunar-proxy-pod-name> -- discover
Click me for guidance 😀