versipellis

Versipellis Configuration Reference

[collector] Sections

type - what kind of data to retrieve / how to retrieve it

• Required
• Options (case insensitive):
  • "none"
  • "http" (HTTP/1.1 + HTTP/2)
  • "http/3"
  • "sql"

schedule - cron schedule expression

• Required
• More details here: syntax and examples

timezone - name of the effective time zone for the schedule

• Optional
• Default: "UTC"
• Options:
  • "UTC" (case insensitive)
  • "local" (case insensitive)
  • Any valid identifier from the IANA Time Zone database (case sensitive!), e.g. "America/Los_Angeles"

destination - where to send the data to

• Optional
• Default: "discard" / "none"
• Options (case insensitive):
  • "discard" / "none"
  • "stdout"

[collector.sql] Sub-Section

type - driver type of the SQL-based database to connect to

• Required
• Options (case insensitive):
  • "cockroachdb" (CockroachDB)
  • "mssql" or "sqlserver" (Microsoft SQL Server)
  • "mariadb" (MariaDB)
  • "mysql" (MySQL)
  • "odbc" (Open Database Connectivity - see additional setup instructions)
  • "oracle" (Oracle Database - see additional setup instructions)
  • "postgres" or "postgresql" (PostgreSQL)
  • "sap_hana" (SAP HANA)
  • "snowflake" (Snowflake)
  • "sqlite" (SQLite)

connection - database connection string for the SQL client

• Required
• More details here: formats and documentation links

query or query_file - SQL query to execute

• Required, but…
• Only one of them, not both (they’re mutually exclusive):
  • Inline (e.g., "SELECT * FROM table;") - usually when it’s short
  • Relative or absolute path to a file containing the query (e.g., "config/query.sql" or "/path/query.sql") - usually when it’s complex or sensitive

timeout - timeout for SQL client queries

• Optional
• Default: "1m"
• Format: string containing 1-3 numbers, each with a unit suffix: h (hours), m (minutes), and s (seconds)
• Special case: "0" and negative values (e.g., "-1s") = no client-side timeout

This site is open source. Improve this page.