mirror of
https://github.com/kubeshark/kubeshark.git
synced 2026-03-16 16:41:06 +00:00
Compare commits
4 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
8d8310ee02 | ||
|
|
0824524d62 | ||
|
|
71eff5ea04 | ||
|
|
50e404f51e |
19
README.md
19
README.md
@@ -1,6 +1,17 @@
|
||||
# 水 mizu
|
||||

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

|
||||
|
||||
## Features
|
||||
|
||||
- Simple and powerful CLI
|
||||
- Real time view of all HTTP requests, REST and gRPC API calls
|
||||
- No installation or code instrumentation
|
||||
- Works completely on premises (on-prem)
|
||||
|
||||
## Download
|
||||
|
||||
Download `mizu` for your platform and operating system
|
||||
@@ -142,10 +153,10 @@ See `examples/roles` for example `clusterroles`.
|
||||
|
||||
## How to run
|
||||
|
||||
1. Find pod you'd like to tap to in your Kubernetes cluster
|
||||
1. Find pods 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 ..
|
||||
3. Open browser on `http://localhost:8899/mizu` **or** as instructed in the CLI ..
|
||||
4. Watch the API traffic flowing ..
|
||||
5. Type ^C to stop
|
||||
|
||||
## Examples
|
||||
|
||||
BIN
assets/mizu-example.png
Normal file
BIN
assets/mizu-example.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 811 KiB |
24
assets/mizu-logo.svg
Normal file
24
assets/mizu-logo.svg
Normal file
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 44 KiB |
BIN
assets/mizu-ui.png
Normal file
BIN
assets/mizu-ui.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 491 KiB |
@@ -21,13 +21,13 @@ type CommandLineFlag struct {
|
||||
CommandLineName string
|
||||
YamlHierarchyName string
|
||||
DefaultValue interface{}
|
||||
Type reflect.Kind
|
||||
}
|
||||
|
||||
const (
|
||||
ConfigurationKeyAnalyzingDestination = "tap.dest"
|
||||
ConfigurationKeyUploadInterval = "tap.uploadInterval"
|
||||
ConfigurationKeyMizuImage = "mizuImage"
|
||||
ConfigurationKeyTelemetry = "telemetry"
|
||||
)
|
||||
|
||||
var allowedSetFlags = []CommandLineFlag{
|
||||
@@ -35,20 +35,22 @@ var allowedSetFlags = []CommandLineFlag{
|
||||
CommandLineName: "dest",
|
||||
YamlHierarchyName: ConfigurationKeyAnalyzingDestination,
|
||||
DefaultValue: "up9.app",
|
||||
Type: reflect.String,
|
||||
// TODO: maybe add short description that we can show
|
||||
},
|
||||
{
|
||||
CommandLineName: "uploadInterval",
|
||||
YamlHierarchyName: ConfigurationKeyUploadInterval,
|
||||
DefaultValue: 10,
|
||||
Type: reflect.Int,
|
||||
},
|
||||
{
|
||||
CommandLineName: "mizuImage",
|
||||
YamlHierarchyName: ConfigurationKeyMizuImage,
|
||||
DefaultValue: fmt.Sprintf("gcr.io/up9-docker-hub/mizu/%s:%s", Branch, SemVer),
|
||||
Type: reflect.String,
|
||||
},
|
||||
{
|
||||
CommandLineName: "telemetry",
|
||||
YamlHierarchyName: ConfigurationKeyTelemetry,
|
||||
DefaultValue: true,
|
||||
},
|
||||
}
|
||||
|
||||
@@ -56,13 +58,25 @@ func GetString(key string) string {
|
||||
return fmt.Sprintf("%v", getValueFromMergedConfig(key))
|
||||
}
|
||||
|
||||
func GetBool(key string) bool {
|
||||
stringVal := GetString(key)
|
||||
Log.Debugf("Found string value %v", stringVal)
|
||||
|
||||
val, err := strconv.ParseBool(stringVal)
|
||||
if err != nil {
|
||||
Log.Warningf(uiUtils.Red, fmt.Sprintf( "Invalid value %v for key %s, expected bool", stringVal, key))
|
||||
os.Exit(1)
|
||||
}
|
||||
return val
|
||||
}
|
||||
|
||||
func GetInt(key string) int {
|
||||
stringVal := GetString(key)
|
||||
Log.Debugf("Found string value %v", stringVal)
|
||||
|
||||
val, err := strconv.Atoi(stringVal)
|
||||
if err != nil {
|
||||
Log.Warningf("Invalid value %v for key %s", val, key)
|
||||
Log.Warningf(uiUtils.Red, fmt.Sprintf("Invalid value %v for key %s, expected int", stringVal, key))
|
||||
os.Exit(1)
|
||||
}
|
||||
return val
|
||||
@@ -140,13 +154,13 @@ func mergeConfigFile() error {
|
||||
|
||||
func addToConfig(prefix string, value interface{}) {
|
||||
typ := reflect.TypeOf(value).Kind()
|
||||
if typ == reflect.Int || typ == reflect.String || typ == reflect.Slice {
|
||||
validateConfigFileKey(prefix)
|
||||
configObj[prefix] = value
|
||||
} else if typ == reflect.Map {
|
||||
if typ == reflect.Map {
|
||||
for k1, v1 := range value.(map[string]interface{}) {
|
||||
addToConfig(fmt.Sprintf("%s.%s", prefix, k1), v1)
|
||||
}
|
||||
} else {
|
||||
validateConfigFileKey(prefix)
|
||||
configObj[prefix] = value
|
||||
}
|
||||
}
|
||||
|
||||
@@ -161,26 +175,23 @@ func mergeCommandLineFlags(commandLineValues []string) error {
|
||||
return errors.New(fmt.Sprintf("invalid set argument %s", e))
|
||||
}
|
||||
setFlagKey, argumentValue := split[0], split[1]
|
||||
argumentNameInConfig, expectedType, err := flagFromAllowed(setFlagKey)
|
||||
argumentNameInConfig, err := flagFromAllowed(setFlagKey)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
argumentType := reflect.ValueOf(argumentValue).Kind()
|
||||
if argumentType != expectedType {
|
||||
return errors.New(fmt.Sprintf("Invalid value for argument %s (should be type %s but got %s", setFlagKey, expectedType, argumentType))
|
||||
}
|
||||
|
||||
configObj[argumentNameInConfig] = argumentValue
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func flagFromAllowed(setFlagKey string) (string, reflect.Kind, error) {
|
||||
func flagFromAllowed(setFlagKey string) (string, error) {
|
||||
for _, allowedFlag := range allowedSetFlags {
|
||||
if strings.ToLower(allowedFlag.CommandLineName) == strings.ToLower(setFlagKey) {
|
||||
return allowedFlag.YamlHierarchyName, allowedFlag.Type, nil
|
||||
return allowedFlag.YamlHierarchyName, nil
|
||||
}
|
||||
}
|
||||
return "", reflect.Invalid, errors.New(fmt.Sprintf("invalid set argument %s", setFlagKey))
|
||||
return "", errors.New(fmt.Sprintf("invalid set argument %s", setFlagKey))
|
||||
}
|
||||
|
||||
func validateConfigFileKey(configFileKey string) {
|
||||
@@ -195,7 +206,7 @@ func validateConfigFileKey(configFileKey string) {
|
||||
|
||||
func addToConfigObj(key string, value interface{}, configObj map[string]interface{}) {
|
||||
typ := reflect.TypeOf(value).Kind()
|
||||
if typ == reflect.Int || typ == reflect.String || typ == reflect.Slice {
|
||||
if typ != reflect.Map {
|
||||
if strings.Contains(key, ".") {
|
||||
split := strings.SplitN(key, ".", 2)
|
||||
firstLevelKey := split[0]
|
||||
@@ -208,4 +219,3 @@ func addToConfigObj(key string, value interface{}, configObj map[string]interfac
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -10,6 +10,11 @@ import (
|
||||
const telemetryUrl = "https://us-east4-up9-prod.cloudfunctions.net/mizu-telemetry"
|
||||
|
||||
func ReportRun(cmd string, args interface{}) {
|
||||
if !GetBool(ConfigurationKeyTelemetry) {
|
||||
Log.Debugf("not reporting due to config value")
|
||||
return
|
||||
}
|
||||
|
||||
if Branch != "main" {
|
||||
Log.Debugf("reporting only on main branch")
|
||||
return
|
||||
|
||||
Reference in New Issue
Block a user