Skip to content

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.

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.

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:

Terminal window
printf '%s' 'vmuser:YOUR_PASSWORD' | base64

Paste the whole output as the Auth Token, without the word Basic.

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.

ConnectionTypical URL
VictoriaMetricshttps://victoriametrics.example.com/select/0/prometheus/
VictoriaLogshttps://victoriametrics.example.com/logs/
VictoriaTraceshttps://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.

  1. In NeuBird, go to Settings > Connections and click Add Connection.
  2. Select VictoriaMetrics, VictoriaLogs, or VictoriaTraces.
  3. Enter a Name and, optionally, a Description.
  4. 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.
  5. Click Save.

Repeat for each signal you want to bring in.

FieldRequiredDescription
NameYesA descriptive name for this connection
DescriptionNoOptional note about what this connection is for
URLYesThe vmauth URL for this signal, including its route prefix
Auth TokenNoBase64 of username:password. Omit only if vmauth requires no authentication
FieldRequiredDescription
Teleport Proxy URLYesThe Teleport proxy server URL, e.g. teleport.example.com:443
Bot Join TokenYesMachine ID bot token for tbot
Teleport App NameYesMust match the Teleport application name for this service
SymptomLikely cause
401 on validationThe Auth Token is not base64 of username:password, or the vmauth user cannot read that backend
unsupported path requestedThe URL points at the wrong backend for the signal. Check the route prefix against your vmauth url_map
Validation succeeds but no data appearsThe 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.