autobotAI
Bot Library
Pricing
Documentation
Resources
Partner Central

OpenSearch

Overview

The OpenSearch integration allows autobotAI to connect with your OpenSearch cluster for efficient searching, logging, and analytics. This integration provides seamless data retrieval and visualization capabilities to enhance observability and operational insights.

This guide provides instructions for setting up the OpenSearch integration in your autobotAI account.

Prerequisites

Before starting, ensure you have:

  1. For AWS OpenSearch Integration:

    1. An AWS Account.
    2. Access to the OpenSearch service in your AWS region.
    3. Required permissions to query and manage OpenSearch data.

  2. For On-Premises Integration:

    1. Access to an OpenSearch cluster.
    2. An OpenSearch username and password with the necessary permissions.
    3. The OpenSearch cluster URL (including the port number, if applicable).

Steps to Set Up OpenSearch Integration

Step 1:
Navigate to the Integrations page by selecting Integrations from the menu. Click the + Add Integration button in the top-right corner to view available integrations.

add integration

Step 2:
From the list, under Monitoring Tools, select OpenSearch + Add to create the OpenSearch integration.

select_opensearch

Step 3:
Fill in the required fields based on your deployment type:

AWS OpenSearch Integration

  1. Alias: Provide a meaningful name or alias for this integration.
  2. Groups: Use groups to organize multiple integrations, similar to how labels work in email systems.
  3. Integration ID: Enter the unique identifier for this integration, e.g., your active AWS integration.
  4. Region: Specify the AWS region where your OpenSearch service is hosted.
  5. Host URL: Enter the endpoint URL for your OpenSearch service.
  6. OpenSearch Deployment Type: Select "AWS OpenSearch Integration" from the dropdown.

aws_opensearch_details

On-Premises Integration

  1. Alias: Provide a meaningful name or alias for this integration.
  2. Groups: Use groups to organize multiple integrations, similar to how labels work in email systems.
  3. Host URL: Enter the URL of your OpenSearch cluster (e.g., https://opensearch-cluster.example.com:9200).
  4. Username: Enter the username for accessing the OpenSearch cluster.
  5. Password: Enter the corresponding password for the username.
  6. OpenSearch Deployment Type: Select "On-Premises Integration" from the dropdown.

onprem_opensearch_details

Double-check the information, then click Create to complete the integration.

Step 4:
After creating the integration, locate it under Integrations. Click on the three dots next to it, select Test, and ensure your integration is configured correctly with autobotAI.

Additional Information

How to Retrieve OpenSearch Cluster Details

  • Cluster URL:
    Obtain the URL from your OpenSearch dashboard or cluster setup. This usually includes the hostname and port number (e.g., https://opensearch-cluster.example.com:9200).

  • Username and Password:
    Ensure you have credentials with permissions to access and query data in your OpenSearch cluster. If you do not have these, contact your system administrator or refer to the OpenSearch documentation for creating users.

  • Connectivity Test:
    Use tools like curl or Postman to verify connectivity to your cluster before configuring the integration. Example:

    curl -u <username>:<password> -X GET "https://opensearch-cluster.example.com:9200/_cluster/health"

Once the necessary details are added, test the integration to confirm functionality and connectivity with OpenSearch.

Back
newrelic
Next
prometheus