Skip to main content

Quick Start Guide

Get Hydranaut running in under 10 minutes by following this workflow.

Prerequisites

  • Active Hydranaut account (SaaS)
  • At least one microservice or API to monitor
  • Service health endpoint URL

Setup Workflow

Step 1: Create Your First Environment

Environments organize your services (e.g., production, staging, development).

  1. Log in to Hydranaut dashboard
  2. Navigate to EnvironmentsCreate New
  3. Enter environment name (e.g., "Production")
  4. Click Save

Step 2: Create a Team

Teams group users and control access to environments and services.

  1. Go to TeamsCreate Team
  2. Enter team name (e.g., "Backend Team")
  3. Assign environment access
  4. Click Create

Step 3: Add Your First Service

  1. Navigate to ServicesAdd Service
  2. Fill in required fields:
    • Service Name: e.g., "User API"
    • Health Endpoint: e.g., https://api.example.com/health
    • Environment: Select from dropdown
    • Team: Assign owning team
  3. Click Add Service

Step 4: Invite Team Members

  1. Go to Team SettingsMembers
  2. Click Invite Member
  3. Enter email address
  4. Assign role (Admin, Developer, Viewer)
  5. Click Send Invite

Step 5: Configure Monitoring

  1. Select your service from the Services list
  2. Click Configure Monitoring
  3. Set check interval (default: 5 minutes)
  4. Define health check criteria:
    • Expected Status Code: 200
    • Timeout: 30 seconds
  5. Click Save Configuration

Step 6: Verify Service Health

  1. Return to Services dashboard
  2. Wait 5 minutes for first health check
  3. Verify green status indicator
  4. Click service name to view detailed metrics