Skip to main content

Backend Application Setup

Instrument your backend application to send telemetry data to the Sailfish cloud platform for production observability, AI-activated debugging, and issue detection.

Auto-Installation

If you connected GitHub and received Auto-Installation PRs, the API key, service identifier, and graphql endpoint are already configured for you. Merge the PR and you're done.

Supported Languages

LanguagePackageStatus
JavaScript/TypeScript@sailfish-ai/sf-veritasFull Support
Pythonsf-veritasFull Support
Gogithub.com/SailfishAI/sf-veritas-goFull Support
Javaai.sailfish:sf-veritasFull Support
Rubysf-veritasFull Support
C#SfVeritasFull Support
PHPsailfish/sf-veritasFull Support

Choose Your Language

  • JavaScript/TypeScript - Node.js applications
  • Python - Django, FastAPI, Flask, and other Python frameworks
  • Go - net/http, Gin, Echo, Fiber, and other Go frameworks
  • Java - Spring Boot, Jakarta Servlet, JAX-RS, Micronaut, Quarkus, Vert.x, and Dropwizard
  • Ruby - Ruby on Rails, Sinatra, and other Rack-compatible frameworks
  • C# - ASP.NET Core Minimal API, MVC, and Worker Services
  • PHP - Laravel, Symfony, and standalone PHP applications

What Gets Captured

Backend instrumentation automatically captures:

  • Console Output: All console.log, console.info, console.warn, console.error calls
  • Exceptions: Unhandled exceptions with full stack traces
  • Function Traces: Execution timing and call hierarchy (for Flamechart)
  • Print Statements: Any output to stdout/stderr

Requirements

Before instrumenting your backend:

  1. Have a Sailfish Enterprise account and API key (get your key)
  2. Have Node.js 16+ for JavaScript/TypeScript projects
  3. Have Python 3.8+ for Python projects
  4. Have Go 1.22+ for Go projects
  5. Have Java 11+ (17+ recommended) for Java projects
  6. Have Ruby 2.6+ for Ruby projects
  7. Have .NET 9.0+ for C# projects
  8. Have PHP 8.1+ for PHP projects

Quick Verification

After setup, verify instrumentation is working:

  1. Deploy your application with the Sailfish SDK configured
  2. Trigger some activity that produces logs
  3. Open the Sailfish dashboard
  4. You should see telemetry appearing in your project

Local Development

Looking to set up Sailfish for local development only? See the Desktop App backend setup guide.