For the full details on configuring Outputs and ClusterOutputs, see the Banzai Cloud Logging operator documentation.

Configuration

Changes in v2.5.8

The Outputs and ClusterOutputs can now be configured by filling out forms in the Rancher UI.

Outputs

The Output resource defines where your Flows can send the log messages. Outputs are the final stage for a logging Flow.

The Output is a namespaced resource, which means only a Flow within the same namespace can access it.

You can use secrets in these definitions, but they must also be in the same namespace.

For the details of Output custom resource, see OutputSpec.

The Rancher UI provides forms for configuring the following Output types:

  • Amazon ElasticSearch
  • Azure Storage
  • Cloudwatch
  • Datadog
  • Elasticsearch
  • File
  • Fluentd
  • GCS
  • Kafka
  • Kinesis Stream
  • LogDNA
  • LogZ
  • Loki
  • New Relic
  • Splunk
  • SumoLogic
  • Syslog

The Rancher UI provides forms for configuring the Output type, target, and access credentials if applicable.

For example configuration for each logging plugin supported by the logging operator, see the logging operator documentation.

ClusterOutputs

ClusterOutput defines an Output without namespace restrictions. It is only effective when deployed in the same namespace as the logging operator.

For the details of the ClusterOutput custom resource, see ClusterOutput.

Outputs

The Output resource defines where your Flows can send the log messages. Outputs are the final stage for a logging Flow.

The Output is a namespaced resource, which means only a Flow within the same namespace can access it.

You can use secrets in these definitions, but they must also be in the same namespace.

Outputs are configured in YAML. For the details of Output custom resource, see OutputSpec.

For examples of configuration for each logging plugin supported by the logging operator, see the logging operator documentation.

ClusterOutputs

ClusterOutput defines an Output without namespace restrictions. It is only effective when deployed in the same namespace as the logging operator.

The Rancher UI provides forms for configuring the ClusterOutput type, target, and access credentials if applicable.

ClusterOutputs are configured in YAML. For the details of ClusterOutput custom resource, see ClusterOutput.

For example configuration for each logging plugin supported by the logging operator, see the logging operator documentation.

YAML Examples

Once logging is installed, you can use these examples to help craft your own logging pipeline.

Cluster Output to ElasticSearch

Let’s say you wanted to send all logs in your cluster to an elasticsearch cluster. First, we create a cluster Output.

  1. apiVersion: logging.banzaicloud.io/v1beta1
  2. kind: ClusterOutput
  3. metadata:
  4.     name: "example-es"
  5.     namespace: "cattle-logging-system"
  6. spec:
  7.     elasticsearch:
  8.       host: elasticsearch.example.com
  9.       port: 9200
  10.       scheme: http

We have created this ClusterOutput, without elasticsearch configuration, in the same namespace as our operator: cattle-logging-system.. Any time we create a ClusterFlow or ClusterOutput, we have to put it in the cattle-logging-system namespace.

Now that we have configured where we want the logs to go, let’s configure all logs to go to that ClusterOutput.

  1. apiVersion: logging.banzaicloud.io/v1beta1
  2. kind: ClusterFlow
  3. metadata:
  4.     name: "all-logs"
  5.     namespace: "cattle-logging-system"
  6. spec:
  7.   globalOutputRefs:
  8.     - "example-es"

We should now see our configured index with logs in it.

Output to Splunk

What if we have an application team who only wants logs from a specific namespaces sent to a splunk server? For this case, we can use namespaced Outputs and Flows.

Before we start, let’s set up that team’s application: coolapp.

  1. apiVersion: v1
  2. kind: Namespace
  3. metadata:
  4.   name: devteam
  5. ---
  6. apiVersion: apps/v1
  7. kind: Deployment
  8. metadata:
  9.   name: coolapp
  10.   namespace: devteam
  11.   labels:
  12.     app: coolapp
  13. spec:
  14.   replicas: 2
  15.   selector:
  16.     matchLabels:
  17.       app: coolapp
  18.   template:
  19.     metadata:
  20.       labels:
  21.         app: coolapp
  22.     spec:
  23.       containers:
  24.         - name: generator
  25.           image: paynejacob/loggenerator:latest

With coolapp running, we will follow a similar path as when we created a ClusterOutput. However, unlike ClusterOutputs, we create our Output in our application’s namespace.

  1. apiVersion: logging.banzaicloud.io/v1beta1
  2. kind: Output
  3. metadata:
  4.     name: "devteam-splunk"
  5.     namespace: "devteam"
  6. spec:
  7.     SplunkHec:
  8.         host: splunk.example.com
  9.         port: 8088
  10.         protocol: http

