[Workload]: metrics-emitter
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 45/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 冷清
- 技术栈
- go, kubernetes, prometheus
调研方向
首先定位现有的 cpu、memory 和 disk workload 实现及其 Kubernetes Service 生成逻辑。查看 cloud-init 和 systemd 服务是如何定义的,然后将提议的 avalanche 命令以及端口 9101 的 Service labels 与 workload 约定进行比较。当一个 metrics-emitter VM 暴露已配置的 Prometheus endpoint,并且其 Service 支持通过 ServiceMonitor 或 PodMonitor 进行发现时,即视为完成。
由索引模型根据 Issue 内容生成。
描述
Workload Name
metrics-emitter
Workload Description
A workload that runs a Prometheus-compatible metrics endpoint inside a VM, exposing configurable gauges, counters, and histograms with tunable label cardinality and scrape-ready /metrics path. Produces sustained, realistic metric signals that monitoring partners can scrape via OpenShift's native ServiceMonitor/PodMonitor pipeline.
This is the missing link between virtwork's in-VM workloads and the Prometheus-based monitoring ecosystem on OpenShift. The current workloads (cpu, memory, disk, database) generate real system pressure, but monitoring partners need scrapeable application metrics — not just node-level signals. A metrics-emitter VM acts as a synthetic application that exposes the same kind of metric surface a real business application would: request duration histograms, active connection gauges, error counters, queue depth gauges — all with configurable cardinality to stress the partner's ingestion pipeline.
Tooling and Packages
- Tool:
avalanche(Prometheus metric load generator by Prometheus team) or a lightweight custom exporter avalancheflags:--metric-count=500 --label-count=10 --series-count=5 --port=9101 --value-interval=30- RPM packages: none —
avalancheis a single Go binary - systemd service command:
/usr/local/bin/avalanche --metric-count=500 --label-count=10 --series-count=5 --port=9101 - Exposes port 9101 (Prometheus metrics) via Kubernetes Service
- Configurable parameters: metric count, label count (cardinality), series count per metric, value change interval, port
VM Count Model
Single VM (like cpu, memory, disk)
Required Resources
- Kubernetes Service (for inter-VM communication)
- Persistent storage (DataVolume)
- Kubernetes Secret (for credentials or config)
- Additional CPU/memory beyond defaults
- GPU or special device passthrough
Cloud-Init Details
write_files:
- path: /etc/systemd/system/virtwork-metrics-emitter.service
content: |
[Unit]
Description=Virtwork Prometheus metrics emitter
After=network-online.target
Wants=network-online.target
[Service]
Type=simple
ExecStart=/usr/local/bin/avalanche \
--metric-count=500 \
--label-count=10 \
--series-count=5 \
--port=9101 \
--value-interval=30
Restart=always
RestartSec=5
[Install]
WantedBy=multi-user.target
runcmd:
- curl -Lo /usr/local/bin/avalanche https://github.com/prometheus-community/avalanche/releases/download/v0.6.0/avalanche_0.6.0_linux_amd64.tar.gz
- tar -xzf /usr/local/bin/avalanche -C /usr/local/bin/
- chmod +x /usr/local/bin/avalanche
- systemctl enable --now virtwork-metrics-emitter.service
The Kubernetes Service should expose port 9101 with appropriate labels for ServiceMonitor discovery:
apiVersion: v1
kind: Service
metadata:
name: virtwork-metrics-emitter-0
labels:
app.kubernetes.io/managed-by: virtwork
virtwork/component: metrics-emitter
virtwork/metrics: "true"
spec:
ports:
- name: metrics
port: 9101
targetPort: 9101
selector:
# matches VM pod labels
Use Case
- Monitoring platform partners (Datadog, Dynatrace, Sysdig, Grafana Labs): Need scrapeable Prometheus endpoints from VMs to validate that their agents correctly discover, scrape, and ingest application-level metrics from KubeVirt VMs — not just node/kubelet metrics. High cardinality (many labels × many series) stresses ingestion pipelines and validates the partner's ability to handle metric volume at scale.
- Prometheus/Thanos/Mimir ecosystem partners: Need realistic scrape targets to validate long-term storage, compaction, and query performance against VM-sourced metrics. Configurable metric count and cardinality lets partners tune the load to match their customers' real-world profiles.
- OpenShift platform validation: Validates that the full Prometheus pipeline — ServiceMonitor discovery → scrape → remote write → partner product — works correctly when the scrape target is a KubeVirt VM rather than a pod. This exercises a code path that's distinct from container-based scraping and is less commonly tested.
- Capacity planning partners: Need predictable, tunable metric volume to validate alerting thresholds and dashboard rendering under load.
Additional Context
avalancheis maintained by the Prometheus community and designed specifically for this purpose: generating configurable Prometheus metric load. It's the standard tool for testing Prometheus-compatible backends.- The Kubernetes Service is critical — it enables OpenShift's ServiceMonitor to discover and scrape the VM's metrics endpoint through the standard Prometheus operator pipeline. This is what makes this workload uniquely valuable on OpenShift vs. a bare VM.
- Configurable parameters to expose via CLI/YAML:
metric-count(number of distinct metrics),label-count(labels per metric — controls cardinality),series-count(series per metric),value-interval(seconds between value changes),port. - Consider also generating a sample
ServiceMonitorCR in dry-run output to show partners how to wire up scraping. This isn't a virtwork-managed resource but a documentation/example artifact. - At 500 metrics × 5 series × 10 labels, a single VM produces ~2,500 time series — comparable to a moderately instrumented microservice. Scaling to 5,000+ metrics or 50+ labels tests high-cardinality ingestion.
- 主要语言
- Go
- 星标
- 0
- 派生
- 0
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 没有贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
opdev/virtwork 的其他 Issue
-
good first issue needs-triage size/L workload-request workload/variant
难度 5/5 一周以上 新手友好度 45/100
-
needs-triage priority/awaiting-more-evidence size/XL workload-request workload/tier-2
难度 5/5 一周以上 新手友好度 48/100
-
good first issue needs-triage size/XL workload-request workload/variant
难度 5/5 一周以上 新手友好度 35/100
-
needs-triage size/L workload-request workload/tier-3
难度 4/5 3-5 天 新手友好度 48/100
-
needs-triage size/XXL workload-request workload/tier-3
难度 5/5 一周以上 新手友好度 35/100
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 66/100
goharbor/terraform-provider-harbor#655 · 1 条评论 ·
-
bug needs-triage
难度 2/5 1-3 小时 新手友好度 85/100
syncthing/syncthing#10935 · 1 条评论 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 64/100
docker/sbx-releases#737 ·
-
难度 2/5 1-3 小时 新手友好度 65/100
-
area/manager needs-triage
难度 2/5 1-3 小时 新手友好度 73/100
kyma-project/telemetry-manager#3922 ·
维护者通常 1 天内回复