graylog #0

Supports: xenial
Add to new model


Installs the Graylog log management system. Connections to elasticsearch and mongodb are required for a fully functioning system.


The charm installs Graylog using the snap package.
The charm must be related to elasticsearch and mongodb in order to be a fully functioning installation.
Also note Graylog doesn't support all versions of elasticsearch see the documentation for more details.


juju deploy cs:~graylog-charmers/graylog
juju run-action graylog/X show-admin-password
juju show-action-output

Graylog requires MongoDB to run and Elasticsearch to be useful.

juju deploy cs:mongodb
juju relate graylog:mongodb mongodb:database
juju deploy cs:~elasticsearch-charmers/elasticsearch
juju relate graylog:elasticsearch elasticsearch:client

You can then browse to http://ip-address:9000 and log in as admin with the password matching the hash specified, also admin in the example.

Reverseproxy Relation

Graylog supports advertising its web and api ports to an application acting as a reverseproxy using the http relation.
The port of the webUI is exposed over the relation as is the port for both the webUI and API in the all_services variable of the relation.
More details on using this are in the reverseproxy instructions for the Apache2 charm.

For example, you could use the following as a graylog vhost template for the apache2 charm:

$ cat graylog-vhost.tmpl
<Location "/">
    RequestHeader set X-Graylog-Server-URL "http://{{servername}}/api/"
    ProxyPass http://{{graylog_web}}/
    ProxyPassReverse http://{{graylog_web}}/

<Location "/api/">
    ProxyPass http://{{graylog_api}}/api/
    ProxyPassReverse http://{{graylog_api}}/api/

Now deploy and configure apache2 as your graylog reverse proxy:

juju deploy apache2
juju config apache2 "enable_modules='headers proxy_html proxy_http'"
juju config apache2 "vhost_http_template=$(base64 < graylog-vhost.tmpl)"
juju expose apache2
juju relate apache2:reverseproxy graylog

Visit http:// to access the Graylog interface.

Scale out Usage

The MongoDB and Elasticsearch applications can both be scaled to clusters and Graylog will adapt to using the cluster.
The Graylog charm does not yet support clustering of multiple units.


The administrator password is by default a random value so 'show-admin-password' action must be run for admin access to the installation.

Depending on the Elasticsearch charm used the cluster name may not be passed in the relation in which case it the elasticsearch_cluster_name config option should be set.


(int) TCP port for Beats input when relation is joined
(string) If the elastic search cluster name is not passed in the relation set it here.
(int) Number of Elasticsearch replicas used per index in this index set.
(int) Maximum number of indices to keep before deleting the oldest ones
(int) When rotation strategy is "msg_count", maximum number of documents in an index before it gets rotated
(string) When rotation strategy is "time" based, rotation period (ISO8601 Duration) - How long an index gets written to before it is rotated.
(int) When rotation strategy is "size" based, maximum size of an index before it gets rotated. Defaults to 1073741824 (1GB).
(string) Type of rotation strategy ("time" based, "size" based, no. messages "msg_count").
(int) Number of Elasticsearch shards used per index in this index set. Set this to '0' to let the charm automatically calculate based on how many Elasticsearch units.
(string) YAML-formatted list of log inputs. First input gets passed through relations. Any input not defined here will be removed unless it is prefixed with "Custom" in the title.
(string) Used by the nrpe-external-master subordinate charm. A string that will be prepended to instance name to set the host name in nagios. So for instance the hostname would be something like: juju-myservice-0 If you're running multiple environments with the same services in them this allows you to differentiate between them.
(string) A comma-separated list of nagios servicegroups. If left empty, the nagios_context will be used as the servicegroup.
(int) Number of journaled uncommitted messages that will generate a nagios CRITICAL alert
(int) Number of journaled uncommitted messages that will generate a nagios WARN
(string) HTTP/HTTPS web proxy for Snappy to use when accessing the snap store.
(string) The uri the web interface will be available at.