VictoriaMetrics, Logs & Traces
NeuBird connects to the Victoria stack through three separate connections — VictoriaMetrics for metrics, VictoriaLogs for logs, and VictoriaTraces for traces. They are configured identically, so this page covers all three. Add whichever ones you need; a deployment serving more than one signal still needs one connection per signal.
Each connection takes a URL and an Auth Token, and authenticates with HTTP Basic against a vmauth front end.
Prerequisites
Section titled “Prerequisites”A deployment fronted by vmauth, and a dedicated vmauth user for NeuBird with read access to the signals you want queried.
Create a user specifically for NeuBird rather than reusing an operator or admin login. A dedicated credential keeps NeuBird’s access to reads only, makes its queries identifiable in your access logs, and lets you revoke it without disturbing anyone else.
Step 1: Build the Auth Token
Section titled “Step 1: Build the Auth Token”The Auth Token field is not a token in the usual sense. It is the base64 encoding of username:password — the part of an HTTP Basic header that follows the word Basic. NeuBird sends it verbatim:
Authorization: Basic <your Auth Token>Generate it from your vmauth user’s credentials:
printf '%s' 'vmuser:YOUR_PASSWORD' | base64Paste the whole output as the Auth Token, without the word Basic.
Step 2: Determine the URL
Section titled “Step 2: Determine the URL”Use the URL your vmauth instance serves for that signal, including its route prefix. vmauth selects the backend by path, so the prefix is what routes the query.
| Connection | Typical URL |
|---|---|
| VictoriaMetrics | https://victoriametrics.example.com/select/0/prometheus/ |
| VictoriaLogs | https://victoriametrics.example.com/logs/ |
| VictoriaTraces | https://victoriametrics.example.com/traces/ |
Your prefixes depend on how your vmauth url_map is configured. Check that file, or confirm with whoever runs the deployment. NeuBird appends the API paths it needs to whatever you supply.
Step 3: Add the Connection in NeuBird
Section titled “Step 3: Add the Connection in NeuBird”- In NeuBird, go to Settings > Connections and click Add Connection.
- Select VictoriaMetrics, VictoriaLogs, or VictoriaTraces.
- Enter a Name and, optionally, a Description.
- Choose the authentication tab:
- Direct Access — NeuBird reaches the deployment over the network. Fill in URL and Auth Token.
- Teleport Application — the deployment is published as a Teleport application. Fill in URL and Auth Token, plus the Teleport fields below.
- Click Save.
Repeat for each signal you want to bring in.
Connection Fields
Section titled “Connection Fields”| Field | Required | Description |
|---|---|---|
| Name | Yes | A descriptive name for this connection |
| Description | No | Optional note about what this connection is for |
| URL | Yes | The vmauth URL for this signal, including its route prefix |
| Auth Token | No | Base64 of username:password. Omit only if vmauth requires no authentication |
Teleport Application fields
Section titled “Teleport Application fields”| Field | Required | Description |
|---|---|---|
| Teleport Proxy URL | Yes | The Teleport proxy server URL, e.g. teleport.example.com:443 |
| Bot Join Token | Yes | Machine ID bot token for tbot |
| Teleport App Name | Yes | Must match the Teleport application name for this service |
Troubleshooting
Section titled “Troubleshooting”| Symptom | Likely cause |
|---|---|
401 on validation | The Auth Token is not base64 of username:password, or the vmauth user cannot read that backend |
unsupported path requested | The URL points at the wrong backend for the signal. Check the route prefix against your vmauth url_map |
| Validation succeeds but no data appears | The vmauth user has access, but the backend holds no data for the queried time range |
For general instructions on creating and managing connections, see the Connections Overview.