{ "componentChunkName": "component---src-templates-issues-tsx", "path": "/issues/336", "result": {"data":{"issuesJson":{"id":"b1a90730-1b7a-5f5d-834d-9ba4dfbea6c3","title":"kubetail-org/kubetail: 一个通用的 Kubernetes 日志仪表板，可以暴漏在浏览器当中查看。","number":336,"bodyHTML":"
\n



\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Reposkubetail-org/kubetail
Views\"views\"
Stars\"stars\"
Forks\"forks\"
License\"license\"
UpdatedAt\"last-commit\"
CreatedAt\"create-at\"
\n\n

\"\"

\n\n
\n

Kubetail

\n

Kubetail is a real-time logging dashboard for Kubernetes (browser/terminal)

\n\n \"demo-thumbnail\"\n\n

Demo: https://www.kubetail.com/demo

\n


\n\"Slack\"
\n\"Contributor
\n\"Contributor

\n

Introduction

\n\n
\n
\n

Kubetail is a general-purpose logging dashboard for Kubernetes, optimized for tailing logs across across multi-container workloads in real-time. With Kubetail, you can view logs from all the containers in a workload (e.g. Deployment or DaemonSet) merged into a single, chronological timeline, delivered to your browser or terminal.

\n

The primary entry point for Kubetail is the kubetail CLI tool, which can launch a local web dashboard on your desktop or stream raw logs directly to your terminal. Behind the scenes, Kubetail uses your cluster's Kubernetes API to fetch logs directly from your cluster, so it works out of the box without needing to forward your logs to an external service first. Kubetail also uses your Kubernetes API to track container lifecycle events in order to keep your log timeline in sync as containers start, stop or get replaced. This makes it easy to follow logs seamlessly as user requests move from one ephemeral container to another across services.

\n

Our goal is to build the most powerful, user-friendly logging platform for Kubernetes and we'd love your input. If you notice a bug or have a suggestion please create a GitHub Issue or send us an email (hello@kubetail.com)!

\n

Features

\n\n

Quickstart (Desktop)

\n

Option 1: Package Managers

\n

First, install the Kubetail CLI tool (kubetail) via your favorite package manager:

\n
# Homebrew\nbrew install kubetail\n\n# Winget\nwinget install Kubetail.Kubetail\n\n# Chocolatey\nchoco install kubetail
\n

Next, start the web dashboard using the serve subcommand:

\n
kubetail serve
\n

This command will open http://localhost:7500/ in your default browser. Have fun tailing your logs!

\n

Option 2: Shell

\n

First, download and run the install script:

\n
curl -sS https://www.kubetail.com/install.sh | bash
\n

Next, start the web dashboard using the serve subcommand:

\n
kubetail serve
\n

This command will open http://localhost:7500/ in your default browser. Have fun tailing your logs!

\n

Option 3: Binaries

\n

Download the binary for your OS/Arch (from the latest release binaries):

\n\n

Rename the file and make it executable:

\n
mv <filename> kubetail\nchmod a+x kubetail
\n

Next, start the web dashboard using the serve subcommand:

\n
kubetail serve
\n

This command will open http://localhost:7500/ in your default browser. Have fun tailing your logs!

\n

Quickstart (Cluster)

\n

Option 1: Helm

\n

First, add the Kubetail org's chart repository, then install the \"kubetail\" chart:

\n
helm repo add kubetail https://kubetail-org.github.io/helm-charts/\nhelm install kubetail kubetail/kubetail --namespace kubetail-system --create-namespace
\n

For more information on how to configure the helm chart, see the chart's values.yaml file.

\n

To access the web dashboard you can expose it as an ingress using the chart or you can use your usual access methods such as kubectl port-forward:

\n
kubectl port-forward -n kubetail-system svc/kubetail-dashboard 8080:8080
\n

Visit http://localhost:8080. Have fun tailing your logs!

\n

Option 2: YAML Manifest

\n

First, create a namespace for the Kubetail resources:

\n
kubectl create namespace kubetail-system
\n

Next, choose your authentication mode (cluster or token) and apply the latest manifest file:

\n
# For cluster-based authentication use kubetail-clusterauth.yaml:\nkubectl apply -f https://github.com/kubetail-org/helm-charts/releases/latest/download/kubetail-clusterauth.yaml\n\n# For token-based authentication use kubetail-tokenauth.yaml:\nkubectl apply -f https://github.com/kubetail-org/helm-charts/releases/latest/download/kubetail-tokenauth.yaml
\n

To access the web dashboard you can use your usual access methods such as kubectl port-forward:

\n
kubectl port-forward -n kubetail-system svc/kubetail-dashboard 8080:8080
\n

Visit http://localhost:8080. Have fun tailing your logs!

\n

Option 3: Glasskube

\n

To install Kubetail using Glasskube, you can select \"Kubetail\" from the \"ClusterPackages\" tab in the Glasskube GUI then click \"install\" or you can run the following command:

\n
glasskube install kubetail
\n

Once Kubetail is installed you can use it by clicking \"open\" in the Glasskube GUI or by using the open command:

\n
glasskube open kubetail
\n

Have fun tailing your logs!

\n

Documentation

\n

Visit the Kubetail documentation

\n

Roadmap and Status

\n

This is our high-level plan for the Kubetail project, in order:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
StepStatus
1Real-time container logs✅
2Real-time search and polished user experience🛠️
3Real-time system logs (e.g. systemd, k8s events)🔲
4Basic customizability (e.g. colors, time formats)🔲
5Message parsing and metrics🔲
6Historic data (e.g. log archives, metrics timeseries)🔲
7Kubetail API and developer-facing client libraries🔲
NWorld Peace🔲
\n

And here are some additional details:

\n

Real-time container logs

\n

Users can view the container logs from the pods currently running inside their clusters quickly and easily using a web dashboard. Users can view container logs organized by workloads and follow log messages as ephemeral containers get created and deleted. They can also narrow their viewing window by timestamp and filter logs by source properties such as region, zone and node.

\n

Real-time search and polished user experience

\n

Users can install Kubetail easily on their desktops and in their clusters. By default, Kubetail will use only the Kubernetes API to fetch basic data such as running workloads and container logs. If a user wants more advanced functionality they can install Kubetail custom services in their cluster (i.e. \"Kubetail Cluster API\" and \"Kubetail Cluster Agent\", collectively known as the \"Kubetail API\") and gain access to features such as log search, log file sizes and last event timestamps. The entire experience of installing, upgrading and uninstalling the Kubetail API is very polished and users are able to view their logs with equally powerful tools in the browser and the terminal using the Kubetail web dashboard and CLI tool.

\n

Real-time system logs

\n

Users who install the Kubetail API gain immediate access to their node-level logs (e.g. systemd) and cluster-level logs (e.g. kubernetes events) and view them in an integrated interface that shows their container logs in context with other system information such as CPU utilization, memory usage and disk space. System logs are viewable in real-time, in the same merged timeline with other logs. Users can filter system logs by timestamp and source properties.

\n

Basic customizability

\n

Users can fully customize their Kubetail experience when using the web dashboard and CLI tool by modifying their user settings. The user settings are modifiable by hand using a config file or via the dashboard UI. The experience is very polished and works seamlessly across upgrades that may add/remove/modify user settings. Users have the option to sync their settings across multiple devices.

\n

Development

\n

Repository Structure

\n

This monorepo contains the following modules:

\n\n

It also contains the source code for the Kubetail Dashboard's frontend and the Rust binary that powers log search:

\n\n

Setting up the Development Environment

\n

Dependencies

\n\n

Next steps

\n
    \n
  1. Create a Kubernetes Dev Cluster
    2. \n
\n
ctlptl apply -f hack/ctlptl/minikube.yaml
\n

You can use any type of cluster that works with Tilt.

\n
    \n
  1. Start the dev environment:
    2. \n
\n
tilt up
\n
    \n
  1. Start the Dashboard server:
    2. \n
\n
cd modules/dashboard\ngo run cmd/main.go -c hack/config.yaml
\n
    \n
  1. Run the Dashboard UI locally:
    2. \n
\n
cd dashboard-ui\npnpm install\npnpm dev
\n

Now access the dashboard at http://localhost:5173.

\n

Optimize Development Environment for Rust (Optional)

\n

By default, the dev environment compiles \"release\" builds of the Rust components when you run run tilt up. If you want to iterate more quickly, you can have Tilt compile the rust code locally using \"debug\" builds instead.

\n

Dependencies

\n\n

Next steps

\n

First, install the Rust target required for your architecture:

\n
# x86_64\nrustup target add x86_64-unknown-linux-musl\n\n# aarch64\nrustup target add aarch64-unknown-linux-musl
\n

Next, install the tools required by Rust cross compiler:

\n
# macOS (Homebrew)\nbrew install FiloSottile/musl-cross/musl-cross\n\n# Linux (Ubuntu)\napt-get install musl-tools
\n

On macOS, add this to your ~/.cargo/config.toml file:

\n
[target.x86_64-unknown-linux-musl]\nlinker = \"x86_64-linux-musl-gcc\"\n\n[target.aarch64-unknown-linux-musl]\nlinker = \"aarch64-linux-musl-gcc\"\n
\n

Finally, to use the local compiler, just run Tilt using using the KUBETAIL_DEV_RUST_LOCAL env flag:

\n
KUBETAIL_DEV_RUST_LOCAL=true tilt up
\n

Build

\n

CLI Tool

\n

To build the Kubetail CLI tool executable (kubetail), run the following command:

\n
make
\n

When the build process finishes you can find the executable in the local bin/ directory.

\n

Dashboard

\n

To build a docker image for a production deployment of the Kubetail Dashboard server, run the following command:

\n
docker build -f build/package/Dockerfile.dashboard -t kubetail-dashboard:latest .
\n

Cluster API

\n

To build a docker image for a production deployment of the Kubetail Cluster API server, run the following command:

\n
docker build -f build/package/Dockerfile.cluster-api -t kubetail-cluster-api:latest .
\n

Cluster Agent

\n

To build a docker image for a production deployment of the Kubetail Cluster Agent, run the following command:

\n
docker build -f build/package/Dockerfile.cluster-agent -t kubetail-cluster-agent:latest .
\n

Get Involved

\n

We're building the most user-friendly, cost-effective, and secure logging platform for Kubernetes and we'd love your contributions! Here's how you can help:

\n\n

Reach us at hello@kubetail.com, or join our Discord server or Slack channel.

","updatedAt":"2025-05-21T16:09:16Z","upvoteCount":null,"author":{"login":"eryajf","avatarUrl":"https://avatars.githubusercontent.com/u/33259379?u=e4a4090a38ac2473aaed4ef9945233636776c6c3&v=4","url":"https://github.com/eryajf"},"category":null,"labels":{"edges":[{"node":{"name":"更多","color":"25B472"}},{"node":{"name":"K8S-Tools","color":"2d411a"}},{"node":{"name":"kubetail-org","color":"575c52"}}]},"comments":{"edges":[]}}},"pageContext":{"number":336,"previous":{"title":"danielfoehrKn/kubeswitch: 一款 k8s 多集群配置文件管理切换工具","number":335},"next":{"title":"johanhaleby/kubetail: 可以同时监控 Kubernetes 多个 pods 日志的 Bash 脚本。","number":337}}}, "staticQueryHashes": ["151096407","2861350382"]}