Skip to main content
After installing the HyperProbe extension, you need to point it at a running HyperProbe server and optionally tune a few additional settings. All configuration lives either in VS Code’s standard settings UI or inside the extension’s own Settings panel.

​
Setting the server URL

The hyperprobe.serverUrl setting tells the extension where to reach the HyperProbe backend. The default value is http://localhost:3001, which works if you are running the server locally. For production or staging, you will set this to your actual server address.

​
Via the VS Code settings UI

1

Open VS Code settings

Press Ctrl+, (Windows / Linux) or Cmd+, (macOS), or go to File → Preferences → Settings.
2

Search for HyperProbe

Type hyperprobe in the search bar. The HyperProbe: Server Url field appears.
3

Enter your server URL

Replace the default value with the URL of your HyperProbe server, for example https://app.hyperprobe.com.
The extension performs a health check against the new URL as soon as you save the setting. A notification in the bottom-right corner confirms whether the connection succeeded.

​
Via settings.json

If you prefer to configure settings directly in JSON, add the following to your settings.json:
settings.json
{
  "hyperprobe.serverUrl": "https://app.hyperprobe.com"
}
Commit a workspace-level .vscode/settings.json file to share the server URL with your whole team. Each developer still overrides it in their user settings if they need a different target (for example, a local dev server).

​
Extension settings panel

The HyperProbe panel also includes a Settings screen accessible from within the extension’s webview. Open the HyperProbe panel in the Activity Bar, then click the settings icon to reach these options:

​
Server URL

The same URL field described above, surfaced inside the extension UI for convenience. Changes here update the underlying VS Code setting and trigger an immediate health check.

​
Certificate pinning list

If your HyperProbe server uses a self-signed or privately-issued TLS certificate, you need to add the certificate’s fingerprint to the pinning list so the extension trusts the connection. To add a certificate:
  1. Obtain the SHA-256 fingerprint of your server certificate (for example: ee80811b38e7e6c2...).
  2. Enter the fingerprint in the Certificate Pinning List text field.
  3. Click Add Item.
You can add multiple fingerprints. This setting applies globally across all connection profiles.
Pinning an incorrect fingerprint prevents the extension from connecting to the server. Double-check the fingerprint before saving, especially after rotating certificates.

​
Send source full path

When this checkbox is enabled, the extension sends the absolute file path of the source file when creating a probe, rather than a workspace-relative path. Enable this setting if your HyperProbe server is configured to match probes using full paths. Leave it disabled (the default) unless your server administrator instructs otherwise.

​
The .hprc file

The .hprc file ties a workspace folder to a HyperProbe service ID. Place one at the root of each service you want to instrument:
.hprc
{
  "serviceId": "my-service"
}
FieldTypeRequiredDescription
serviceIdstringYesThe identifier of the service registered with the HyperProbe backend. Must match the ID used when calling HyperProbe.start() in your SDK.
The extension watches for .hprc files across the entire workspace. If you add, edit, or delete a .hprc file, the extension picks up the change immediately without requiring a reload.

​
Connecting to the server

Run the HyperProbe: Connect command from the Command Palette (Ctrl+Shift+P / Cmd+Shift+P) to establish a session with the configured server. Once connected, the extension streams live probe data and updates probe status in real time.
The HyperProbe: Connect command uses the URL set in hyperprobe.serverUrl. Make sure that setting is correct before running the command.