Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/LENINMORENO13/OpsMind/llms.txt

Use this file to discover all available pages before exploring further.

OpsMind is an API-first microservice monitoring and observability platform built for backend engineers and platform teams who need reliable, intelligent visibility into their distributed services. It continuously pings your HTTP endpoints, records response codes and latency, evaluates availability trends, and — when something goes wrong — calls the Google Gemini AI to produce an automatic incident diagnosis complete with a probable cause and a recommended action. Whether you’re running a handful of internal services or a sprawling microservice mesh, OpsMind gives you a single, structured API to register monitors, inspect health history, and respond to degradations before they become outages.

Core Capabilities

Real-Time Health Checks

OpsMind polls every registered monitor on a recurring schedule and records the HTTP status code, response time, and derived ServiceStatus (UP, DEGRADED, DOWN, or PENDING) for each check. Results are persisted to PostgreSQL via Prisma ORM and are immediately queryable through the REST API.

Trend Analysis

Each check cycle evaluates recent log history to assign a TrendStatus to the service: STABLE, RECOVERED, DROP_DETECTED, or OFFLINE. Trend data surfaces gradual degradation patterns that a single point-in-time status check would miss.

AI Incident Diagnosis

When OpsMind detects a significant incident, it forwards the monitor’s log history to the Google Gemini API. Gemini returns a structured AIInsight containing a natural-language analysis, a technical suggestion, and a CriticalityLevel (LOW, MEDIUM, HIGH, or CRITICAL) so on-call teams know exactly where to focus.

JWT-Secured API

Every monitor management endpoint is protected by JWT authentication. Users register and log in through the /api/v1/auth routes, receive a signed token, and include it as a Bearer header on all subsequent requests — keeping your monitoring data private and access auditable.

Technology Stack

TechnologyRole
Node.jsJavaScript runtime (ES Modules, v20)
ExpressHTTP API framework (v5)
Prisma ORMType-safe database client and schema migrations
PostgreSQLPrimary relational data store
node-cronBackground scheduler for periodic health checks
jsonwebtokenJWT signing and verification for API authentication
bcryptjsPassword hashing for user credential storage
axiosHTTP client used by health-check workers to probe endpoints
zodRuntime schema validation for request payloads
Gemini API (@google/genai)Large-language-model AI for incident analysis
Docker / Docker ComposeContainerisation and local orchestration
Swagger UI / OpenAPI 3.0Live interactive API documentation

Interactive API Documentation

OpsMind ships with a fully annotated Swagger UI available at the /api-docs path of any running instance. The UI lets you explore every endpoint, inspect request/response schemas, and execute calls directly from your browser — no separate HTTP client required.
OpsMind is deployed to production at https://opsmind-e07b.onrender.com. The root path (/) automatically redirects to /api-docs, so visiting the base URL in a browser lands you straight in the interactive documentation.

Where to Go Next

Quickstart

Deploy OpsMind locally with Docker Compose, register a user, and create your first monitor in under five minutes.

Architecture

Dive into how the Express API, Prisma data layer, cron workers, and Gemini AI layer fit together.

Build docs developers (and LLMs) love