OpenSearch

Experimental

Creates:

AssetsLineage

Configure in the UI

This plugin can be configured directly in the Marmot UI with a step-by-step wizard.

View Guide

The OpenSearch plugin discovers indices, data streams and aliases from OpenSearch clusters.

Required Permissions

The connecting user needs cluster_monitor and indices_monitor permissions. The built-in readall role is usually sufficient.

Example Configuration

addresses:
  - "https://opensearch.company.com:9200"
username: "admin"
password: "admin"
tags:
  - "opensearch"
  - "search"

Configuration

The following configuration options are available:

Property	Type	Required	Description
addresses	[]string	false	List of OpenSearch node URLs
ca_cert_path	string	false	Path to a custom CA certificate file
external_links	[]ExternalLink	false	External links to show on all assets
filter	Filter	false	Filter discovered assets by name (regex)
include_aliases	bool	false	Discover aliases
include_data_streams	bool	false	Discover data streams
include_index_stats	bool	false	Collect document count and store size metrics
include_system_indices	bool	false	Include system indices (prefixed with .)
password	string	false	Password for basic authentication
tags	TagsConfig	false	Tags to apply to discovered assets
tls_skip_verify	bool	false	Skip TLS certificate verification
username	string	false	Username for basic authentication

Available Metadata

The following metadata fields are available:

Field	Type	Description
alias_name	string	Name of the alias
analyzer	string	Analyzer used for the field
backing_indices	int	Number of backing indices
cluster	string	Name of the OpenSearch cluster
creation_date	string	Date and time when the index was created
data_stream_name	string	Name of the data stream
docs_count	int64	Number of documents in the index
field_name	string	Full dotted path of the field
field_type	string	OpenSearch field type (keyword, text, long, etc.)
filter_defined	string	Whether a filter is defined on the alias
generation	int	Current generation of the data stream
health	string	Health status of the index (green, yellow, red)
index	string	Whether the field is indexed
index_name	string	Name of the index
indices	string	Comma-separated list of indices the alias points to
is_write_index	string	Whether the alias has a designated write index
replicas	int	Number of replica shards
shards	int	Number of primary shards
status	string	Health status of the data stream
status	string	Open/close status of the index
store_size	string	Total store size of the index
template	string	Index template used by the data stream
timestamp_field	string	Name of the timestamp field
uuid	string	UUID of the index