spiffe/spire

Fix the "expiring" and "outdated" metrics emitted during entry sync to be accurate across the whole cache

Open

#2,437 opened on Aug 3, 2021

View on GitHub
 (8 comments) (0 reactions) (0 assignees)Go (631 forks)auto 404
help wantedpriority/backlog

Repository metrics

Stars
 (2,443 stars)
PR merge metrics
 (PR metrics pending)

Description

Ref https://github.com/spiffe/spire/blob/04bee9741ac3b8c4b204e6367d0bd6146f78a8c7/pkg/agent/manager/sync.go#L67

	// TODO: this values are not real, we may remove
	if expiring > 0 {
		telemetry_agent.AddCacheManagerExpiredSVIDsSample(m.c.Metrics, float32(expiring))
		m.c.Log.WithField(telemetry.ExpiringSVIDs, expiring).Debug("Updating expiring SVIDs in cache")
	}
	if outdated > 0 {
		telemetry_agent.AddCacheManagerOutdatedSVIDsSample(m.c.Metrics, float32(outdated))
		m.c.Log.WithField(telemetry.OutdatedSVIDs, outdated).Debug("Updating SVIDs with outdated attributes in cache")
	}

It's not clear what is meant by "[these] values are not real" and why (I'm assuming) the metric blocks may be removed?

  • If this logic or similar may be removed, let's go ahead and remove it for this issue
  • If removal can't be done yet, let's update that comment to be more specific, and add a github issue number tracking removal
  • If the removal can't or is not foreseen as ever removable, let's get rid of the comment

Contributor guide

Research direction
Investigate the entry sync logic in sync.go around line 67 to understand what 'expiring' and 'outdated' metrics represent, and determine if they are accurately computed across the whole cache. If not, decide whether to fix the computation, remove the metrics, or clarify the comment with a tracking issue.
Tech stack
go
Domain
backendsecurity
Issue type
Bug
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.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GoGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50