Supercharged OpenSearch Tools for VS Code

For engineers building with OpenSearch; or looking for easier way to maintain OpenSearch in production.

This extension for VSCode brings a supercharged OpenSearch Dashboards DevTools-like functionality directly into your editor, along with advanced query and index mapping editing, mock-data generator, snippets, and more.

Fully supporting all modern OpenSearch versions, running anywhere (Amazon OpenSearch Service and self-managed), with smart configuration management and Cloud ID support.

🚀 What's Inside?

🛠️ OpenSearch Dashboards DevTools-like Interface

• Query and commands execution for .os.http files
• Interactive request/response panels, exactly like you had in OpenSearch Dashboards DevTools.
• Syntax highlighting and auto-completion.
• Smart configuration warnings for unconfigured connections
• Keyboard shortcuts: Ctrl+Enter to execute, Enter in path field
• Optional Tabular Data Viewer for _cat APIs and search results.
• Copy as cURL option.
• Stream files into requests in .os.http requests using < or @ operators instead of copy-pasting them.

Example usage:

POST my_index/_search
< ./queries/search-users.os.query

PUT my_index/_mapping
@ ./mappings/user-mapping.os.mapping

🔍 Advanced Query Editor

• Smart completion for *.os.query and *.os.query.json files with OpenSearch queries
• IntelliSense for queries, aggregations, and field types
• Quick actions: Wrap selections in bool clauses (filter, should, must_not)

🗺️ Index Mapping Editor

• Comprehensive mapping validation for *.os.mapping.json and *.os.json files
• Best practices recommendations and warnings
• Field type validation
• Performance impact analysis

🎲 Mock Data Generator

• Generate realistic test data from index mappings
• Support for all OpenSearch field types
• Configurable document count and data patterns
• Command Palette integration and context menu access

More Coming Soon

📦 Installation

From VS Code Marketplace

1. Open VS Code
2. Go to Extensions (Ctrl+Shift+X)
3. Search for "OpenSearch DevTools"
4. Click Install

🎯 Quick Start

1. Configure OpenSearch Connection (optional)

If you want to use DevTools, you'd need to set up a connection to a cluster. This extension supports only one connection at a time.

# Open Command Palette (Ctrl+Shift+P)
> OpenSearch: Configure Connection

The configuration dialog will open with the following options:

• Hosts: Enter one or more OpenSearch hosts with protocol (e.g., https://localhost:9200, https://os-node1:9200)
• Port: Default OpenSearch port (optional if specified in hosts)
• Username: Username for authentication (optional)
• Password: Password for authentication (optional)
• AWS Region: AWS region for Amazon OpenSearch Service (when using AWS)

Note: If no configuration is set, a warning banner will appear in .os.http files prompting you to configure your connection.

2. Create Your First Query File

DevTools-style HTTP queries (.os.http)

GET /_cluster/health

POST /my-index/_search
{
  "query": {
    "match_all": {}
  },
  "size": 10
}

OpenSearch query files (.os.query.json or .os.query)

{
  "query": {
    ...
  }
}

Index mappings (.os.mapping.json)

{
  "properties": {
    "title": {
      "type": "text",
      "analyzer": "standard"
    },
    "price": {
      "type": "scaled_float",
      "scaling_factor": 100
    }
  }
}

⌨️ Keyboard Shortcuts

🎛️ Commands

🎨 File Types & Features

.os.http - DevTools HTTP Files

• Purpose: OpenSearch Dashboards DevTools-like interface for HTTP requests
• Features:
  • HTTP method support (GET, POST, PUT, DELETE)
  • Auto-completion for OpenSearch API endpoints
  • Cluster management operations (health, stats, nodes)
  • Index operations (CRUD, mappings, settings)
  • Advanced features (ISM, snapshots, security)
• Snippets: 80+ snippets for all OS operations (os-get-health, os-put-ism-policy)
• Usage: DevTools-style queries with request/response separation

.os.query.json - OpenSearch Query Files

• Purpose: Valid JSON files for OpenSearch queries and aggregations
• Features:
  • Full IntelliSense with query and aggregation completion
  • Query validation and JSON formatting
  • Bool query wrapping shortcuts (filter, should, must_not)
  • Real-time syntax validation
• Snippets: 50+ query and aggregation snippets (os-match, os-bool, os-agg-terms)
• Usage: Pure JSON query development with execution support

.os.mapping.json - Index Mapping Files

• Purpose: Valid JSON files for OpenSearch index mappings
• Features:
  • Comprehensive mapping validation
  • Field type checking and recommendations
  • Best practices analysis
  • Mock data generation from mappings (Command Palette or right-click context menu)
• Snippets: 30+ field type and mapping snippets (os-field-text, os-mapping-complete)
• Usage: Index mapping design and validation

🎯 Use Cases

Development Workflow

1. Design mappings using .os.mapping.json files with validation
2. Generate mock data from mappings for testing
3. Develop queries using .os.query.json files with IntelliSense
4. Test APIs using .os.http files in DevTools style
5. Explore data using the tabular data viewer

Query Development

• Build complex bool queries with easy wrapping shortcuts
• Test aggregations with auto-completion
• Format and validate queries before deployment
• Export results for analysis

Data Exploration

• Browse index data in tabular format
• Search and filter documents
• Examine index mappings and settings
• Generate sample data for development

🐛 Troubleshooting

Common Issues

Connection Refused

• Verify OpenSearch is running
• Check hosts configuration in settings
• Ensure SSL certificates are valid
• Verify authentication credentials if required

Configuration Warning Banner Appears

• Open Command Palette and run "OpenSearch: Configure Connection"
• Add your OpenSearch hosts or AWS endpoint
• Ensure at least one non-default host is configured

Queries Not Executing

• Check OpenSearch configuration in settings
• Verify hosts are accessible and authentication is correct
• Check query syntax and formatting
• Verify index names exist

IntelliSense Not Working

• Ensure file has correct extension (.os.query.json, .os.http)
• Reload VS Code window
• Check extension is enabled

AWS OpenSearch Service Issues

• Verify AWS credentials are configured
• Check that IAM roles have proper permissions
• Ensure VPC/security groups allow access if applicable

Mock Data Generation Fails

• Validate mapping JSON syntax
• Check for unsupported field types
• Ensure reasonable document count (<10,000)

Debug Mode

Enable debug logging:

{
  "opensearch.debug": true
}

View logs in:

• Output Panel: "OpenSearch Query Results"
• Developer Tools: Help > Toggle Developer Tools

🔗 Links

• OpenSearch Documentation
• Amazon OpenSearch Service
• OpenSearch Documentation and Guides
• OpenSearch Support

Happy searching! 🔍✨