Skip to main content

Core Concepts

Understand the fundamental building blocks of Hydranaut.

Services​

A service is any microservice or API you want to monitor.

Service Properties​

  • Name: Human-readable identifier
  • Health Endpoint: URL that returns service status
  • Environment: Deployment context (production, staging, etc.)
  • Team: Owning team responsible for the service
  • Dependencies: Other services this service relies on

Service Health​

Hydranaut monitors service health by:

  1. Sending HTTP request to health endpoint every 5 minutes
  2. Expecting "ok response" (typically HTTP 200)
  3. Recording response time and status
  4. Alerting on failures based on configured thresholds

Environments​

Environments organize services by deployment stage.

Common Environment Types​

  • Production: Live services serving real users
  • Staging: Pre-production testing environment
  • Development: Active development environment
  • QA: Quality assurance and testing

Environment Isolation​

Each environment:

  • Has independent monitoring configuration
  • Can have different alert thresholds
  • Maintains separate health metrics
  • Supports different team access levels

Teams​

Teams group users and control access to services and environments.

Team Roles​

  • Admin: Full access, can manage team members
  • Developer: Can add/edit services and view all metrics
  • Viewer: Read-only access to dashboards and metrics

Team Management​

  • Unlimited members across all subscription tiers
  • Teams can own multiple services
  • Services can only belong to one team
  • Teams can access multiple environments

Health Monitoring​

Monitored Metrics​

  • Status: Up/Down/Unknown
  • Response Time: Latency in milliseconds
  • Uptime: Percentage over retention period
  • Last Check: Timestamp of most recent health check

Check Frequency​

  • Default: Every 5 minutes
  • Configurable per service
  • Minimum interval: 1 minute (Professional/Teams tiers)

Dependencies​

Dependencies map relationships between services.

Dependency Types​

  • Direct: Service A directly calls Service B
  • Indirect: Service A depends on B through C

Visualization​

Hydranaut uses static analysis to visualize dependencies:

  • Parses service configurations
  • Maps declared dependencies
  • Generates dependency graph

⚠️ Note: Runtime monitoring not yet available.

Data Retention​

How long Hydranaut stores your health metrics:

TierRetention Period
Free1 day
Professional2 weeks
Teams30 days

Integrations​

Direct Integrations​

  • GitHub: Link repositories to services
  • Confluence: Connect documentation pages

Add links to any platform:

  • Deployment tools
  • Databases
  • Monitoring dashboards
  • Issue trackers

Alerting​

Hydranaut sends alerts when services fail health checks.

Alert Channels​

  • Email: Sent to team members
  • Slack: Posted to configured channels
  • Webhooks: Custom integrations

Alert Response Time​

  • Typical: < 5 minutes from failure detection
  • Configurable per service