Skip to main content
Version: 6.x (latest)

Settings

The Settings area of the N|Solid Console holds Console-wide configuration: the license, event and asset retention, notifications, integrations, configuration sets, and version information. This page describes each section.

To open Settings, click the gear icon (Settings) at the top right of any page. The sections are listed in the left sidebar. Some sections are shown only if your role has permission to use them.

General settings​

General Settings contains:

  • Console Url -- The URL used to link to your Console in automated notifications and alerts.
  • License Key -- The license key your Console uses. Administrators can change it. On a self-hosted Console, administrators can also click Reset License to disconnect the Console from its subscription; the data remains accessible if you reconnect later.
  • Events -- Select Disable events logging to stop recording events, and use Keep Events to set how long events are kept: One Year, Six Months, 30 Days, One Week, or One Day.
  • Asset Retention -- Set how long unsaved assets are kept with Keep Profiles and Keep Snapshots: Permanently, Six Months, 30 Days, or One Week. Saved (starred) assets are kept until you unsave them. See Assets.

Import/export settings​

Use Import/Export Settings to back up your Console settings or move them to another Console.

  • Export Settings -- Select the settings to export (Saved Views, Integrations, and Global Notifications) and click Export Settings to download a backup file.
  • Import Settings -- Click Import Settings, choose a backup file, and select the settings to import. Choose Append to add the backup to your current settings, or Clean to replace them with the backup.
note

Integrations can't be cleaned, because notifications or saved views may be using them.

Global notifications​

Global Notifications sets the notifications the Console sends when these events occur in any process:

  • Event Loop Blocked -- Triggered when a process's event loop is blocked. Set the Delay Duration in milliseconds.
  • Vulnerability Notifications -- Triggered each time a new vulnerability is found in any process. See Module Security.
  • New CPU Profile, New Heap Snapshot, New Heap Profile, New Heap Sample -- Triggered when a new asset of that type is created.
  • Process Death -- Triggered each time a process exits. Use Death Types to report All Exits, Normal Exits, or Abnormal Exits, and select Only report abnormal exits with a stacktrace to limit the notifications further.

In each section, click New Notification to choose what happens when the event occurs, such as sending a Slack or Microsoft Teams message, an email, a webhook, or a PagerDuty alert. Notifications that send messages use the integrations configured under N|Solid Integrations.

To get notified only about processes that match a filter, attach actions to a custom filter instead.

Integrations​

Click Integrations in the sidebar to expand the group. It contains three pages.

N|Solid integrations​

N|Solid Integrations configures the external services the Console can send notifications and data to:

  • Slack Webhooks (New Slack Webhook)
  • Microsoft Teams Webhooks (New Teams Webhook)
  • Generic Webhooks (New Generic Webhook)
  • PagerDuty Integration (New Pager Duty Integration)
  • AWS SQS Integration (New AWS SQS Integration) -- Receives telemetry from serverless functions. See Serverless.

On an offline (air-gapped) Console, Slack and Microsoft Teams webhooks aren't available, and notifications can't send Slack, Teams, or email messages.

For the payloads the Console sends, see Integrations.

MCP integrations​

MCP Integrations installs Model Context Protocol (MCP) servers that N|Solid Copilot uses:

  • N|Solid MCP Server -- Gives N|Solid Copilot access to your Console data and runtime capabilities. Copilot and the AI Report buttons require it. You need an N|Solid Service Token created in NodeSource Accounts; the integration's About tab lists the permissions the token needs. See Copilot prerequisites and N|Solid Console MCP Integration.
  • GitHub MCP Server -- Lets Copilot open pull requests with the code changes recommended in AI reports. You need a GitHub Personal Access Token. See MCP integrations.

Select a server to see its About tab, then click Install and enter the token. After installation, use the Configure tab to update the token.

Sourcemap resolution​

Sourcemap Resolution configures external sourcemap storage, so the Console can download sourcemaps automatically for CPU profiles that don't have one. The Console fetches sourcemaps from a URL template, authenticated with a Bearer Token (GCP, GitHub, GitLab) or S3-Compatible (AWS, GCP HMAC, MinIO) credentials. See Sourcemaps.

Configuration sets​

Configuration Sets define persistent configuration profiles that apply automatically to every agent matching a process filter, so you don't have to configure each agent individually or manage environment variables.

To create one, click + New Configuration Set and fill in:

  • Name and an optional Description.
  • Enabled -- Whether the set is active.
  • Process Filter -- The criteria agents must match, as key=value pairs (for example, nodeEnv=production). You can filter on the application name, hostname, tags, NODE_ENV, process ID, main module, CPU architecture, OS platform, application version, Node.js version, N|Solid version, and CPU model.
  • Configuration Parameters -- The settings to apply: Pause Metrics, Tracing, Tracing Modules Blacklist, Track Promises, Assets Collection, Redact Snapshots, Blocked Loop Threshold, Metrics Interval, Tags, StatsD Server, StatsD Bucket, and StatsD Tags.

Click Save Configuration Set. Use Edit and Delete to manage existing sets, and the toggle on each set to enable or disable it.

Configuration sets behave as follows:

  • Changes apply right away to connected agents whose match changes, not only to agents that connect later. Creating, editing, enabling, disabling, or deleting a set can reconfigure running agents.
  • When an agent stops matching a set, the settings owned by that set return to their defaults. If the agent matches another set, that set's values are applied instead.
  • When several enabled sets match an agent, the newest set takes precedence.
  • If some agents fail to reconfigure, a banner shows how many. Those agents may need a restart to pick up the change.

To change the configuration of connected processes once, without a persistent rule, use the Dashboard's Dynamic Configuration modal.

About​

About shows the Console Version, N|Solid Version, and Node Version, with links to the Documentation, the Api Reference for the Console API, Support, and the License terms.

NodeSource Support