\n\n \n $\"Docker$ \n \n\n \n $\"Docker$ \n \n\n \n $\"CircleCI\"$ \n \n\n \n $\"Go$ \n \n\n \n $\"license\"$ \n \n\n

\n\n\n# logging-operator v2\n\nLogging operator for Kubernetes based on Fluentd and Fluent-bit.\n\n\n## What is this operator for?\n\nThis operator helps you to pack together logging information with your applications. With the help of Custom Resource Definition you can describe the behaviour of your application within its charts. The operator does the rest.\n\n

\n\n### Feature highlights\n\n- Namespace isolation\n- Native Kubernetes label selectors\n- Secure communication (TLS)\n- Configuration validation\n- Multiple flow support (multiply logs for different transformations)\n- Multiple [output](docs/plugins/outputs) support (store the same logs in multiple storage: S3, GCS, ES, Loki and more...)\n- Multiple logging system support (multiple fluentd, fluent-bit deployment on the same cluster)\n\n### Motivation\n\nThe logging operator automates the deployment and configuration of a Kubernetes logging pipeline. Under the hood the operator configures a fluent-bit daemonset for collecting container logs from the node file system. Fluent-bit enriches the logs with Kubernetes metadata and transfers them to fluentd. Fluentd receives, filters and transfer logs to multiple outputs. Your logs will always be transferred on authenticated and encrypted channels.\n\n##### Blogs\n - [Logging-Operator v2](https://banzaicloud.com/blog/logging-operator-v2/)\n\n##### Blogs (general logging and operator v1)\n - [Advanced logging on Kubernetes](https://banzaicloud.com/blog/k8s-logging-advanced/)\n - [Secure logging on Kubernetes with Fluentd and Fluent Bit](https://banzaicloud.com/blog/k8s-logging-tls/)\n - [Centralized logging under Kubernetes](https://banzaicloud.com/blog/k8s-logging/)\n - [Centralized logging on Kubernetes automated](https://banzaicloud.com/blog/k8s-logging-operator/)\n - [And more...](https://banzaicloud.com/tags/logging/)\n\n\nLogging-operator is a core part of the [Pipeline](https://beta.banzaicloud.io) platform, a Cloud Native application and devops platform that natively supports multi- and hybrid-cloud deployments with multiple authentication backends. Check out the developer beta:\n

\n \n \n \n

\n\n## Architecture\n\nAvailable custom resources:\n- [logging](/docs/crds.md#loggings) - Represents a logging system. Includes `Fluentd` and `Fluent-bit` configuration. Specifies the `controlNamespace`. Fluentd and Fluent-bit will be deployed in the `controlNamespace`\n- [output](/docs/crds.md#outputs-clusteroutputs) - Defines an Output for a logging flow. This is a namespaced resource.\n- [flow](/docs/crds.md#flows-clusterflows) - Defines a logging flow with `filters` and `outputs`. You can specify `selectors` to filter logs by labels. Outputs can be `output` or `clusteroutput`. This is a namespaced resource.\n- [clusteroutput](/docs/crds.md#outputs-clusteroutputs) - Defines an output without namespace restriction. Only effective in `controlNamespace`.\n- [clusterflow](/docs/crds.md#flows-clusterflows) - Defines a logging flow without namespace restriction.\n\nThe detailed CRD documentation can be found [here](/docs/crds.md).\n\n

