khi

Language: English | 日本語

Kubernetes History Inspector

Kubernetes History Inspector (KHI) is a rich log visualization tool for Kubernetes clusters. KHI transforms vast quantities of logs into an interactive, comprehensive timeline view. This makes it an invaluable tool for troubleshooting complex issues that span multiple components within your Kubernetes clusters. Also, KHI is agentless, allowing anyone to access its features without a complicated process.

Timeline view	Topology view
Timeline view visualizes resource status change timings with timeline charts and manifest diffs from Kubernetes audit logs.	Topology view visualizes relationships among Kubernetes resources, solely from kube-apiserver audit logs.

Getting started

The easiest way to try KHI is using Cloud Shell, where the metadata server is available without requiring initial credential setup.

Running in Cloud Shell

1. Open Cloud Shell

2. Run the following command:

   docker run -p 127.0.0.1:8080:8080 gcr.io/kubernetes-history-inspector/release:latest
   

3. Click the link http://localhost:8080 on the terminal and start working with KHI!

Running in environment without a metadata server (Local PC, etc.)

gcloud auth application-default login
docker run \
 -p 127.0.0.1:8080:8080 \
 -v ~/.config/gcloud/application_default_credentials.json:/root/.config/gcloud/application_default_credentials.json:ro \
 gcr.io/kubernetes-history-inspector/release:latest

gcloud auth application-default login
docker run `
-p 127.0.0.1:8080:8080 `
-v $env:APPDATA\gcloud\application_default_credentials.json:/root/.config/gcloud/application_default_credentials.json:ro `
gcr.io/kubernetes-history-inspector/release:latest

• For running KHI in automated workflows (CI/CD, alert triggers, etc.) without starting the web server, see the Job Mode Guide.
• To build KHI from source code, see the Development Guide.
• For more details, try Getting started.

Supported Products & Environments

Kubernetes cluster

• Google Cloud

  • Google Kubernetes Engine
  • Cloud Composer
  • GKE on AWS
  • GKE on Azure
  • GDCV for Baremetal
  • GDCV for VMWare

• Other

  • kube-apiserver audit logs as JSONlines (Tutorial)

Logging backend

• Google Cloud

  • Cloud Logging (For all clusters on Google Cloud)

• Other

  • Log file upload (Tutorial)

Supported environment

• Latest Google Chrome
• docker command

[!IMPORTANT] We only test KHI on the latest version of Google Chrome. KHI may work with other browsers, but we do not provide support if it does not.

Environment Setup Guide

Google Cloud

Read Google Cloud Permissions & Configuration Guide.

OSS Kubernetes

Read Using KHI with OSS Kubernetes Clusters - Example with Loki.

User Guide

Read user guide.

Development Contribution Guide

If you'd like to contribute to the project KHI, read Contribution Guide and then follow Development Guide

Disclaimer

Please note that this tool is not an officially supported Google Cloud product. If you find any issues and have a feature request, file a Github issue on this repository and we are happy to check them on best-effort basis.

[!IMPORTANT] Do not expose KHI port on the internet. KHI itself is not providing any authentication or authorization features and KHI is intended to be accessed from its local user.