Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include pod logs in toolbox dump #16198

Merged
merged 3 commits into from
Jan 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion cmd/kops/toolbox_dump.go
Original file line number Diff line number Diff line change
Expand Up @@ -228,13 +228,21 @@ func RunToolboxDump(ctx context.Context, f commandutils.Factory, out io.Writer,
return fmt.Errorf("error dumping nodes: %v", err)
}
if options.K8sResources {
dumper, err := dump.NewResourceDumper("docker-desktop", config, options.Output, options.Dir)
dumper, err := dump.NewResourceDumper(config, options.Output, options.Dir)
if err != nil {
return fmt.Errorf("error creating resource dumper: %w", err)
}
if err := dumper.DumpResources(ctx); err != nil {
return fmt.Errorf("error dumping resources: %w", err)
}

logDumper, err := dump.NewPodLogDumper(config, options.Dir)
if err != nil {
return fmt.Errorf("error creating pod log dumper: %w", err)
}
if err := logDumper.DumpLogs(ctx); err != nil {
return fmt.Errorf("error dumping pod logs: %w", err)
}
}
}

Expand Down
162 changes: 162 additions & 0 deletions pkg/dump/podlogs.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,162 @@
/*
Copyright 2023 The Kubernetes Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package dump

import (
"context"
"errors"
"fmt"
"os"
"path"

v1 "k8s.io/api/core/v1"
k8sErrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/client-go/kubernetes"
"k8s.io/client-go/rest"
"k8s.io/klog/v2"
)

const (
podLogDumpConcurrency = 20
)

type podLogDumper struct {
k8sClient *kubernetes.Clientset
artifactsDir string
}

type podLogDumpResult struct {
err error
}

func NewPodLogDumper(k8sConfig *rest.Config, artifactsDir string) (*podLogDumper, error) {
k8sConfig.QPS = 50
k8sConfig.Burst = 100
clientSet, err := kubernetes.NewForConfig(k8sConfig)
if err != nil {
return nil, fmt.Errorf("creating clientset: %w", err)
}
return &podLogDumper{
k8sClient: clientSet,
artifactsDir: artifactsDir,
}, nil
}

func (d *podLogDumper) DumpLogs(ctx context.Context) error {
klog.Info("Dumping k8s pod logs")

allPods, err := d.k8sClient.CoreV1().Pods(v1.NamespaceAll).List(ctx, metav1.ListOptions{})
if err != nil {
return fmt.Errorf("listing pods: %w", err)
}

jobs := make(chan v1.Pod, len(allPods.Items))
results := make(chan podLogDumpResult, len(allPods.Items))

for i := 0; i < podLogDumpConcurrency; i++ {
go d.getPodLogs(ctx, jobs, results)
}

var dumpErr error

for _, pod := range allPods.Items {
jobs <- pod
}
close(jobs)

for i := 0; i < len(allPods.Items); i++ {
result := <-results
if result.err != nil {
errors.Join(dumpErr, result.err)
}
}
close(results)
return dumpErr
}

func (d *podLogDumper) getPodLogs(ctx context.Context, pods chan v1.Pod, results chan podLogDumpResult) {
for pod := range pods {
for _, container := range append(pod.Spec.InitContainers, pod.Spec.Containers...) {
resPath := path.Join(d.artifactsDir, "cluster-info", pod.Namespace, pod.Name, container.Name+".log")

err := os.MkdirAll(path.Dir(resPath), 0755)
if err != nil {
results <- podLogDumpResult{
err: fmt.Errorf("creating directory %q: %w", resPath, err),
}
continue
}
resFile, err := os.Create(resPath)
if err != nil {
results <- podLogDumpResult{
err: fmt.Errorf("creating file %q: %w", resPath, err),
}
continue
}

prevResp, err := d.k8sClient.CoreV1().Pods(pod.Namespace).GetLogs(pod.Name, &v1.PodLogOptions{Container: container.Name, Previous: true}).Do(ctx).Raw()
hasPrevious := true
var statusErr *k8sErrors.StatusError
if errors.As(err, &statusErr) {
if statusErr.ErrStatus.Code == 400 {
hasPrevious = false
} else {
results <- podLogDumpResult{
err: fmt.Errorf("getting pod logs for %v/%v: %w", pod.Namespace, pod.Name, err),
}
continue
}
}

resp, err := d.k8sClient.CoreV1().Pods(pod.Namespace).GetLogs(pod.Name, &v1.PodLogOptions{Container: container.Name}).Do(ctx).Raw()
if err != nil {
results <- podLogDumpResult{
err: fmt.Errorf("getting pod logs for %v/%v: %w", pod.Namespace, pod.Name, err),
}
continue
}

suffix := fmt.Sprintf("container %v of pod %v/%v ====\n", container.Name, pod.Namespace, pod.Name)
if hasPrevious {
contents := []byte(fmt.Sprintf("==== START logs for PREVIOUS %v", suffix))
contents = append(contents, prevResp...)
contents = append(contents, []byte(fmt.Sprintf("==== END logs for PREVIOUS %v", suffix))...)
_, err = resFile.Write(contents)
if err != nil {
results <- podLogDumpResult{
err: fmt.Errorf("writing pod logs for %v/%v: %w", pod.Namespace, pod.Name, err),
}
continue
}
}
contents := []byte(fmt.Sprintf("==== START logs for CURRENT %v", suffix))
contents = append(contents, resp...)
contents = append(contents, []byte(fmt.Sprintf("==== END logs for CURRENT %v", suffix))...)
_, err = resFile.Write(contents)
if err != nil {
results <- podLogDumpResult{
err: fmt.Errorf("writing pod logs for %v/%v: %w", pod.Namespace, pod.Name, err),
}
continue
}

}

results <- podLogDumpResult{}
}
}
2 changes: 1 addition & 1 deletion pkg/dump/resourcedumper.go
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ type resourceDumpResult struct {
err error
}

func NewResourceDumper(clusterName string, k8sConfig *rest.Config, output, artifactsDir string) (*resourceDumper, error) {
func NewResourceDumper(k8sConfig *rest.Config, output, artifactsDir string) (*resourceDumper, error) {
k8sConfig.QPS = 50
k8sConfig.Burst = 100
dynamicClient, err := dynamic.NewForConfig(k8sConfig)
Expand Down
Loading