Skip to main content

Kubernetes utility for viewing pod and failed replicaset events

Project description

kge - Kubernetes Events Viewer

Python Version License: MIT PyPI

A simple yet powerful CLI tool for viewing and monitoring Kubernetes events with a focus on readability and ease of use. kge provides an intuitive interface to quickly diagnose issues.

Table of Contents

Features

  • 🔍 View events for specific pods
  • 👻 Find missing pods because of missing serviceAccounts or volumes
  • 📊 View all events in a namespace
  • ⚠️ Filter to show only non-normal events
  • 🖱️ Interactive pod selection
  • 🎨 Color-coded output
  • ⌨️ Shell completion support (zsh)
  • 🔄 View events for any Kubernetes resource type (Pods, Deployments, CRDs, etc.)

Installation

A brew formula is a WIP. Until then, use pipx. Which can be installed with brew install pipx Pipx is like brew, only for python.

# Install using pipx (recommended)
pipx install kge-kubectl-get-events
# Or install using pip, but not as easy
pip install kge-kubectl-get-events

Usage

Basic Usage

View events for a specific pod:

kge <pod-name>

View all events in the current namespace:

kge -a

View only non-normal events:

kge -e

Combine flags to view all non-normal events in the current namespace:

kge -ea

View events in a specific namespace:

kge -n <namespace>

Viewing Events for Any Resource Type

View events for a specific resource type:

kge -k <kind> <resource-name>

Interactive Mode

Run without arguments for interactive pod selection:

kge

Check a different namespace than your current context:

kge -n kubecost

Shell Completion

Enable zsh completion:

source <(kge --completion=zsh)

Completion features:

  • Tab completion for namespaces after -n
  • Tab completion for pods after -n <namespace>
  • Tab completion for kinds after -k
  • Tab completion for resources of a specific kind after -k <kind>

Examples

View non-normal events for all pods in a namespace:

kge -ea

View events for a specific pod in a specific namespace:

kge -n my-namespace my-pod

View events for a Deployment:

kge -k Deployment my-deployment

Known Issues

  • Not all arguments work together. For example, kge -e -k Deployment will not work. For complex queries, use kge -a to see all events and filter with grep or another tool.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kge_kubectl_get_events-0.9.20.tar.gz (17.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kge_kubectl_get_events-0.9.20-py3-none-any.whl (13.4 kB view details)

Uploaded Python 3

File details

Details for the file kge_kubectl_get_events-0.9.20.tar.gz.

File metadata

  • Download URL: kge_kubectl_get_events-0.9.20.tar.gz
  • Upload date:
  • Size: 17.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for kge_kubectl_get_events-0.9.20.tar.gz
Algorithm Hash digest
SHA256 0d7e5337df49121b84832969bbc6e5db48f1644385065242cbc36f79fcb06040
MD5 13329bbe24fae46eea2ea95d31328df8
BLAKE2b-256 750f0d85b2815f239eea6e2bdf2a6553c8f13396ad64cba45469ef91ebbbe0f9

See more details on using hashes here.

Provenance

The following attestation bundles were made for kge_kubectl_get_events-0.9.20.tar.gz:

Publisher: python-publish.yaml on jessegoodier/kge

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file kge_kubectl_get_events-0.9.20-py3-none-any.whl.

File metadata

File hashes

Hashes for kge_kubectl_get_events-0.9.20-py3-none-any.whl
Algorithm Hash digest
SHA256 6913dfa7d435958f9d26cb93d6ad1f0237a2f97b0d40d3eae67beea64e9779df
MD5 95ce5a3298945f61d7e663a1586b945d
BLAKE2b-256 bd41d2c69baf436a0dfb06455c16e38eacff24634c93df24ce53ba702e845c23

See more details on using hashes here.

Provenance

The following attestation bundles were made for kge_kubectl_get_events-0.9.20-py3-none-any.whl:

Publisher: python-publish.yaml on jessegoodier/kge

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page