├── .gitignore ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── create-cluster.sh ├── kubernetes ├── fluentd-configmap.yaml ├── fluentd-daemonset.yaml └── test-logger.yaml └── test-logger ├── Dockerfile ├── go.mod └── logger.go /.gitignore: -------------------------------------------------------------------------------- 1 | *.json 2 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # How to contribute 2 | 3 | We'd love to accept your patches and contributions to this project. There are a 4 | just a few small guidelines you need to follow. 5 | 6 | ## Contributor License Agreement 7 | 8 | Contributions to any Google project must be accompanied by a Contributor License 9 | Agreement. This is necessary because you own the copyright to your changes, even 10 | after your contribution becomes part of this project. So this agreement simply 11 | gives us permission to use and redistribute your contributions as part of the 12 | project. Head over to to see your current 13 | agreements on file or to sign a new one. 14 | 15 | You generally only need to submit a CLA once, so if you've already submitted one 16 | (even if it was for a different project), you probably don't need to do it 17 | again. 18 | 19 | ## Code reviews 20 | 21 | All submissions, including submissions by project members, require review. We 22 | use GitHub pull requests for this purpose. Consult [GitHub Help] for more 23 | information on using pull requests. 24 | 25 | [GitHub Help]: https://help.github.com/articles/about-pull-requests/ 26 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Customizing Fluentd for GKE Sample Code 2 | 3 | This is the sample code for customizing fluentd in Google Kubernetes Engine (GKE). The tutorial explains how to run a custom fluentd daemonset inside GKE that sends logs to Google Cloud Logging. 4 | 5 | ## Overview 6 | 7 | The repository contains: 8 | * a convenience script that creates a GKE cluster with logging disabled (create-cluster.sh) 9 | * Manifests for deploying a test logging program and the fluentd daemonset in Kubernetes 10 | * The test logging program source and Dockerfile in test-logger 11 | 12 | ## Contact Us 13 | 14 | Please use [issue tracker](https://github.com/GoogleCloudPlatform/kubernetes-engine-customize-fluentd/issues) 15 | on GitHub to report any bugs, comments or questions regarding SDK development. 16 | 17 | We welcome all usage-related questions on [Stack Overflow](http://stackoverflow.com/questions/tagged/google-customizing-fluentd-in-kubernetes-engine) 18 | tagged with `google-cloud-kubernetes-engine`. 19 | 20 | ## Instructions 21 | 1. Open this repo in Cloud Shell with the below button 22 |

23 | Open in Cloud Shell 24 |

