1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
|
//go:build !nokubernetes
// +build !nokubernetes
package logsource
import (
"bufio"
"context"
"fmt"
"io"
"log/slog"
"os"
"slices"
"sync"
"time"
"github.com/prometheus/client_golang/prometheus"
"gopkg.in/alecthomas/kingpin.v2"
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/labels"
"k8s.io/client-go/kubernetes"
"k8s.io/client-go/rest"
"k8s.io/client-go/tools/clientcmd"
"k8s.io/utils/ptr"
)
// A KubernetesLogSource can read lines from Kubernetes pod logs.
type KubernetesLogSource struct {
LogSourceDefaults
clientset *kubernetes.Clientset
logStream containerLogStream
namespace string
serviceName string
podName string
containerName string
}
// containerLogStream represents a log stream from a specific container.
type containerLogStream struct {
stream io.ReadCloser
scanner *bufio.Scanner
}
// NewKubernetesLogSource creates a new log source that reads from Kubernetes pod logs.
func NewKubernetesLogSource(ctx context.Context, namespace, serviceName, containerName string, pod corev1.Pod, clientset *kubernetes.Clientset) []*KubernetesLogSource {
containers := pod.Spec.Containers
if containerName != "" {
for _, container := range pod.Spec.Containers {
if container.Name == containerName {
containers = []corev1.Container{container}
break
}
}
}
var logSources []*KubernetesLogSource
for _, container := range containers {
logSource := createKubernetesLogSource(ctx, namespace, serviceName, container.Name, pod, clientset)
logSources = append(logSources, logSource)
}
return logSources
}
func createKubernetesLogSource(ctx context.Context, namespace, serviceName, containerName string, pod corev1.Pod, clientset *kubernetes.Clientset) *KubernetesLogSource {
cls, err := getContainerLogStream(ctx, namespace, pod.Name, containerName, clientset)
// Even if we fail to get the log stream now, we can retry later in Read().
if err != nil {
slog.Error("Failed to get log stream for pod container", "pod", pod.Name, "container", containerName, "error", err)
}
return &KubernetesLogSource{
clientset: clientset,
namespace: namespace,
logStream: cls,
podName: pod.Name,
containerName: containerName,
serviceName: serviceName,
}
}
func getContainerLogStream(ctx context.Context, namespace, podName, containerName string, clientset *kubernetes.Clientset) (containerLogStream, error) {
logOptions := &corev1.PodLogOptions{
Follow: true,
TailLines: ptr.To(int64(10)), // Start with last 10 lines
Container: containerName,
}
// Wait for the pod to start
for {
pod, err := clientset.CoreV1().Pods(namespace).Get(ctx, podName, metav1.GetOptions{})
if err != nil {
continue
}
if pod.Status.Phase == corev1.PodRunning {
break
}
slog.Info("Waiting for pod to be running", "pod", podName, "phase", pod.Status.Phase)
time.Sleep(5 * time.Second)
}
// Create log stream
req := clientset.CoreV1().Pods(namespace).GetLogs(podName, logOptions)
logStream, err := req.Stream(ctx)
if err != nil {
return containerLogStream{}, fmt.Errorf("failed to create log stream for pod %s container %s: %v", podName, containerName, err)
}
slog.Info("Started log stream for pod container", "pod", podName, "container", containerName)
return containerLogStream{
stream: logStream,
scanner: bufio.NewScanner(logStream),
}, nil
}
func createClientset(kubeconfigPath string) (*kubernetes.Clientset, bool, error) {
var config *rest.Config
var err error
var inCluster bool
// Try in-cluster config first (when running inside Kubernetes)
config, err = rest.InClusterConfig()
if err != nil {
inCluster = false
// If in-cluster config fails, try to use local kubeconfig for development
slog.Debug("Failed to get in-cluster config, trying local kubeconfig", "error", err)
// Use provided kubeconfig path or default location
config, err = clientcmd.BuildConfigFromFlags("", kubeconfigPath)
if err != nil {
return nil, inCluster, fmt.Errorf("failed to create kubernetes config from kubeconfig: %v", err)
}
} else {
inCluster = true
}
// Create the clientset
clientset, err := kubernetes.NewForConfig(config)
if err != nil {
return nil, inCluster, fmt.Errorf("failed to create kubernetes client: %v", err)
}
return clientset, inCluster, nil
}
func determineNamespace(ns string, inCluster bool) string {
if ns != "" {
return ns
}
// Default to "default" namespace if none specified.
ns = "default"
if !inCluster {
return ns
}
// When running in-cluster, try to read the current namespace.
if namespaceBytes, err := os.ReadFile("/var/run/secrets/kubernetes.io/serviceaccount/namespace"); err == nil {
ns = string(namespaceBytes)
}
return ns
}
func getLogTargets(ctx context.Context, clientset *kubernetes.Clientset, namespace, serviceName, podName string) ([]corev1.Pod, error) {
var pods []corev1.Pod
var err error
if podName != "" {
pods, err = getLogTargetsFromPodName(ctx, clientset, namespace, podName)
} else if serviceName != "" {
pods, err = getLogTargetsFromService(ctx, clientset, namespace, serviceName)
}
if err != nil {
return nil, err
}
if len(pods) == 0 {
return nil, fmt.Errorf("no pods found")
}
return pods, nil
}
func getLogTargetsFromPodName(ctx context.Context, clientset *kubernetes.Clientset, namespace, podName string) ([]corev1.Pod, error) {
pod, err := clientset.CoreV1().Pods(namespace).Get(ctx, podName, metav1.GetOptions{})
if err != nil {
return nil, fmt.Errorf("failed to get pod %s in namespace %s: %v", podName, namespace, err)
}
return []corev1.Pod{*pod}, nil
}
func getLogTargetsFromService(ctx context.Context, clientset *kubernetes.Clientset, namespace, serviceName string) ([]corev1.Pod, error) {
svc, err := clientset.CoreV1().Services(namespace).Get(ctx, serviceName, metav1.GetOptions{})
if err != nil {
return nil, fmt.Errorf("failed to get service %s in namespace %s: %v", serviceName, namespace, err)
}
if len(svc.Spec.Selector) == 0 {
return nil, fmt.Errorf("service %s in namespace %s has no selector", serviceName, namespace)
}
selector := labels.Set(svc.Spec.Selector).AsSelector().String()
pods, err := getLogTargetsFromLabelSelector(ctx, clientset, namespace, selector)
if err != nil {
return nil, err
}
for {
if len(pods) == 0 {
continue
}
areReplicasReady, err := areReplicasReady(ctx, clientset, pods[0])
if err != nil {
return nil, err
}
if areReplicasReady {
break
}
slog.Info("Waiting for pods of service to be ready", "service", serviceName)
time.Sleep(5 * time.Second)
}
return pods, nil
}
func getLogTargetsFromLabelSelector(ctx context.Context, clientset *kubernetes.Clientset, namespace, labelSelector string) ([]corev1.Pod, error) {
podList, err := clientset.CoreV1().Pods(namespace).List(ctx, metav1.ListOptions{
LabelSelector: labelSelector,
})
if err != nil {
return nil, fmt.Errorf("failed to list pods with label selector %s in namespace %s: %v", labelSelector, namespace, err)
}
return podList.Items, nil
}
func areReplicasReady(ctx context.Context, clientset *kubernetes.Clientset, pod corev1.Pod) (bool, error) {
for _, owner := range pod.OwnerReferences {
switch owner.Kind {
case "ReplicaSet":
return isReplicaSetReady(ctx, clientset, owner.Name, pod.Namespace)
case "StatefulSet":
return isStatefulSetReady(ctx, clientset, owner.Name, pod.Namespace)
case "DaemonSet":
return isDaemonSetReady(ctx, clientset, owner.Name, pod.Namespace)
default:
return true, nil // Not a controller we care about
}
}
// sanity
return true, nil
}
func isReplicaSetReady(ctx context.Context, clientset *kubernetes.Clientset, name, namespace string) (bool, error) {
rs, err := clientset.AppsV1().ReplicaSets(namespace).Get(ctx, name, metav1.GetOptions{})
if err != nil {
return false, fmt.Errorf("failed to get ReplicaSet %s in namespace %s: %v", name, namespace, err)
}
return rs.Status.ReadyReplicas == *rs.Spec.Replicas, nil
}
func isStatefulSetReady(ctx context.Context, clientset *kubernetes.Clientset, name, namespace string) (bool, error) {
ss, err := clientset.AppsV1().StatefulSets(namespace).Get(ctx, name, metav1.GetOptions{})
if err != nil {
return false, fmt.Errorf("failed to get StatefulSet %s in namespace %s: %v", name, namespace, err)
}
return ss.Status.ReadyReplicas == *ss.Spec.Replicas, nil
}
func isDaemonSetReady(ctx context.Context, clientset *kubernetes.Clientset, name, namespace string) (bool, error) {
ds, err := clientset.AppsV1().DaemonSets(namespace).Get(ctx, name, metav1.GetOptions{})
if err != nil {
return false, fmt.Errorf("failed to get DaemonSet %s in namespace %s: %v", name, namespace, err)
}
return ds.Status.NumberReady == ds.Status.DesiredNumberScheduled, nil
}
func (s *KubernetesLogSource) initializeLogStream(ctx context.Context) error {
if s.logStream.stream != nil {
return nil // Already initialized
}
newStream, err := getContainerLogStream(ctx, s.namespace, s.podName, s.containerName, s.clientset)
if err != nil {
return fmt.Errorf("failed to initialize log stream for pod %s container %s: %v", s.podName, s.containerName, err)
}
s.logStream = newStream
return nil
}
func (s *KubernetesLogSource) Close() error {
if s.logStream.stream == nil {
return nil
}
return s.logStream.stream.Close()
}
func (s *KubernetesLogSource) Path() string {
namespace := s.namespace
if namespace == "" {
namespace = "default"
}
return fmt.Sprintf("kubernetes://%s/%s/%s", namespace, s.podName, s.containerName)
}
func (s *KubernetesLogSource) Read(ctx context.Context) (string, error) {
// Ensure log stream is initialized
if err := s.initializeLogStream(ctx); err != nil {
return "", err
}
select {
case <-ctx.Done():
return "", ctx.Err()
default:
if s.logStream.scanner.Scan() {
line := s.logStream.scanner.Text()
return line, nil
}
// The pod might have restarted or the stream might have been closed.
// The stream will be re-initialized on the next Read() call.
s.logStream.stream.Close()
s.logStream.stream = nil
s.logStream.scanner = nil
return "", nil
}
}
func (s *KubernetesLogSource) ConstLabels() prometheus.Labels {
labels := prometheus.Labels{}
if s.namespace != "" {
labels["namespace"] = s.namespace
}
if s.podName != "" {
labels["pod"] = s.podName
}
if s.containerName != "" {
labels["container"] = s.containerName
}
return labels
}
func (s *KubernetesLogSource) RemoteAddr() string {
return fmt.Sprintf("%s.%s.%s.svc.cluster.local", s.podName, s.serviceName, s.namespace)
}
// kubernetesLogSourceFactory is a factory that can create Kubernetes log sources
// from command line flags.
type kubernetesLogSourceFactory struct {
LogSourceFactoryDefaults
clientset *kubernetes.Clientset
namespace string
podName string
serviceName string
containerName string
kubeconfigPath string
watchedPods []string
enable bool
}
func (f *kubernetesLogSourceFactory) Init(app *kingpin.Application) {
app.Flag("kubernetes.enable", "Read from Kubernetes pod logs instead of log").Default("false").BoolVar(&f.enable)
app.Flag("kubernetes.namespace", "Kubernetes namespace to read logs from (optional, defaults to current namespace when in-cluster or 'default').").Envar("KUBERNETES_NAMESPACE").StringVar(&f.namespace)
app.Flag("kubernetes.pod-name", "Specific pod name to read logs from (alternative to label-selector).").Envar("KUBERNETES_POD_NAME").StringVar(&f.podName)
app.Flag("kubernetes.service", "Name of the service selecting the postfix pods").Envar("KUBERNETES_SERVICE").StringVar(&f.serviceName)
app.Flag("kubernetes.container", "Container name to read logs from (optional, reads from all containers if not specified).").Envar("KUBERNETES_CONTAINER").StringVar(&f.containerName)
app.Flag("kubernetes.kubeconfig", "Path to kubeconfig file").Envar("KUBERNETES_KUBECONFIG").Default("~/.kube/config").StringVar(&f.kubeconfigPath)
}
func (f *kubernetesLogSourceFactory) New(ctx context.Context) ([]LogSourceCloser, error) {
if !f.enable {
return nil, nil
}
// Must specify either pod name or label selector (but not both)
if f.podName == "" && f.serviceName == "" {
return nil, nil // Not configured
}
if f.podName != "" && f.serviceName != "" {
return nil, fmt.Errorf("cannot specify both pod name and label selector, choose one")
}
// Create the clientset
clientset, inCluster, err := createClientset(f.kubeconfigPath)
if err != nil {
return nil, fmt.Errorf("failed to create kubernetes client: %v", err)
}
f.clientset = clientset
namespace := determineNamespace(f.namespace, inCluster)
f.namespace = namespace
slog.Info("Using namespace", "namespace", namespace, "in-cluster", inCluster)
pods, err := getLogTargets(ctx, clientset, namespace, f.serviceName, f.podName)
if err != nil {
return nil, err
}
slog.Info("Found pods to read logs from", "count", len(pods))
var logSources []LogSourceCloser
var logSourcesChan = make(chan LogSourceCloser)
var wg sync.WaitGroup
wg.Add(len(pods))
watchedPods := make([]string, 0, len(pods))
for _, pod := range pods {
watchedPods = append(watchedPods, pod.Name)
go func(pod corev1.Pod) {
defer wg.Done()
srcs := NewKubernetesLogSource(ctx, namespace, f.serviceName, f.containerName, pod, clientset)
for _, src := range srcs {
logSourcesChan <- src
}
}(pod)
}
slices.Sort(watchedPods)
f.watchedPods = watchedPods
go func() {
wg.Wait()
close(logSourcesChan)
}()
for src := range logSourcesChan {
logSources = append(logSources, src)
}
return logSources, nil
}
func (f *kubernetesLogSourceFactory) Watchdog(ctx context.Context) bool {
if !f.enable || f.clientset == nil {
return false
}
pods, err := getLogTargets(ctx, f.clientset, f.namespace, f.serviceName, f.podName)
if err != nil {
slog.Error("Kubernetes watchdog: failed to get log targets", "error", err)
// do not restart exporter if we cannot get log targets as this might be a transient error
return false
}
var currentPodNames []string
for _, pod := range pods {
currentPodNames = append(currentPodNames, pod.Name)
}
slices.Sort(currentPodNames)
return !slices.Equal(f.watchedPods, currentPodNames)
}
func init() {
RegisterLogSourceFactory(&kubernetesLogSourceFactory{})
}
|