Skip to main content

User Metrics

User Metrics collection is enabled by default when installing Shifu, you can disable it before or after installation.

Permissions​

The user metrics collection module for Shifu take the advantage of Kubernetes' built-in view permission ClusterRole, as described in official Kubernetes documentation.

User Metrics collection only allows read-only access to most objects, such as Pod basic information, Kubernetes information, and so on. It does not allow access to private information such as roles, secrets, etc., so you don't need to worry about privacy leaks.

Data we collect​

  • Extranet IP
  • Download date
  • Kubernetes Versions
  • Shifu Version
  • Kubernetes Cluster Size
  • Kubernetes Pod Name
  • Kubernetes Deployment Name
  • Type of operating system

Settings​

You can set the telemetry interval by setting -pkg/k8s/crd/install/shifu_install.yaml with --user-metrics-interval=60.

Or you can edit the deployment after installation with kubectl edit -n shifu-crd-system shifu-crd-controller-manager.

apiVersion: apps/v1
kind: Deployment
spec:
  replicas: 1
  selector:
    matchLabels:
      control-plane: controller-manager
  template:
    spec:
      containers:
      image: quay.io/brancz/kube-rbac-proxy:v0.13.1
      name: kube-rbac-proxy
      - args:
        --user-metrics-interval=60 ## Edit this line

Turn off user-metrics-collection​

To turn off telemetry, manually remove --enable-user-metrics from pkg/k8s/crd/install/shifu_install.yaml.

Or you can edit the deployment after installation with kubectl edit -n shifu-crd-system shifu-crd-controller-manager.

apiVersion: apps/v1
kind: Deployment
spec:
  replicas: 1
  selector:
    matchLabels:
      control-plane: controller-manager
  template:
    spec:
      containers:
      image: quay.io/brancz/kube-rbac-proxy:v0.13.1
      name: kube-rbac-proxy
      - args:
        --enable-user-metrics ## Delete this line