\n\n*connection between custom resources*\n\n---\n\n## Contents\n- Installation\n - [Deploy with Helm](./docs/deploy/README.md#deploy-logging-operator-with-helm)\n - [Deploy with Kuberenetes Manifests](./docs/deploy/README.md#deploy-logging-operator-from-kubernetes-manifests)\n- [Supported Plugins](#supported-plugins)\n- Examples\n - [S3 Output](./docs/example-s3.md)\n - [Elasticsearch Output](./docs/example-es.md)\n - [Nginx with Elasticsearch Output](./docs/example-es-nginx.md)\n - [Nginx with Loki Output](./docs/example-loki-nginx.md)\n - [Nginx with Kafka Output](./docs/example-kafka-nginx.md)\n- [Monitoring](./docs/logging-operator-monitoring.md)\n- [Troubleshooting](#troubleshooting)\n- [Contributing](#contributing)\n---\n\n\n## Supported Plugins\n\nFor complete list of supported plugins please check the [plugins index](/docs/plugins/Readme.md).\n\n| Name | Type | Description | Status | Version |\n|---------------------------------------------------------|:------:|:--------------------------------------------------------:|---------|-----------------------------------------------------------------------------------------|\n| [Alibaba](./docs/plugins/outputs/oss.md) | Output | Store logs the Alibaba Cloud Object Storage Service | GA | [0.0.1](https://github.com/aliyun/fluent-plugin-oss) |\n| [Amazon S3](./docs/plugins/outputs/s3.md) | Output | Store logs in Amazon S3 | GA | [1.1.11](https://github.com/fluent/fluent-plugin-s3/releases/tag/v1.1.11) |\n| [Azure](./docs/plugins/outputs/azurestore.md) | Output | Store logs in Azure Storega | GA | [0.1.0](https://github.com/htgc/fluent-plugin-azurestorage/releases/tag/v0.1.0) |\n| [Google Storage](./docs/plugins/outputs/gcs.md) | Output | Store logs in Google Cloud Storage | GA | [0.4.0](https://github.com/banzaicloud/fluent-plugin-gcs) |\n| [Grafana Loki](./docs/plugins/outputs/loki.md) | Output | Transfer logs to Loki | Testing | [0.2](https://github.com/banzaicloud/fluent-plugin-kubernetes-loki/releases/tag/v0.2) |\n| [ElasticSearch](./docs/plugins/outputs/elasticsearch.md) | Output | Send your logs to Elasticsearch | GA | [3.5.5](https://github.com/uken/fluent-plugin-elasticsearch/releases/tag/v3.5.5) |\n| [Sumologic](./docs/plugins/outputs/sumologic.md) | Output | Send your logs to Sumologic | GA | [1.5.0](https://github.com/SumoLogic/fluentd-output-sumologic/releases/tag/1.5.0) |\n| [Kafka](./docs/plugins/outputs/kafka.md) | Output | Send your logs to Kafka | GA | [0.12.0](https://github.com/fluent/fluent-plugin-kafka/releases/tag/v0.12.0) |\n| [Tag Normaliser](./docs/plugins/filters/tagnormaliser.md) | Parser | Normalise tags for outputs | GA | |\n| [Parser](./docs/plugins/filters/parser.md) | Parser | Parse logs with parser plugin | GA | |\n\n---\n\n## Troubleshooting\n\nIf you encounter any problems that the documentation does not address, please [file an issue](https://github.com/banzaicloud/logging-operator/issues) or talk to us on the Banzai Cloud Slack channel [#logging-operator](https://slack.banzaicloud.io/).\n\n## Contributing\n\nIf you find this project useful here's how you can help:\n\n- Send a pull request with your new features and bug fixes\n- Help new users with issues they may encounter\n- Support the development of this project and star this repo!\n\nFor more information please read the [developer documentation](./docs/developers.md)\n\n## License\n\nCopyright (c) 2017-2019 [Banzai Cloud, Inc.](https://banzaicloud.com)\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n","has_starred","hub_user","immutable_tags_settings",{"_183":11,"_184":185},"enabled","rules",[186],".*","is_automated","permissions",{"_190":21,"_191":11,"_192":11},"read","write","admin","user","storage_size",14792687611,"isOrg","reponame","tag","canDeleteTags","isHubSbxKitsEnabled","currentTab","tagAttestations","displaySecurityMetadata","showSbxLogoOverride","routes/_layout.layers.$namespace.$reponame.$tag.(images).($imageUrlDigest)._index",{"_27":28,"_143":-7,"_141":-7,"_142":-7,"_29":207,"_35":63,"_215":216,"_222":11},{"_31":32,"_33":34,"_35":36,"_37":38,"_39":40,"_41":208,"_85":86,"_87":88,"_89":90,"_91":92,"_93":94,"_95":96,"_97":80,"_98":86,"_99":59,"_100":21},[209,210,211,212,213,214],{"_44":45,"_35":46,"_47":48,"_49":50,"_51":52,"_53":54,"_55":48,"_56":-5,"_57":38,"_58":59,"_60":-5},{"_44":62,"_35":63,"_47":48,"_49":64,"_51":52,"_53":54,"_55":48,"_56":-5,"_57":65,"_58":59,"_60":-5},{"_44":67,"_35":68,"_47":48,"_49":69,"_51":70,"_53":54,"_55":48,"_56":-5,"_57":71,"_58":59,"_60":72},{"_44":74,"_35":75,"_47":48,"_49":76,"_51":70,"_53":74,"_55":48,"_56":-5,"_57":77,"_58":59,"_60":-5},{"_44":74,"_35":79,"_47":48,"_49":80,"_51":52,"_53":74,"_55":48,"_56":-5,"_57":77,"_58":59,"_60":-5},{"_44":74,"_35":82,"_47":48,"_49":83,"_51":70,"_53":74,"_55":48,"_56":-5,"_57":84,"_58":59,"_60":-5},"imageWithLayers",{"_44":62,"_35":63,"_47":48,"_49":64,"_51":52,"_104":217,"_53":54,"_55":48,"_56":-5,"_57":65,"_58":59,"_60":-5},[218,219,220,221],{"_35":123,"_57":108,"_109":110},{"_57":112,"_109":113,"_35":48},{"_35":126,"_57":127,"_109":117},{"_57":112,"_109":119,"_35":48},"hasPermissionToViewRepoSettings","actionData","errors"]

banzaicloud/logging-operator:latest