Skip to content

Environment Variables

Dave Schmid edited this page Oct 6, 2024 · 3 revisions

Required Environment Variables

These variables must be set for Sense Collector to function correctly.

Variable Description Default Notes
SENSE_COLLECTOR_API_USERNAME Sense API username (email address) None Your Sense account email
SENSE_COLLECTOR_API_PASSWORD Sense API password None Your Sense account password
SENSE_COLLECTOR_INFLUXDB_URL URL of your InfluxDB instance None Must be InfluxDB v2
SENSE_COLLECTOR_INFLUXDB_TOKEN InfluxDB authentication token None InfluxDB v2 token
SENSE_COLLECTOR_INFLUXDB_ORG InfluxDB organization name None InfluxDB v2 organization
SENSE_COLLECTOR_INFLUXDB_BUCKET InfluxDB bucket name None Data storage bucket

Optional Environment Variables

These variables are optional and can be configured to change the collector's behavior. If not set, defaults are used.

Variable Description Default Options / Notes
SENSE_COLLECTOR_LOG_LEVEL_API Log level for API calls INFO DEBUG, INFO, WARNING, ERROR
SENSE_COLLECTOR_LOG_LEVEL_STORAGE Log level for storage-related operations INFO DEBUG, INFO, WARNING, ERROR
SENSE_COLLECTOR_LOG_LEVEL_GENERAL General log level INFO DEBUG, INFO, WARNING, ERROR
SENSE_COLLECTOR_WS_HEARTBEAT_INTERVAL WebSocket heartbeat interval (in seconds) 10 Integer value
SENSE_COLLECTOR_WS_HEARTBEAT_TIMEOUT WebSocket heartbeat timeout (in seconds) 30 Integer value
SENSE_COLLECTOR_WS_RECONNECT_DELAY_INITIAL Initial reconnect delay (in seconds) 5 Integer value
SENSE_COLLECTOR_WS_RECONNECT_DELAY_CAP Maximum reconnect delay (in seconds) 60 Integer value
SENSE_COLLECTOR_WS_MAX_RETRIES Maximum WebSocket reconnection attempts 3 Integer value
SENSE_COLLECTOR_WS_BACKOFF_FACTOR Backoff factor for reconnection attempts 1 Integer value
SENSE_COLLECTOR_WS_RECONNECT_INTERVAL Interval for forceful WebSocket reconnections (in seconds) 840 Integer value
SENSE_COLLECTOR_DEVICE_CACHE_EXPIRY_SECONDS Device data cache expiry time (in seconds) 120 Integer value
SENSE_COLLECTOR_DEVICE_MAX_CONCURRENT_LOOKUPS Max concurrent device lookups 4 Integer value
SENSE_COLLECTOR_DEVICE_LOOKUP_DELAY_SECONDS Delay between device lookups (in seconds) 0.5 Float value
SENSE_COLLECTOR_API_TOKEN_RENEW Token renewal interval (in seconds) 43200 Integer value, default is 12 hours
SENSE_COLLECTOR_OUTPUT_RECEIVED_DATA Output received data to a file (true or false) false true or false
SENSE_COLLECTOR_EXPORT_FOLDER Folder for exporting received data export Path to directory

Sense Collector Wiki

Project Overview

Setup and Configuration

Collector Details and Dashboards

Clone this wiki locally