Logister Documentation Getting started
Documentation / Getting started

Set up your first Logister project.

Logister works best when you start with a clean project, generate an API token, and then choose the integration path that matches your application stack.

Guide overview

Start here if you are setting up Logister for the first time.

This page covers the product-side setup flow. Once you have a project and API token, move into the integration guide for Ruby, CFML, or JavaScript depending on what your app runs.

Getting started

Every setup begins with a project.

In Logister, a project represents one monitored app or service. Each project has its own API keys, settings, events, monitors, and integration guidance.

Core flow

How data moves into Logister.

  1. Create a project for the app you want to monitor.
  2. Generate an API key for that project.
  3. Send events to /api/v1/ingest_events or check-ins to /api/v1/check_ins.
  4. Review errors, performance data, activity, and monitors in the project pages.

Create a project

Choose the integration type that matches your app.

Integration type Best for
Ruby gem Rails and Ruby apps using logister-ruby
CFML Lucee and Adobe ColdFusion apps sending direct HTTP payloads
JavaScript / TypeScript Node, Express, and TypeScript apps using logister-js

Generate an API key

Create the token your app will use.

API keys are generated per project from project settings. The token is shown once at creation time, so copy it into your environment or secret manager right away.

Important

The token is not shown again after creation. Store it before you leave the settings page.

Choose an integration

Move into the guide that matches your app stack.

Ruby

Use the gem

Best if your app is already Ruby or Rails and you want the shortest path to native instrumentation.

Read Ruby integration docs

CFML

Send direct payloads

Best if your app runs on Lucee or Adobe ColdFusion and sends events over HTTP.

Read CFML integration docs

JavaScript

Use the npm package

Best if your app runs on Node or TypeScript and you want the logister-js client plus Express middleware.

Read JavaScript integration docs

Verify setup

Confirm that your project is ready for ingestion.

Setup checklist
Project created
Integration type selected
API key generated and copied once
Destination guide chosen
Base URL for your Logister instance confirmed

Next step

Once those items are done, move into the Ruby, CFML, or JavaScript guide and send one test event first.