github/kubeshark
1
0
Fork 0
mirror of https://github.com/kubeshark/kubeshark.git synced 2025-06-21 13:58:49 +00:00
Code Issues Packages Projects Releases Wiki Activity
The API traffic analyzer for Kubernetes providing real-time K8s protocol-level visibility, capturing and monitoring all traffic and payloads going in, out and across containers, pods, nodes and clusters. Inspired by Wireshark, purposely built for Kubernetes
317 Commits 83 Branches 952 Tags 174 MiB
Go 92.1%
Makefile 4.3%
Shell 2.1%
Smarty 1.5%
6dd2bf705b
Go to file
RamiBerm 6dd2bf705b
TRA-3437 switch fiber and ikisocket with gin-gonic and gorilla websocket (#136) 
* WIP

* WIP

* WIP

* Update socket_server_handlers.go and socket_routes.go

* Fix stuck sockets

* Update go.mod, go.sum, and 5 more files...

* Update socket_routes.go

* Update Dockerfile, go.sum, and fiber_middleware.go

* fix analyze

Co-authored-by: RamiBerm <rami.berman@up9.com>
2021-07-25 13:08:29 +03:00
.github/workflows . 2021-07-21 11:23:49 +03:00
agent TRA-3437 switch fiber and ikisocket with gin-gonic and gorilla websocket (#136) 2021-07-25 13:08:29 +03:00
cli Introducing new logger, logging debug to file and info to stderr (#134) 2021-07-25 10:08:37 +03:00
examples/roles Install Mizu in a dedicated namespace (#123) 2021-07-22 14:26:12 +03:00
shared Update main.go, tap.go, and 4 more files... 2021-07-21 10:49:27 +03:00
tap Renamed collector, aggregator to api server, api folder to agent (#133) 2021-07-22 17:17:17 +03:00
ui UI api helper (#131) 2021-07-22 15:41:09 +03:00
.dockerignore no message 2021-04-28 17:54:32 +03:00
.gitignore Infinite scroll (#28) 2021-05-04 18:23:58 +03:00
build-push-featurebranch.sh Versioning (#116) 2021-07-15 16:19:29 +03:00
debug.Dockerfile Renamed collector, aggregator to api server, api folder to agent (#133) 2021-07-22 17:17:17 +03:00
Dockerfile TRA-3437 switch fiber and ikisocket with gin-gonic and gorilla websocket (#136) 2021-07-25 13:08:29 +03:00
LICENSE Initial commit 2021-04-19 13:29:56 +03:00
Makefile Renamed collector, aggregator to api server, api folder to agent (#133) 2021-07-22 17:17:17 +03:00
README.md Install Mizu in a dedicated namespace (#123) 2021-07-22 14:26:12 +03:00

README.md

水 mizu

A simple-yet-powerful API traffic viewer for Kubernetes to help you troubleshoot and debug your microservices. Think TCPDump and Chrome Dev Tools combined.

Download

Download mizu for your platform and operating system

Latest stable release

  • for MacOS - Intel
curl -Lo mizu \
https://github.com/up9inc/mizu/releases/latest/download/mizu_darwin_amd64 \
&& chmod 755 mizu
  • for Linux - Intel 64bit
curl -Lo mizu \
https://github.com/up9inc/mizu/releases/latest/download/mizu_linux_amd64 \
&& chmod 755 mizu

SHA256 checksums are available on the Releases page.

Development (unstable) build

Pick one from the Releases page.

Prerequisites

  1. Set KUBECONFIG environment variable to your kubernetes configuration. If this is not set, mizu assumes that configuration is at ${HOME}/.kube/config
  2. mizu needs following permissions on your kubernetes cluster to run
- apiGroups:
  - ""
  resources:
  - pods
  verbs:
  - list
  - watch
  - create
- apiGroups:
  - ""
  resources:
  - services
  verbs:
  - create
- apiGroups:
  - apps
  resources:
  - daemonsets
  verbs:
  - create
  - patch
- apiGroups:
  - ""
  resources:
  - namespaces
  verbs:
  - list
  - watch
  - create
  - delete
- apiGroups:
  - ""
  resources:
  - services/proxy
  verbs:
  - get
  1. Optionally, for resolving traffic ip to kubernetes service name, mizu needs below permissions
- apiGroups:
  - ""
  resources:
  - pods
  verbs:
  - get
- apiGroups:
  - ""
  resources:
  - services
  verbs:
  - get
  - list
  - watch
- apiGroups:
  - apps
  - extensions
  resources:
  - pods
  verbs:
  - get
  - list
  - watch
- apiGroups:
  - apps
  - extensions
  resources:
  - services
  verbs:
  - get
  - list
  - watch
- apiGroups:
  - ""
  - apps
  - extensions
  resources:
  - endpoints
  verbs:
  - get
  - list
  - watch
- apiGroups:
  - ""
  resources:
  - serviceaccounts
  verbs:
  - get
  - create
- apiGroups:
  - rbac.authorization.k8s.io
  resources:
  - clusterroles
  verbs:
  - list
  - create
  - delete
- apiGroups:
  - rbac.authorization.k8s.io
  resources:
  - clusterrolebindings
  verbs:
  - list
  - create
  - delete

See examples/roles for example clusterroles.

How to run

  1. Find pod you'd like to tap to in your Kubernetes cluster
  2. Run mizu tap PODNAME or mizu tap REGEX
  3. Open browser on http://localhost:8899 as instructed ..
  4. Watch the WebAPI traffic flowing ..
  5. Type ^C to stop

Examples

Run mizu help for usage options

To tap specific pod -

 $ kubectl get pods 
 NAME                            READY   STATUS    RESTARTS   AGE
 front-end-649fc5fd6-kqbtn       2/2     Running   0          7m
 ..

 $ mizu tap front-end-649fc5fd6-kqbtn
 +front-end-649fc5fd6-kqbtn
 Web interface is now available at http://localhost:8899
 ^C

To tap multiple pods using regex -

 $ kubectl get pods 
 NAME                            READY   STATUS    RESTARTS   AGE
 carts-66c77f5fbb-fq65r          2/2     Running   0          20m
 catalogue-5f4cb7cf5-7zrmn       2/2     Running   0          20m
 front-end-649fc5fd6-kqbtn       2/2     Running   0          20m
 ..

 $ mizu tap "^ca.*"
 +carts-66c77f5fbb-fq65r
 +catalogue-5f4cb7cf5-7zrmn
 Web interface is now available at http://localhost:8899
 ^C