Telemetry

warning

🚧 Cortex.cpp is currently under development. Our documentation outlines the intended behavior of Cortex, which may not yet be fully implemented in the codebase.

Cortex collects telemetry data to enhance our product. This data provides detailed insights into your usage, including crash reports for your Cortex or Jan applications. By analyzing this information, we can identify and fix bugs, optimize performance, and improve overall stability and user experience.

info

We do not collect any sensitive or personal information.

Usage

cortex telemetry crash

Dataflow

To understand how our telemetry system operates and how data flows from your hardware into our system, please refer to the Telemetry architecture.

Telemetry Metrics

The collected telemetry metrics for Cortex are divided into two main categories:

• CrashReportResource
• CrashReportPayload

`CrashReportResource`

This category includes metrics related to the operating system and hardware details. It captures the following metrics:

Metric	Description
osName	Name of the operating system.
osVersion	Version of the operating system.
architecture	Architecture of the operating system.
appVersion	Version of Cortex.
service.name	Name of the Cortex service.
source	Source of the report (cli, cortex-server, or cortex-cpp).
cpu	Model of the CPU.
gpus	Model of the GPU, vendor, VRAM, and VRAM dynamic.

`CrashReportPayload`

This category focuses on metrics related to specific operations within Cortex. It captures the following metrics:

Metric	Description
modelId	ID of the currently used model.
endpoint	Endpoint of the Cortex Server.
command	Command executed by Cortex CLI.

Turn Off Telemetry

Linux

## 1. First Command

echo "export CORTEX_CRASH_REPORT=0" >>~/.profile

## 2. Second Command

source ~/.profile

macOS

## 1. First Command

echo "export CORTEX_CRASH_REPORT=0" >>~/.profile

## 2. Second Command

source ~/.profile

Windows

## Command Prompt

set CORTEX_CRASH_REPORT 0

## PowerShell

$env:CORTEX_CRASH_REPORT 0

## To set the env permanently

setx CORTEX_CRASH_REPORT 0

Export to Otel Collector

Linux

## 1. First Command

echo "export CORTEX_EXPORTER_OLTP_ENDPOINT=<your_OTEL_endpoint>" >>~/.profile

## 2. Second Command

source ~/.profile

macOS

## 1. First Command

echo "export CORTEX_EXPORTER_OLTP_ENDPOINT=<your_OTEL_endpoint>" >>~/.profile

## 2. Second Command

source ~/.profile

Windows

## Command Prompt

set CORTEX_EXPORTER_OLTP_ENDPOINT <your_OTEL_endpoint>

## PowerShell

$env:CORTEX_EXPORTER_OLTP_ENDPOINT <your_OTEL_endpoint>

## To set the env permanently

setx CORTEX_EXPORTER_OLTP_ENDPOINT <your_OTEL_endpoint>

info

Learn more about Telemetry:

• Telemetry CLI command.