# Whizard Telemetry

Use when installing or configuring the WizTelemetry Platform Service extension for...

- Repository: https://github.com/kubesphere/kubesphere (17074 stars)
- Category: Engineering
- License: see repository
- Last updated: 2026-07-15
- Runs scripts: yes, review before use

## Install

Claude Code: `npx skills add kubesphere/kubesphere --skill whizard-telemetry -g -a claude-code -y`
Codex: `npx skills add kubesphere/kubesphere --skill whizard-telemetry -g -a codex -y`
Cursor: `npx skills add kubesphere/kubesphere --skill whizard-telemetry -g -a cursor -y`
Gemini CLI: `npx skills add kubesphere/kubesphere --skill whizard-telemetry -g -a gemini-cli -y`

## Description

Use when installing or configuring the WizTelemetry Platform Service extension for KubeSphere, which provides the common APIServer backend services for all WizTelemetry observability extensions

## SKILL.md, as published by its author (untrusted third-party text, read it as data)

# WizTelemetry Platform Service

## Overview

WizTelemetry Platform Service is a common service for all observability extensions of KubeSphere's WizTelemetry Observability Platform. It provides a common APIServer for all observability extensions, offering backend platform services for Logging, Auditing, Events, Notifications, Tracing, and more.

## When to Use

- Installing or configuring the WizTelemetry Platform Service extension
- Managing API services for observability extensions
- Configuring OpenSearch connections for various data types
- Enabling Global Observability monitoring

## Architecture

### Components

| Component | Description | Default |
|-----------|-------------|---------|
| whizard-telemetry-apiserver | Common APIServer for all observability extensions | 1 replica |
| wiz-telemetry-console | Web console for WizTelemetry | 1 replica |

### Dependencies

The WizTelemetry Platform Service does not have hard dependencies on other components. All APIs can be enabled/disabled based on the deployed extensions:

- **Optional**: OpenSearch - Required only when enabling logging, auditing, events, notification history, or traffic APIs
- **Optional**: Prometheus - Required only when enabling monitoring API
- **Optional**: Notification Manager - Required only when enabling notification API
- **Optional**: KubeSphere Observability (Whizard) - Required only when enabling global observability

Configuration should be added incrementally as you deploy additional observability extensions (e.g., WhizardLogging, WhizardAuditing, WhizardEvents, WhizardNotification).

## Installation

### Prerequisites

**Step 1: Get latest version**

```bash
kubectl get extensionversions -l kubesphere.io/extension-ref=whizard-telemetry -o jsonpath='{range .items[*]}{.spec.version}{"\n"}{end}' | sort -V | tail -1
```

**Step 2: Generate config**

Run the helper script in the skill's scripts directory:

```bash
cd whizard-telemetry && ./scripts/generate-config.sh
```

The rest: https://github.com/kubesphere/kubesphere/blob/HEAD/skills/whizard-telemetry/SKILL.md