WARNING: Version 6.2 of APM Server has passed its EOL date.
This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Set up the Kibana endpointedit
The Kibana dashboards are loaded into Kibana via the Kibana API. This requires a Kibana endpoint configuration.
You configure the endpoint in the setup.kibana
section of the
apm-server.yml
config file.
Here is an example configuration:
setup.kibana.host: "localhost:5601"
Configuration optionsedit
You can specify the following options in the setup.kibana
section of the
apm-server.yml
config file:
setup.kibana.host
edit
The Kibana host where the dashboards will be loaded. The default is
127.0.0.1:5601
. The value of host
can be a URL
or IP:PORT
. For example: http://192.15.3.2
, 192:15.3.2:5601
or http://192.15.3.2:6701/path
. If no
port is specified, 5601
is used.
When a node is defined as an IP:PORT
, the scheme and path are taken
from the setup.kibana.protocol and
setup.kibana.path config options.
IPv6 addresses must be defined using the following format:
https://[2001:db8::1]:5601
.
setup.kibana.protocol
edit
The name of the protocol Kibana is reachable on. The options are: http
or
https
. The default is http
. However, if you specify a URL for host, the
value of protocol
is overridden by whatever scheme you specify in the URL.
Example config:
setup.kibana.host: "192.0.2.255:5601" setup.kibana.protocol: "https" setup.kibana.path: /kibana
setup.kibana.username
edit
The basic authentication username for connecting to Kibana. If you don’t
specify a value for this setting, APM Server uses the username
specified
for the Elasticsearch output.
setup.kibana.password
edit
The basic authentication password for connecting to Kibana. If you don’t
specify a value for this setting, APM Server uses the password
specified
for the Elasticsearch output.
setup.kibana.path
edit
An HTTP path prefix that is prepended to the HTTP API calls. This is useful for the cases where Kibana listens behind an HTTP reverse proxy that exports the API under a custom prefix.
setup.kibana.ssl.enabled
edit
Enables APM Server to use SSL settings when connecting to Kibana via HTTPS.
If you configure APM Server to connect over HTTPS, this setting defaults to
true
and APM Server uses the default SSL settings.
Example configuration:
setup.kibana.host: "192.0.2.255:5601" setup.kibana.protocol: "https" setup.kibana.ssl.enabled: true setup.kibana.ssl.certificate_authorities: ["/etc/pki/root/ca.pem"] setup.kibana.ssl.certificate: "/etc/pki/client/cert.pem" setup.kibana.ssl.key: "/etc/pki/client/cert.key
See Specify SSL settings for more information.