Getting Started with ElasticDoctor

Get up and running with your first Elasticsearch health diagnosis in under 5 minutes

Quick Start

Ready to diagnose your cluster right now? Skip the setup and try our live demo.

Try Live Demo

System Requirements

Elasticsearch Versions

  • Elasticsearch 5.x
  • Elasticsearch 6.x
  • Elasticsearch 7.x
  • Elasticsearch 8.x
  • Elasticsearch 9.x

Network Access

  • HTTP/HTTPS access to your cluster
  • Read-only permissions sufficient
  • VPN and proxy support
  • Cloud providers supported

Step-by-Step Setup

1

Access the Diagnosis Page

Navigate to the ElasticDoctor diagnosis page to start your first health check.

Go to Diagnosis Page
2

Enter Your Cluster Information

Provide your Elasticsearch cluster connection details:

Host: your-cluster.com
Port: 9200 (default)
Protocol: HTTP/HTTPS
Authentication: Optional
3

Configure Authentication (Optional)

If your cluster requires authentication, provide your credentials:

Username/Password: Basic authentication
API Key: For enhanced security
Certificate: SSL client certificates
4

Run Your First Diagnosis

Click "Run Diagnosis" to start your first health check. The analysis typically takes 2-5 seconds.

What happens next:

  • • ElasticDoctor connects to your cluster
  • • Runs comprehensive health checks
  • • Generates actionable recommendations
  • • Displays results in easy-to-understand format

Understanding Your Results

Critical Issues

Require immediate attention to prevent outages or data loss

Warnings

Should be addressed to optimize performance and reliability

Informational

General insights and recommendations for best practices

Next Steps

Learn About Health Checks

Understand all 22 health checks and how to interpret results

View Health Checks

Advanced Connection Setup

Configure authentication, SSL, and troubleshoot connections

Connection Guide

Need Help?

If you're having trouble getting started, our support team is here to help.

Contact SupportConnection Guide