Skip to main content

Telemetry

WrenAI relies on anonymous usage statistics to continuously improve. That's why we would like you to share some basic usage data with us. WrenAI uses PostHog as our telemetry tool.

How Does Telemetry Help WrenAI?​

Through telemetry, we gain insights into frequently used features, community engagement, and identify steps where errors occur, hindering user experience. By sharing this information, you enable us to continuously improve WrenAI for everyone and guides our roadmap decisions.

What Information Is Shared​

In WrenAI, telemetry comprises anonymous usage statistics including:

  • Error logs (When error message occurs in console or browser)
  • Actions
    • Button or URL clicked
    • Page events (page views, page leave...)
  • Question & Answer history
    • Asked questions
    • Answers reponses (SQL statements, SQL steps & descriptions)
  • Metadata of connected data source
    • Count of connected tables
    • Table names
    • Table schemas (column names, column data type)
    • Table relationships

Each initialization or use of these components triggers an event, containing an anonymous, randomly generated user ID (UUID) and properties regarding your execution environment. These events never include identifying properties like:

  • User properties (name, email...)
  • Data source credentials or connection properties
  • IP addresses
  • OS usernames
  • File paths
  • Document contents

Here is an example "server start" event that we will collect:

{
  "uuid": "018eeb03-85db-73be-b7b6-84b2d735f19c", # the event id
  "event": "server_start", 
  "properties": {
    # the properties wrenai added
    "wren-ui-version": "telemetry",
    "wren-engine_version": null,
    "wren-ai-service-version": "0.2.1",
    "node_version": "v16.20.2",
    "node_platform": "linux",
    "node_arch": "x64",
    "memory_usage": {
      "rss": 127586304,
      "heapTotal": 78643200,
      "heapUsed": 53632840,
      "external": 4699546,
      "arrayBuffers": 89486
    },
    "cpu_usage": {
      "user": 2287663,
      "system": 1726641
    },
    "time": "2024-04-17T07:44:20.432Z",
    "$lib": "posthog-node",
    "$lib_version": "4.0.0",
    "$geoip_disable": true,
    "$sent_at": "2024-04-17T07:44:30.445000+00:00"
  },
  # some PostHog props
  "timestamp": "2024-04-17T07:44:21.060000Z",
  "team_id": 63160,
  "distinct_id": "4007a326-d606-460e-9acc-22f40cf851fb", # randomly generated userId
  "elements_chain": "",
  "created_at": "2024-04-17T07:44:31.302000Z"
}

How to Opt Out?​

You can disable telemetry with following methods:

Execute following commands in your terminal:

./wren-launcher-darwin --disable-telemetry

You will need to enter your OpenAI API Key and choose a model again, then you will see a message that shows "You have disabled telemetry, WrenAI will not collect any data.".
telemetry_optout