Skip to main content

Get started with Aiven for OpenSearch®

Learn how to use Aiven for OpenSearch®, create a service, secure access, manage indices, and explore your data.

Aiven for OpenSearch® is a fully managed OpenSearch service designed for reliability, scalability, and security. It includes OpenSearch Dashboards for data visualization and supports integrations for logs and monitoring.

Prerequisites​

Ensure you have the following before getting started:

Create an Aiven for OpenSearch® service​

  1. In your project, click Services.

  2. Click Create service.

  3. Select OpenSearch®.

  4. Select a Cloud.

  5. Select a Plan.

    note

    The plans available can vary between cloud providers and regions for the same service.

  6. In the Service details, enter a name for your service.

  7. Optional: Add service tags.

  8. In the Service summary, click Create service.

The status of the service is Rebuilding during its creation. When the status is Running, you can start using the service. This typically takes a couple of minutes and can vary between cloud providers and regions.

Secure access with ACLs​

Secure your service by using one of the following options:

  • Access control lists (ACLs): Manage access to indices by setting patterns (for example, logs-*) and permissions (read, write, or all) in the Aiven Console.
  • OpenSearch security: Use OpenSearch Dashboards or APIs for fine-grained access control, including role-based access control (RBAC) and single sign-on (SSO).

For more information, see Access control in Aiven for OpenSearch®.

Manage indices​

Aiven for OpenSearch® lets you view and manage indices and configure index retention patterns. For detailed steps on creating and managing indices, see the OpenSearch documentation.

View and manage indices​

  1. Open your service in the Aiven Console.
  2. Click Indexes to view details such as shards, replicas, size, and health.

Configure retention patterns​

  1. In Indexes page, scroll to Index retention patterns
  2. Click Add pattern and define:
    • Pattern: Specify index patterns (for example, *_logs_*).
    • Maximum index count: Set the number of indices to retain.
  3. Click Create to save.

For advanced indexing features, including custom mappings, refer to the OpenSearch documentation.

Access OpenSearch Dashboards​

Use OpenSearch Dashboards to visualize and analyze your data.

  1. On the Overview page service in the Aiven Console.
  2. In the Connection information section, click the OpenSearch Dashboards tab.
  3. Copy or click the Service URI to open OpenSearch Dashboards in your browser.
  4. Log in with the credentials provided in the Connection information section.

For more information, see OpenSearch Dashboards.

Connect to your service​

  1. Go to the Overview page of your service in the Aiven Console.
  2. Click Quick connect.
  3. In the Connect window, select a dashboard or language to connect to your service.
  4. Complete the actions in the window and click Done.

Manage logs and monitor data​

Search and aggregations with Aiven for OpenSearch​

Aiven for OpenSearch® lets you write and execute search queries, as well as aggregate data using OpenSearch clients like Python and Node.js.

Write search queries​

Perform aggregations​