Node Telescope Core

This package contains the core functionality of Node Telescope, a powerful logging and monitoring library for Node.js applications.

Installation

npm install node-telescope

Usage

Here's a basic example of how to use Node Telescope with Express and MongoDB:

import express from 'express';
import http from 'http';
import { Telescope, MongoStorage, EntryType, TelescopeDatabaseType } from 'node-telescope';
import mongoose from 'mongoose';

const app = express();
const server = http.createServer(app);

mongoose.connect('mongodb://localhost/your-database');

const telescope = new Telescope({
  storage: new MongoStorage({
    connection: mongoose.connection,
    dbName: 'telescope',
  }),
  watchedEntries: [EntryType.REQUESTS, EntryType.EXCEPTIONS, EntryType.QUERIES],
  app,
  server,
  databaseType: TelescopeDatabaseType.MONGO,
  enableQueryLogging: true,
});

app.use(telescope.middleware());

// Your routes here

server.listen(3000);

Testing

For information on how to test the node-telescope package in a production-like environment, please see our Production Test Guide. Make sure to set up the required environment variables as described in the guide before running the prod-test.

API Documentation

For detailed API documentation, please refer to the API Reference.

Contributing

We welcome contributions! Please see the Contributing Guide in the root of the monorepo for more details.

License

This project is licensed under the MIT License - see the LICENSE file in the root of the monorepo for details.