README.md

Deployment Guide for unreleased version

This page has instructions for collecting Kubernetes logs, metrics, and events; enriching them with deployment, pod, and service level metadata; and sending them to Sumo Logic. See our documentation guide for details on our Kubernetes Solution.

• Deployment Guide for unreleased version
  • Solution overview
    • Log Collection
    • Metrics Collection
    • Kubernetes Events Collection
  • Minimum Requirements
  • Support Matrix
    • ARM support
    • Falco support

Documentation for other versions can be found in the main README file.

---

Documentation links:

• Installation

• Configuration

  • Examples
  • Logs
    • Collecting container logs
    • Collecting Systemd logs
  • Metrics
    • Collecting Kubernetes metrics
    • Collecting application metrics
    • Switching from Prometheus to Otelcol 🆕
  • Advanced Configuration/Best Practices
  • Advanced Configuration/Security best practices
  • Authenticating with container registry
    • Using pull secrets with sumologic-kubernetes-collection helm chart
  • Collecting Kubernetes events
  • Open Telemetry
    • Open Telemetry with sumologic-kubernetes-collection
    • Comparison of Fluentd and Opentelemetry Collector functionality
    • Comparison of Fluent Bit and Opentelemetry Collector functionality
    • Traces - auto-instrumentation in Kubernetes
    • OTLP source
  • Fluentd and Fluent-Bit
    • Adding Additional Fluentd Plugins
    • Container log parsing with Fluent-Bit (Docker, CRI-O, containerd)
    • Performance estimates for running collection chart
    • Fluentd persistence

• Upgrades

  • Upgrade from v2 to v3
  • Upgrade from v2.17 to v2.18
  • Upgrade from v1.3 to v2.0
  • Upgrade from v0.17 to v1.0
  • Migrate from SumoLogic/fluentd-kubernetes-sumologic

• Troubleshooting Collection

• Monitoring the Monitoring

• Dev Releases

Solution overview

The diagrams below illustrate the components of the Kubernetes collection solution.

Log Collection

Metrics Collection

Kubernetes Events Collection

Minimum Requirements

Name	Version
K8s	1.21+
Helm	3.5+

Support Matrix

The following table displays the tested Kubernetes and Helm versions.

Name	Version
K8s with EKS	1.23 1.24 1.25 1.26 1.27
K8s with EKS (fargate)	1.24 1.25 1.26 1.27
K8s with Kops	1.23 1.24 1.25 1.26
K8s with GKE	1.24 1.25 1.26 1.27
K8s with AKS	1.25 1.26 1.27
OpenShift	4.10 4.11 4.12 4.13
Helm	3.8.2 (Linux)
kubectl	1.23.6

The following table displays the currently used software versions for our Helm chart.

Name	Version
OpenTelemetry Collector	0.99.0
OpenTelemetry Operator	0.49.0
kube-prometheus-stack/Prometheus Operator	40.5.0
Falco	3.8.7
Telegraf Operator	1.4.0
Tailing Sidecar Operator	0.12.0
Fluentd	1.16.5
Fluent Bit	2.2.0

ARM support

The collection Helm Chart supports AWS Graviton CPUs, and has been tested in ARM-based EKS clusters. In principle, it should run fine on any ARM64 node, but there is currently no official support for non-AWS ARM environments. If you do however run into problems in such an environment, don't hesitate to open an issue describing them.

Falco support

Falco is embedded in this Helm Chart for user convenience only - Sumo Logic does not provide production support for it.