Compose Database-as-a-Service Help and Documentation

Everything you need to know about Compose, Hosted or Enterprise, is here in our help system. Whether you run one database for your businesses' sole application or six different databases to support an entire corporation, we've got the information you need.

Elasticsearch Add-ons

Overview

Our Elasticsearch deployments support the following add-ons:

Kibana

Kibana provides analytics tools and visualizations of your Elasticsearch data. As an add-on, it is installed on to a capsule within the same private network as your Elasticsearch cluster. The capsule is provisioned with 256MB of memory to start, and can be scaled to accommodate additional load. Access is provided by the existing TCP/HAProxy portals on your deployment.

More information and usage details are on the Kibana for Elasticsearch on Compose page.

Syslog-NG

Configuration instructions for the syslog-ng add-on can be found on the Syslog-NG Setup page.

Logs are forwarded continuously from all the capsules present on your deployment; so you will see database logs and haproxy logs in chronological order. For easier parsing, Compose adds a header to each log message that contains a timestamp, hostname, and process information. You can read the details of the log messages on the Compose deployment Logs page.

As a result, the raw messages that arrive at your service will vary.

Papertrail

Raw Message:
<timestamp> <hostname>: <binary[pid]>: <type info> | <Elasticsearch log>
or:
<timestamp> <hostname>: <haproxy name>: <type info> | <haproxy log>

Loggly

Raw Message:
<hostname> : [<customer [email protected]>] <binary[pid]>: <type info> | <Elasticsearch log>
or:
<hostname> : [<customer [email protected]>] <haproxy name>: <type info> | <haproxy log>

NB: In addition to just displaying the raw information from syslog-ng, Loggly also applies some parsing by default. It does not recognize the format of our logs, so you may want to implement your own parsing or derived fields to make more effective use of the logs there.

Logentries

Logentries is no longer available for new deployments or as a new add-on for existing deployments. The format is here for deployments where it is already configured.
Raw Message:
<timestamp> <hostname>: <binary[pid]>: <type info> | <Elasticsearch log>
or:
<timestamp> <hostname>: <haproxy name>: <type info> | <haproxy log>

Telegraf

Telegraf gathers statistics from the Elasticsearch Cluster API endpoints Nodes Stats, Cluster Health, and Cluster Stats. A list of the stats returned is available in the telegraf Elasticsearch plugin README.

Installing the telegraf add-on to your Compose deployment allows the statistics to be forwarded to either metrics service: Datadog or Librato.

Configuration instructions for the Telegraf add-on can be found on the Telegraf Setup page.


Still Need Help?

If this article didn't solve things, summon a human and get some help

Updated about a year ago

Elasticsearch Add-ons


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.