Configure the Kibana endpoint

Starting with APM Server 7.3.0, we’ve introduced a new Kibana API for APM Server. Configuring this endpoint is required for APM Agent configuration in Kibana. Once the endpoint is configured, you’ll be able to fine-tune certain agent configurations directly in Kibana without having to redeploy your agents. You configure the endpoint in the apm-server.kibana section of the apm-server.yml config file.

Here’s a sample configuration:

apm-server.kibana.host: "http://localhost:5601"

Considerations

edit

If your setup uses a secret_token for Agent/Server communication, the same token is used to secure this endpoint.
It’s important to still set relevant defaults locally in each Agent’s configuration. If APM Server is unreachable, slow to respond, returns an error, etc., defaults set in the agent will apply according to their precedence.

Kibana endpoint configuration options

edit

You can specify the following options in the apm-server.kibana section of the apm-server.yml config file:

`apm-server.kibana.enabled`

edit

Defaults to false. Must be true to use APM Agent configuration.

`apm-server.kibana.host`

edit

The Kibana host that APM Server will communicate with. 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 apm-server.kibana.protocol and apm-server.kibana.path config options.

IPv6 addresses must be defined using the following format: https://[2001:db8::1]:5601.

`apm-server.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:

apm-server.kibana.host: "192.0.2.255:5601"
apm-server.kibana.protocol: "http"
apm-server.kibana.path: /kibana

`apm-server.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.

`apm-server.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.

`apm-server.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.

`apm-server.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:

apm-server.kibana.host: "https://192.0.2.255:5601"
apm-server.kibana.ssl.enabled: true
apm-server.kibana.ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]
apm-server.kibana.ssl.certificate: "/etc/pki/client/cert.pem"
apm-server.kibana.ssl.key: "/etc/pki/client/cert.key"

For information on the additional SSL configuration options, see SSL output settings.

Agent Config configuration options

edit

You can specify the following options in the apm-server.agent.config section of the apm-server.yml config file:

`agent.config.cache.expiration`

edit

When using APM Agent configuration, information fetched from Kibana will be cached in memory. This setting specifies the time before cache key expiration. Defaults to 30 seconds.

« Configure logging Set up Real User Monitoring (RUM) support »