vmware-tanzu/vm-operator

Add metrics and logs to emit total number of OVF cached items

Open

#332 opened on Jan 4, 2024

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Go (78 forks)auto 404
good first issue

Repository metrics

Stars
 (130 stars)
PR merge metrics
 (PR metrics pending)

Description

Please describe the solution you would like. Currently, we lack information about the size of the OVF cache used during VM image reconciliation. It would be beneficial to add logs that provide this information when updating the cache here: https://github.com/vmware-tanzu/vm-operator/blob/f4257d2887ae13521f924ef37b13d021a93fcab6/pkg/vmprovider/providers/vsphere/vmprovider.go#L287-L288

Is there anything else you would like to add? This may also require a function added in the Cache to expose the size of its items.

Additionally, we should emit prometheus metrics for total number of cached items which can help root cause issues that result in the VM operator pod running out of memory.

Please tell us about your environment. N/A

Contributor guide

Research direction
Add a method to the Cache struct to expose the number of cached items. Then, in the vmprovider.go file, log that count after updating the cache and emit a Prometheus gauge metric for the total cached items.
Tech stack
go
Domain
backendinfrastructure
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GoPrometheus
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75