Telemetry
Home
  • Getting Started
    • Quick Start
  • SDKs
    • Javascript
    • Python
    • Rust
    • Go
    • Dart
  • API Reference
    • Log
    • Query
    • Delete
  • Discussion Topics
    • Telemetry architecture
    • Adding Telemetry to Your Codebase
    • Creating Dashboards
    • Schema Evolution
    • Querying Nested JSON
    • Working with Timestamps
    • CamelCase vs snake_case
    • Automating Incidence Response
  • Guides
    • Tracking OpenAI Costs
    • Revenue A/B Tests
    • Monitoring Website Uptime
    • Queue Worker Observability
    • Visualizing Distributions
    • Measuring Conversion Rates
    • Analyzing Webserver Errors
    • Profiling Code Execution
Powered by GitBook
On this page
  • Install Telemetry
  • Log some data
  • Explore data with our UI
  • Query some data
  1. Getting Started

Quick Start

Let's get started with Telemetry!

NextJavascript

Last updated 8 months ago

Welcome to Telemetry! Telemetry is a logging and analytics platform designed to help you capture, store, and query your data effortlessly. Whether you're tracking application metrics, monitoring user behavior, or analyzing business performance, Telemetry provides a seamless experience with consistent APIs across multiple programming languages.

If you're interested in learning more about how Telemetry works under the hood, check out our for a detailed overview. For a more in-depth use case, such as tracking OpenAI costs by instrumenting API calls, refer to our guide on .

Install Telemetry

This tutorial uses JavaScript. For other languages, please refer to the individual SDKs. The overall API structure is consistent across different programming languages.

npm install telemetry-sh

Log some data

Telemetry automatically creates tables when data is logged. In the following example, we log some Uber ride data to a table called uber_rides. Telemetry will automatically create this table and its corresponding schema with columns: city, price, and timestamp.

import telemetry from "telemetry-sh";

telemetry.init("YOUR_API_KEY");

telemetry.log("uber_rides", {
  city: "paris",
  price: 42,
  timestamp: new Date().toISOString()
});

Explore data with our UI

Query some data

You can integrate telemetry into your product or internal dashboards by querying the data using SQL through our query API.

const results = 
  await telemetry.query(`
    SELECT
      city,
      AVG(price)
    FROM
      uber_rides
    GROUP BY
      city
  `);

You can do all sorts of different visualizations and queries in our interactive UI located at .

Telemetry Architecture Doc
Tracking OpenAI Costs
https://telemetry.sh
The telemetry.sh dashboard UI