Observa Dev

Developer-first logging SDK for Observa.

Observa Dev provides a simple interface for sending application logs to your Observa dashboard with just a few lines of code.

Features

• Simple API
• Real-time log ingestion
• Secure API Key authentication
• Async log processing
• INFO, WARN and ERROR logging
• Works with any Node.js application

Installation

npm install observa-dev

Getting Started

const Observa = require("observa-dev");

const logger = new Observa(
    "YOUR_API_KEY",
    "YOUR_OBSERVA_ENDPOINT"
);

(async () => {
    await logger.info(
        "Server started successfully",
        "backend"
    );

    await logger.warn(
        "Redis connection is slow",
        "backend"
    );

    await logger.error(
        "Database connection failed",
        "backend"
    );
})();

API

Create a client

const logger = new Observa(apiKey, endpoint);

| Parameter | Type | Description | |-----------|------|-------------| | apiKey | string | Your Observa Project API Key | | endpoint | string | Observa server URL |

Example:

const logger = new Observa(
    "obs_live_xxxxxxxxxxxxx",
    "http://localhost:3000"
);

logger.info(message, service)

Send an INFO log.

await logger.info(
    "Application started",
    "backend"
);

logger.warn(message, service)

Send a WARN log.

await logger.warn(
    "High memory usage",
    "backend"
);

logger.error(message, service)

Send an ERROR log.

await logger.error(
    "Database unavailable",
    "backend"
);

Authentication

The SDK authenticates using your Observa Project API Key.

const logger = new Observa(
    "obs_live_xxxxxxxxx",
    "https://your-observa-instance.com"
);

Requirements

• Node.js 18+
• An active Observa instance
• Valid Project API Key

Example

const Observa = require("observa-dev");

const logger = new Observa(
    process.env.OBSERVA_API_KEY,
    process.env.OBSERVA_ENDPOINT
);

(async () => {

    await logger.info("Application Started");

    await logger.warn("Redis reconnecting");

    await logger.error("Unable to connect to PostgreSQL");

})();

License

MIT

Author

Built with ❤️ by Abhyuday