@parseable/backstage-plugin-logstream-backend

Parseable Logstream Backend Plugin

Backend plugin for integrating Backstage with Parseable log streams using the new backend system.

Features

• Query logs from Parseable datasets
• List available datasets
• Export logs as CSV
• Health check endpoint
• Built with the new Backstage backend system

Installation

# From your Backstage root directory
yarn --cwd packages/backend add @parseable/backstage-plugin-logstream-backend

Setup

Add the plugin to your backend in packages/backend/src/index.ts:

import { createBackend } from '@backstage/backend-defaults';

const backend = createBackend();

// Add the Parseable logstream backend plugin
backend.add(import('@parseable/backstage-plugin-logstream-backend'));

backend.start();

API Endpoints

Health Check

• GET /api/parseable-logstream/health - Health check endpoint

Datasets

• POST /api/parseable-logstream/datasets - Get available datasets
  • Body: { "baseUrl": "https://your-parseable-instance.com" }
  • Headers: Authorization: Basic <credentials>

Query Logs

• POST /api/parseable-logstream/query - Query logs from a dataset
  • Body: { "dataset": "string", "query": "string", "limit": 100 }
  • Headers:
    • Authorization: Basic <credentials>
    • x-parseable-base-url: https://your-parseable-instance.com

Export Logs

• POST /api/parseable-logstream/export/:dataset - Export logs as CSV
  • Headers:
    • Authorization: Basic <credentials>
    • x-parseable-base-url: https://your-parseable-instance.com

Development

To run the plugin locally:

yarn start

This will start a development backend with just the Parseable plugin loaded.

Configuration

The plugin uses the standard Backstage configuration system. No additional configuration is required as authentication and Parseable instance URLs are provided via API headers.