Once again, let’s feed our Output some logs:

  1. apiVersion: logging.banzaicloud.io/v1beta1
  2. kind: Flow
  3. metadata:
  4.     name: "devteam-logs"
  5.     namespace: "devteam"
  6. spec:
  7.   localOutputRefs:
  8.     - "devteam-splunk"

Output to Syslog

Let’s say you wanted to send all logs in your cluster to an syslog server. First, we create a ClusterOutput:

  1. apiVersion: logging.banzaicloud.io/v1beta1
  2.     kind: ClusterOutput
  3.     metadata:
  4.       name: "example-syslog"
  5.       namespace: "cattle-logging-system"
  6.     spec:
  7.       syslog:
  8.         buffer:
  9.           timekey: 30s
  10.           timekey_use_utc: true
  11.           timekey_wait: 10s
  12.           flush_interval: 5s
  13.         format:
  14.           type: json
  15.           app_name_field: test
  16.         host: syslog.example.com
  17.         insecure: true
  18.         port: 514
  19.         transport: tcp

Now that we have configured where we want the logs to go, let’s configure all logs to go to that Output.

  1. apiVersion: logging.banzaicloud.io/v1beta1
  2.     kind: ClusterFlow
  3.     metadata:
  4.       name: "all-logs"
  5.       namespace: cattle-logging-system
  6.     spec:
  7.       globalOutputRefs:
  8.         - "example-syslog"

Unsupported Outputs

For the final example, we create an Output to write logs to a destination that is not supported out of the box:

Note on syslog As of Rancher v2.5.4, syslog is a supported Output. However, this example still provides an overview on using unsupported plugins.

  1. apiVersion: v1
  2. kind: Secret
  3. metadata:
  4.   name: syslog-config
  5.   namespace: cattle-logging-system
  6. type: Opaque
  7. stringData:
  8.   fluent-bit.conf: |
  9.     [INPUT]
  10.         Name              forward
  11.         Port              24224
  13.     [OUTPUT]
  14.         Name              syslog
  15.         InstanceName      syslog-output
  16.         Match             *
  17.         Addr              syslog.example.com
  18.         Port              514
  19.         Cluster           ranchers
  21. ---
  22. apiVersion: apps/v1
  23. kind: Deployment
  24. metadata:
  25.   name: fluentbit-syslog-forwarder
  26.   namespace: cattle-logging-system
  27.   labels:
  28.     output: syslog
  29. spec:
  30.   selector:
  31.     matchLabels:
  32.       output: syslog
  33.   template:
  34.     metadata:
  35.       labels:
  36.         output: syslog
  37.     spec:
  38.       containers:
  39.       - name: fluentbit
  40.         image: paynejacob/fluent-bit-out-syslog:latest
  41.         ports:
  42.           - containerPort: 24224
  43.         volumeMounts:
  44.           - mountPath: "/fluent-bit/etc/"
  45.             name: configuration
  46.       volumes:
  47.       - name: configuration
  48.         secret:
  49.           secretName: syslog-config
  50. ---
  51. apiVersion: v1
  52. kind: Service
  53. metadata:
  54.   name: syslog-forwarder
  55.   namespace: cattle-logging-system
  56. spec:
  57.   selector:
  58.     output: syslog
  59.   ports:
  60.     - protocol: TCP
  61.       port: 24224
  62.       targetPort: 24224
  63. ---
  64. apiVersion: logging.banzaicloud.io/v1beta1
  65. kind: ClusterFlow
  66. metadata:
  67.   name: all-logs
  68.   namespace: cattle-logging-system
  69. spec:
  70.   globalOutputRefs:
  71.     - syslog
  72. ---
  73. apiVersion: logging.banzaicloud.io/v1beta1
  74. kind: ClusterOutput
  75. metadata:
  76.   name: syslog
  77.   namespace: cattle-logging-system
  78. spec:
  79.   forward:
  80.     servers:
  81.       - host: "syslog-forwarder.cattle-logging-system"
  82.     require_ack_response: false
  83.     ignore_network_errors_at_startup: false

Let’s break down what is happening here. First, we create a deployment of a container that has the additional syslog plugin and accepts logs forwarded from another fluentd. Next we create an Output configured as a forwarder to our deployment. The deployment fluentd will then forward all logs to the configured syslog destination.