Configuration

Configuration Properties

The Node agent can be configured with a simple object passed through at runtime.

Name	Description	Required	Example
api_key	The authentication token used to authorize the agent	true	api_key: '4ioj19393h980hiyu3jly'
name	The name of the agent, can be useful to filter to specific agents	(optional)	name: 'todo-api'
debug	Set this to true to display debug logging	(optional)	debug: true
tags	The tags for the agent, can be useful to filter to specific agents	(optional)	tags: {team: 'todo-app'}

If you're using TypeScript, you can type hint the interface by importing NerdVisionConfig. You can also see this configuration listed below:

interface NerdVisionConfig {
    api_key: string;
    name?: string; // default: my-node-app
    debug?: boolean; // default: false
    tags?: { [key: string]: string }; // default: {}
}