////
This file is generated! See scripts/mage/docs_collector.go
////

[[metricbeat-module-appsearch]]
[role="xpack"]
== App Search module

beta[]

This is the App Search module.

[NOTE]
=====
This module does not support collecting data from App Search running on {ecloud}.
=====

[float]
=== Example configuration

The App Search module supports the standard configuration options that are described
in <<configuration-metricbeat>>. Here is an example configuration:

[source,yaml]
----
metricbeat.modules:
- module: appsearch
  metricsets: ["stats"]
  enabled: true
  period: 10s
  hosts: ["http://localhost:3002"]
  #username: "elastic"
  #password: "changeme"
----

This module supports TLS connections when using `ssl` config field, as described in <<configuration-ssl>>.
It also supports the options described in <<module-http-config-options>>.

[float]
=== Metricsets

The following metricsets are available:

* <<metricbeat-metricset-appsearch-stats,stats>>

include::appsearch/stats.asciidoc[]

