History

nikhiljindal 2e9e46dd08 Updating scripts to use v1 instead of v1beta3		2015-07-01 00:23:16 -07:00
..
Dockerfile	Update GPC logging sidecar to use latest gem	2015-05-19 16:42:49 -07:00
Makefile	s/gcloud preview docker/gcloud docker/	2015-06-18 12:27:08 -07:00
README.md	Update GPC logging sidecar to use latest gem	2015-05-19 16:42:49 -07:00
config_generator.sh	Make copyright ownership statement generic	2015-05-01 17:49:56 -04:00
google-fluentd.conf	Create a Docker image for use as a sidecar log collector that sends logs	2015-04-22 21:10:45 +00:00
logging-sidecar-example.yaml	Updating scripts to use v1 instead of v1beta3	2015-07-01 00:23:16 -07:00

README.md

Collecting log files from within containers with Fluentd and sending them to the Google Cloud Logging service.

Note that this only works for clusters running on GCE and whose VMs have the cloud-logging.write scope. If your cluster is logging to Elasticsearch instead, see this guide instead.

This directory contains the source files needed to make a Docker image that collects log files from arbitrary files within a container using Fluentd and sends them to GCP. The image is designed to be used as a sidecar container as part of a pod. It lives in the Google Container Registry under the name gcr.io/google_containers/fluentd-sidecar-gcp.

This shouldn't be necessary if your container writes its logs to stdout or stderr, since the Kubernetes cluster's default logging infrastructure will collect that automatically, but this is useful if your application logs to a specific file in its filesystem and can't easily be changed.

In order to make this work, you have to add a few things to your pod config:

A second container, using the gcr.io/google_containers/fluentd-sidecar-gcp:1.1 image to send the logs to Google Cloud Logging.
A volume for the two containers to share. The emptyDir volume type is a good choice for this because we only want the volume to exist for the lifetime of the pod.
Mount paths for the volume in each container. In your primary container, this should be the path that the applications log files are written to. In the secondary container, this can be just about anything, so we put it under /mnt/log to keep it out of the way of the rest of the filesystem.
The FILES_TO_COLLECT environment variable in the sidecar container, telling it which files to collect logs from. These paths should always be in the mounted volume.

To try it out, make sure that your cluster was set up to log to Google Cloud Logging when it was created (i.e. you set LOGGING_DESTINATION=gcp or are running on Container Engine), then simply run

kubectl create -f logging-sidecar-pod.yaml

You should see the logs show up in the log viewer of the Google Developer Console shortly after creating the pod. To clean up after yourself, simply run

kubectl delete -f logging-sidecar-pod.yaml