kge-kubectl-get-events 0.2.2

A kubernetes utility for viewing pod events in a user-friendly way

kge-kubectl-get-events

A kubernetes utility for viewing pod and failed replicaset events in a user-friendly way. There are many problems that are most easily fixed by understanding the recent events.

Table of Contents

• kge-kubectl-get-events
  • Table of Contents
  • Motivation/Alternatives
  • Installation
  • Usage
    • View Events for All Pods
    • View Events for a Specific Pod
    • View Non-Normal Events
    • Specify Namespace
    • Interactive Mode
    • Shell Completion
      • For zsh
  • Command-line Options
  • Features
  • Requirements

Motivation/Alternatives

The best alternative to this tool is:

alias kge="kubectl get events --sort-by=lastTimestamp --field-selector type!=Normal"

The problem with kubectl get events is that autocompletion doesn't allow autocomplete (or if it does, it isn't obvious). For example, this utility runs the command:

kubectl get events --field-selector involvedObject.name=busybox-deployment-7f49499c8

Which is either a lot of typing or a manual copy/paste.

Installation

pipx install kge-kubectl-get-events

Usage

View Events for All Pods

View events for all pods in the current namespace:

kge -A
# or
kge --all

View Events for a Specific Pod

View events for a specific pod:

kge <pod-name>

View Non-Normal Events

View only non-normal events (warnings and errors) for all pods:

kge --exceptions-only
# or
kge -e

In interactive mode, you can select "All pods with non-normal events" from the menu.

Specify Namespace

View events from a specific namespace:

kge -n mynamespace
# or
kge --namespace mynamespace

You can combine this with other options:

# View all events in a specific namespace
kge -A -n mynamespace

# View non-normal events in a specific namespace
kge -e -n mynamespace

# View events for a specific pod in a specific namespace
kge -n mynamespace my-pod

Interactive Mode

Run the tool without arguments to enter interactive mode:

kge

This will display a menu of all pods in the current namespace, allowing you to select which pod's events to view. The menu includes an option to view all non-normal events.

Shell Completion

The tool supports shell completion for pod names. To enable it:

For zsh

Add the following to your shell configuration:

source <(kge --completion=zsh)

Alternatively, add the completion script directly to your zsh configuration:

compdef _kge kge
_kge() {
    local -a pods
    pods=($(kge --complete))
    _describe 'pods' pods
}

Command-line Options

Option	Description
-A, --all	Get events for all pods in the current namespace
-n, --namespace	Specify the namespace to use
-e, --exceptions-only	Show only non-normal events (warnings and errors)
--complete	List pods for shell completion (internal use)
--completion=zsh	Generate zsh completion script

Features

• View events for all pods in a namespace
• View events for a specific pod
• View only non-normal events (warnings and errors)
• Specify custom namespace
• Interactive pod selection
• Shell completion support
• Automatic namespace detection
• Caching for better performance

Requirements

• Python 3.6 or higher
• Valid Kubeconfig in the environment