25 | 2. Set project with the command replacing VALUE for your project 26 | 27 | ``` 28 | gcloud config set project VALUE 29 | ``` 30 | 31 | 3. Run the create-cluster.sh script to create a test cluster on GKE 32 | 33 | ``` 34 | ./create-cluster.sh 35 | ``` 36 | 37 | 4. Run the test logger, fluentd configmap, and fluentd daemonset 38 | 39 | ``` 40 | kubectl apply -f kubernetes/test-logger.yaml 41 | kubectl apply -f kubernetes/fluentd-configmap.yaml 42 | kubectl apply -f kubernetes/fluentd-daemonset.yaml 43 | ``` 44 | 45 | ## More Information 46 | 47 | * [Google Cloud Kubernetes Engine](https://cloud.google.com/kubernetes-engine/docs/) 48 | * [Kubernetes](https://kubernetes.io/) 49 | * [Fluentd](https://docs.fluentd.org/articles/quickstart) 50 | -------------------------------------------------------------------------------- /create-cluster.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # Copyright 2019 Google Inc. All Rights Reserved. 3 | # 4 | # Licensed under the Apache License, Version 2.0 (the "License"); 5 | # you may not use this file except in compliance with the License. 6 | # You may obtain a copy of the License at 7 | # 8 | # http://www.apache.org/licenses/LICENSE-2.0 9 | # 10 | # Unless required by applicable law or agreed to in writing, software 11 | # distributed under the License is distributed on an "AS IS" BASIS, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | 16 | gcloud container clusters create gke-with-custom-fluentd \ 17 | --zone us-east1-b \ 18 | --logging=SYSTEM \ 19 | --tags=gke-cluster-with-customized-fluentd \ 20 | --scopes=logging-write,storage-rw 21 | -------------------------------------------------------------------------------- /kubernetes/fluentd-configmap.yaml: -------------------------------------------------------------------------------- 1 | kind: ConfigMap 2 | apiVersion: v1 3 | metadata: 4 | #[[START configMapNameCM]] 5 | name: fluentd-gcp-config 6 | namespace: kube-system 7 | labels: 8 | k8s-app: fluentd-gcp-custom 9 | #[[END configMapNameCM]] 10 | data: 11 | containers.input.conf: |- 12 | # This configuration file for Fluentd is used 13 | # to watch changes to Docker log files that live in the 14 | # directory /var/lib/docker/containers/ and are symbolically 15 | # linked to from the /var/log/containers directory using names that capture the 16 | # pod name and container name. These logs are then submitted to 17 | # Google Cloud Logging which assumes the installation of the cloud-logging plug-in. 18 | # 19 | # Example 20 | # ======= 21 | # A line in the Docker log file might look like this JSON: 22 | # 23 | # {"log":"2014/09/25 21:15:03 Got request with path wombat\\n", 24 | # "stream":"stderr", 25 | # "time":"2014-09-25T21:15:03.499185026Z"} 26 | # 27 | # The original tag is derived from the log file's location. 28 | # For example a Docker container's logs might be in the directory: 29 | # /var/lib/docker/containers/997599971ee6366d4a5920d25b79286ad45ff37a74494f262e3bc98d909d0a7b 30 | # and in the file: 31 | # 997599971ee6366d4a5920d25b79286ad45ff37a74494f262e3bc98d909d0a7b-json.log 32 | # where 997599971ee6... is the Docker ID of the running container. 33 | # The Kubernetes kubelet makes a symbolic link to this file on the host 34 | # machine in the /var/log/containers directory which includes the pod name, 35 | # the namespace name and the Kubernetes container name: 36 | # synthetic-logger-0.25lps-pod_default_synth-lgr-997599971ee6366d4a5920d25b79286ad45ff37a74494f262e3bc98d909d0a7b.log 37 | # -> 38 | # /var/lib/docker/containers/997599971ee6366d4a5920d25b79286ad45ff37a74494f262e3bc98d909d0a7b/997599971ee6366d4a5920d25b79286ad45ff37a74494f262e3bc98d909d0a7b-json.log 39 | # The /var/log directory on the host is mapped to the /var/log directory in the container 40 | # running this instance of Fluentd and we end up collecting the file: 41 | # /var/log/containers/synthetic-logger-0.25lps-pod_default_synth-lgr-997599971ee6366d4a5920d25b79286ad45ff37a74494f262e3bc98d909d0a7b.log 42 | # This results in the tag: 43 | # var.log.containers.synthetic-logger-0.25lps-pod_default_synth-lgr-997599971ee6366d4a5920d25b79286ad45ff37a74494f262e3bc98d909d0a7b.log 44 | # where 'synthetic-logger-0.25lps-pod' is the pod name, 'default' is the 45 | # namespace name, 'synth-lgr' is the container name and '997599971ee6..' is 46 | # the container ID. 47 | # The record reformer is used to extract pod_name, namespace_name and 48 | # container_name from the tag and set them in a local_resource_id in the 49 | # format of: 50 | # 'k8s_container...'. 51 | # The reformer also changes the tags to 'stderr' or 'stdout' based on the 52 | # value of 'stream'. 53 | # local_resource_id is later used by google_cloud plugin to determine the 54 | # monitored resource to ingest logs against. 55 | 56 | # Json Log Example: 57 | # {"log":"[info:2016-02-16T16:04:05.930-08:00] Some log text here\n","stream":"stdout","time":"2016-02-17T00:04:05.931087621Z"} 58 | # CRI Log Example: 59 | # 2016-02-17T00:04:05.931087621Z stdout F [info:2016-02-16T16:04:05.930-08:00] Some log text here 60 | 61 | @type tail 62 | path /var/log/containers/*.log 63 | pos_file /var/log/gcp-containers.log.pos 64 | # Tags at this point are in the format of: 65 | # reform.var.log.containers.__-.log 66 | tag reform.* 67 | read_from_head true 68 | 69 | @type multi_format 70 | 71 | format json 72 | time_key time 73 | time_format %Y-%m-%dT%H:%M:%S.%NZ 74 | 75 | 76 | format /^(? 79 | 80 | 81 | 82 | 83 | @type parser 84 | format /^(?\w)(? 90 | 91 | # [[START scrubbingFilters]] 92 | ############################################################################################################ 93 | # ### sample log scrubbing filters 94 | # #replace social security numbers 95 | # 96 | # @type record_transformer 97 | # enable_ruby true 98 | # 99 | # log ${record["log"].gsub(/[0-9]{3}-*[0-9]{2}-*[0-9]{4}/,"xxx-xx-xxxx")} 100 | # 101 | # 102 | # # replace credit card numbers that appear in the logs 103 | # 104 | # @type record_transformer 105 | # enable_ruby true 106 | # 107 | # log ${record["log"].gsub(/[0-9]{4} *[0-9]{4} *[0-9]{4} *[0-9]{4}/,"xxxx xxxx xxxx xxxx")} 108 | # 109 | # 110 | # # replace email addresses that appear in the logs 111 | # 112 | # @type record_transformer 113 | # enable_ruby true 114 | # 115 | # log ${record["log"].gsub(/[\w+\-]+@[a-z\d\-]+(\.[a-z\d\-]+)*\.[a-z]+/i,"user@email.tld")} 116 | # 117 | # 118 | # ### end sample log scrubbing filters 119 | ############################################################################################################# 120 | # [[END scrubbingFilters]] 121 | 122 | 123 | @type record_reformer 124 | enable_ruby true 125 | 126 | # Extract local_resource_id from tag for 'k8s_container' monitored 127 | # resource. The format is: 128 | # 'k8s_container...'. 129 | "logging.googleapis.com/local_resource_id" ${"k8s_container.#{tag_suffix[4].rpartition('.')[0].split('_')[1]}.#{tag_suffix[4].rpartition('.')[0].split('_')[0]}.#{tag_suffix[4].rpartition('.')[0].split('_')[2].rpartition('-')[0]}"} 130 | # Rename the field 'log' to a more generic field 'message'. This way the 131 | # fluent-plugin-google-cloud knows to flatten the field as textPayload 132 | # instead of jsonPayload after extracting 'time', 'severity' and 133 | # 'stream' from the record. 134 | message ${record['log']} 135 | # If 'severity' is not set, assume stderr is ERROR and stdout is INFO. 136 | severity ${record['severity'] || if record['stream'] == 'stderr' then 'ERROR' else 'INFO' end} 137 | 138 | tag ${if record['stream'] == 'stderr' then 'raw.stderr' else 'raw.stdout' end} 139 | remove_keys stream,log 140 | 141 | 142 | # Detect exceptions in the log output and forward them as one log entry. 143 | 144 | @type detect_exceptions 145 | 146 | remove_tag_prefix raw 147 | message message 148 | stream "logging.googleapis.com/local_resource_id" 149 | multiline_flush_interval 5 150 | max_bytes 500000 151 | max_lines 1000 152 | 153 | monitoring.conf: |- 154 | # This source is used to acquire approximate process start timestamp, 155 | # which purpose is explained before the corresponding output plugin. 156 | 157 | @type exec 158 | command /bin/sh -c 'date +%s' 159 | tag process_start 160 | time_format %Y-%m-%d %H:%M:%S 161 | keys process_start_timestamp 162 | 163 | 164 | # This filter is used to convert process start timestamp to integer 165 | # value for correct ingestion in the prometheus output plugin. 166 | 167 | @type record_transformer 168 | enable_ruby true 169 | auto_typecast true 170 | 171 | process_start_timestamp ${record["process_start_timestamp"].to_i} 172 | 173 | 174 | system.input.conf: |- 175 | # Example: 176 | # Dec 21 23:17:22 gke-foo-1-1-4b5cbd14-node-4eoj startupscript: Finished running startup script /var/run/google.startup.script 177 | 178 | @type tail 179 | format syslog 180 | path /var/log/startupscript.log 181 | pos_file /var/log/gcp-startupscript.log.pos 182 | tag startupscript 183 | 184 | 185 | # Examples: 186 | # time="2016-02-04T06:51:03.053580605Z" level=info msg="GET /containers/json" 187 | # time="2016-02-04T07:53:57.505612354Z" level=error msg="HTTP Error" err="No such image: -f" statusCode=404 188 | # TODO(random-liu): Remove this after cri container runtime rolls out. 189 | 190 | @type tail 191 | format /^time="(?