N|Solid Documentation



N|Solid Runtime

Environment Variables

Environment Variable Description
NSOLID_COMMAND This is the route to the storage command port. It should be formatted as "host:port". You must specify at least a port, normally 9001. The default host is localhost. The host can be provided via several formats:

IPv6 [2001:cdba::3257:9652]
hostname nsolid_hub.local
default localhost:9001.
NSOLID_APPNAME This is the name of the application that the instance is running. Use this in order to create logical groupings of the processes in the Console. If omitted, the value defaults to the name field of your package.json, if one exists, and then falls back to untitled application.
NSOLID_TAGS This is the list of tags associated with your instance, which can be used to identify and filter instances in Console views. See Tags and Filters for more details.

N|Solid CLI

Configuration File

The N|Solid Command Line Interface (CLI) can be configured via a configuration file, .nsolid-clirc.

  "remote": "http://localhost:4000",
  "app": "my-node-application"

N|Solid Console

Command Line Arguments

These are the command line arguments if you're starting the console explicitly. For most usages, you would utilize npm start.

Parameter Description
--storageUrl N|Solid Storage URL (e.g., --storageUrl https://localhost:4000)
--consoleHostname N|Solid Console hostname (e.g., --consoleHostname localhost)
--consolePort=<port> Specify which TCP port to listen on (default: 3000)

Environment Variables

If you are using the developer bundle you can use the following to configure the console.

Environment Variable Description
NSOLID_CONSOLE_STORAGE_URL Same as the --storageUrl option above
NSOLID_CONSOLE_HOSTNAME Same as the --consoleHostname option above
NSOLID_CONSOLE_PORT Same as the --consolePort option above
PORT Same as the --consolePort option above
LOGLEVEL The level of logging produced; can be error, warn, info, debug; defaults to info

Stats Retention

Historical metrics, displayed in the line-chart UI elements, are trimmed to the last 15 minutes by default.

For more information about configuration options for the N|Solid Storage, see: networking

License Keys

Registering Your License Key

In order to access N|Solid you must have an enabled license key. If you have not entered your license key, when you try and access the console you will be redirected to the welcome screen. If you already have your License Key, paste it in the license key field. Otherwise click Get License Key at the bottom of the form.

Welcome Screen

Fill out all of the fields on the Register or Retrieve Key form and a license key will be sent to you via email:

Register or Retrieve Key

Once you've received your N|Solid license key, paste it into the Welcome screen form and click SUBMIT.

Once a valid key is entered, you should be immediately redirected to the N|Solid console.

Updating Your License Key

If you need to update your license key from your original demo key (or for any other reason), click on the menu in the upper-left corner next to the N|Solid logo and select License Key.

Next, paste in your updated N|Solid license. Then click SAVE CHANGES.

Your updated license key should now be active.


Debug Messages

The N|Solid Runtime and CLI all can have debug messaging enabled by using the NODE_DEBUG=nsolid environment variable.

$ NODE_DEBUG=nsolid NSOLID_COMMAND=localhost:9001 ~/ns/nsolid-node/nsolid
NSOLID 4827: starting agent (js init) name: untitled application id: 8b3f9a7db60c84c785298d81698577f2d4d7866e tags: undefined
NSOLID 4827: registering default commands
NSOLID 4827: nsolid initializing
NSOLID 4827: nsolid initialized