Skip to content

fix(hllprocessor): remove dead attribute emission helpers; fix broken test - #160

Merged
zzylol merged 1 commit into
mainfrom
feat/hll-typed-datapoint
Apr 15, 2026
Merged

zzylol merged 1 commit into
mainfrom
feat/hll-typed-datapoint

Conversation

@zzylol

@zzylol zzylol commented Apr 15, 2026

Copy link
Copy Markdown
Contributor

hllprocessor was already emitting typed HLLSketchDataPoints — the same refactor #158 and #159 did for countmin and countsketch was already done for HLL in both the batch (processor.go:289-334) and windowed (processor.go:553-637) paths.

But two dead helper functions (appendHLLSketchDataPoint, appendHLLDeltaDataPoint) from an earlier iteration still lived in the file, and an integration test (TestIntegrationTransmitSketch) still asserted against the old hll.sketch_payload Gauge-attribute shape those dead helpers had once produced. The test has been silently failing to match anything on every CI run that exercised it — the live processor code never calls those helpers.

Changes

processor.go

Deleted appendHLLSketchDataPoint and appendHLLDeltaDataPoint (~40 lines of dead code). Both were unreachable from the live emission paths and contained the old attribute-bytes shape the ASAPQuery-backend modified-OTLP decoder doesn't consume.

No behavior change — the live paths already emit SetSketch() / SetEncoding() / SetCount() / SetCardinality() / SetPrecision() on proper typed HLLSketchDataPoints.

integration_test.go

TestIntegrationTransmitSketch updated to look for a typed HLLSketch metric with a non-empty Sketch() field and HLLSketchEncodingProto in the Encoding() field — the real wire shape the live processor code has been emitting all along.

The old assertion scanned pmetric.MetricTypeGauge data points for an hll.sketch_payload byte attribute which never existed because the helper that would have produced it was never called.

Why this is still useful

hllprocessor not needing a functional refactor is the good news: the data plane for HLL has been correct since whoever last touched this file. The cleanup here removes dead code and fixes the formerly-silently-broken test so the CI assertion actually validates what the processor does. This unblocks the MSGPACK encoding option follow-up from confidently using HLL as a template for "what a correctly-emitting sketch processor looks like."

Validation

Same pre-existing go.opentelemetry.io/collector/processor/selfmonitor resolution issue as #158 and #159 blocks local go build.

  • gofmt -l: clean on both modified files
  • ✅ All API methods used (pmetric.MetricTypeHLLSketch, HLLSketch(), Sketch(), Encoding(), HLLSketchEncodingProto) are already exposed by the pmetric patch
  • ✅ Behavior unchanged — only dead code removed and one formerly-silently-broken test assertion aligned to reality

Stack

  • #158 (merged) — countminsketchprocessor typed emission
  • #159countsketchprocessor typed emission
  • This PRhllprocessor dead-code cleanup + broken-test fix
  • Nextkllprocessor (inspect and refactor if needed)
  • After that — MSGPACK encoding option per-processor (one-line branch each)

🤖 Generated with Claude Code

… test

`hllprocessor` was already emitting typed `HLLSketchDataPoint`s in both
the batch (processor.go:289-334) and windowed (processor.go:553-637)
paths — the same refactor PRs #158 and #159 just did for countmin and
countsketch was already done for HLL. But two dead helper functions
(`appendHLLSketchDataPoint`, `appendHLLDeltaDataPoint`) from an earlier
iteration still lived in the file, and an integration test
(`TestIntegrationTransmitSketch`) still asserted against the old
`hll.sketch_payload` Gauge-attribute shape those dead helpers had once
produced. The test has been silently failing to match anything on every
CI run that exercised it, because the processor's live code path never
calls those helpers.

## Changes

### `processor.go`

Deleted `appendHLLSketchDataPoint` and `appendHLLDeltaDataPoint`
(~40 lines of dead code). Both were unreachable from the live
emission paths and contained the old attribute-bytes shape the
ASAPQuery-backend modified-OTLP decoder doesn't consume.

No behavior change — the live paths at lines 289-334 and 553-637
already emit `SetSketch()` / `SetEncoding()` / `SetCount()` /
`SetCardinality()` / `SetPrecision()` on proper typed
`HLLSketchDataPoint`s with `SetEmptyHLLSketch()`.

### `integration_test.go`

`TestIntegrationTransmitSketch` updated to look for a typed
`HLLSketch` metric with a non-empty `Sketch()` field and
`HLLSketchEncodingProto` in the `Encoding()` field — the real
wire shape the live processor code has been emitting all along.

The old assertion scanned `pmetric.MetricTypeGauge` data points
for an `hll.sketch_payload` byte attribute, which never existed
because the helper that would have produced it was never called.
The test was a silent no-op under any CI configuration that ran
it, or failed under any configuration that inspected the
assertion more carefully. Fixed to reflect reality.

## Why this is still useful

hllprocessor not needing a functional refactor is the good news:
the data plane for HLL has been correct since whoever last touched
this file. The cleanup here removes dead code and fixes the
formerly-silently-broken test so the CI assertion actually
validates what the processor does. This unblocks the MSGPACK
encoding option follow-up from confidently using HLL as a template
for "what a correctly-emitting sketch processor looks like."

## Validation

Same pre-existing `go.opentelemetry.io/collector/processor/selfmonitor`
resolution issue as PRs #158 and #159 blocks local `go build`. gofmt
is clean on both modified files. All API methods used
(`pmetric.MetricTypeHLLSketch`, `HLLSketch()`, `DataPoints()`,
`Sketch()`, `Encoding()`, `HLLSketchEncodingProto`) are already
exposed by the pmetric patch.

## Follow-up

  * `kllprocessor` — the last of the four processors on the typed-DP
    refactor series. May or may not need changes (TBD; will inspect
    next PR).
  * MSGPACK encoding option per-processor once all four typed paths
    are confirmed. HLL is already positioned for a one-line branch:
    `switch p.cfg.Encoding { case "msgpack": dp.SetSketch(hll.SerializeMsgpack()); dp.SetEncoding(pmetric.HLLSketchEncodingMsgpack) }`.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
zzylol added a commit that referenced this pull request Apr 15, 2026
Last of the four processor typed-emission refactors (PR #158:
countmin, PR #159: countsketch, PR #160: hll dead-code cleanup,
this PR: kll). Replaces Gauge-with-byte-attribute emission with
typed `KLLSketchDataPoint` messages so ASAPQuery-backend's
modified-OTLP sketch router sees them as `Metric.data = KLLSketch{...}`
variants instead of anonymous Gauges.

## Why

Before this PR the `TransmitSketch` path called `appendKLLSketchDataPoint`
which emitted:

  dp := metric.Gauge().DataPoints().AppendEmpty()
  dp.Attributes().PutInt("kll.k", int64(k))
  dp.Attributes().PutInt("kll.count", int64(sketch.Count()))
  dp.Attributes().PutEmptyBytes("kll.sketch_payload").FromRaw(payload)
  dp.SetDoubleValue(float64(sketch.Count()))

ASAPQuery-backend's modified-OTLP decoder matches on
`Metric.data = KLLSketch{data_points: [...]}` (oneof tag 14, typed
`KLLSketchDataPoint`). The Rust-side KLL decoder (ASAPQuery PR #8
§KLL, with lossy statistical reconstruction via item replay) was
already wired up, but no processor produced the typed data points
it wanted. The processor and the decoder were both ready for each
other but speaking past each other on the wire.

## What changed

### `processor.go`

  * **Batch path** (around line 226) — `TransmitSketch` branch now
    calls `findOrCreateKLLSketchMetric` (creates a typed
    `pmetric.MetricTypeKLLSketch` metric with
    `AggregationTemporalityDelta`) and `appendTypedKLLSketchDataPoint`
    (writes `SetSketch` / `SetEncoding` / `SetCount` on a typed
    `KLLSketchDataPoint`).

  * **Windowed path** (around line 486) — same two helpers. The
    inline `m.SetEmptyGauge()` is replaced with
    `m.SetEmptyKLLSketch().SetAggregationTemporality(...)`.

  * New helper `findOrCreateKLLSketchMetric` mirrors the existing
    `findOrCreateGaugeMetric` but creates typed KLL metrics and
    matches on `MetricType` so legacy Gauge metrics with the same
    name don't get accidentally reused.

  * New helper `appendTypedKLLSketchDataPoint` replaces the old
    `appendKLLSketchDataPoint`. Writes the sketch payload via
    `SetSketch` and tags the encoding with
    `KLLSketchEncodingProto`. Still carries `kll.k` on the
    attribute map for operator visibility (the typed DP has no
    dedicated setter for it; the Rust side derives k from the
    serialized payload). Sum/Min/Max fields on the typed DP are
    left at zero because sketchlib-go's `KLLSketch` type doesn't
    track them — KLL is quantile-only and the proto fields are
    observability-only.

  * Old `appendKLLSketchDataPoint` function deleted. Old
    `findOrCreateGaugeMetric` retained because the
    non-TransmitSketch quantile-emission path (lines 233-246 and
    503-540) still exports gauge-shaped scalar quantile series.

### `processor_test.go`

`TestBatchMode_TransmitSketch` (lines 68-115) previously asserted
on `m.Gauge().DataPoints().At(0)` and read the payload from the
`kll.sketch_payload` byte attribute. Updated to:

  * Assert `m.Type() == pmetric.MetricTypeKLLSketch`
  * Read the payload from `outDP.Sketch()` directly
  * Assert `outDP.Encoding() == pmetric.KLLSketchEncodingProto`

Other tests in the file (TestBatchModeNoStatePersistence and
below) all target the quantile-emission path
(`TransmitSketch: false`), which still uses Gauge — they're
unaffected.

## Validation

Same pre-existing `go.opentelemetry.io/collector/processor/selfmonitor`
resolution issue as PRs #158/#159/#160 blocks local `go build`.
`gofmt -l` clean on both modified files. All API methods used
(`pmetric.MetricTypeKLLSketch`, `SetEmptyKLLSketch`,
`KLLSketch().DataPoints().AppendEmpty()`, `SetSketch`,
`SetEncoding`, `SetCount`, `KLLSketchEncodingProto`) already
exist on the pmetric patch.

## Stack

  * PR #158 (merged) — countminsketchprocessor typed emission
  * PR #159 — countsketchprocessor typed emission
  * PR #160 — hllprocessor dead-code cleanup + broken-test fix
  * **This PR** — kllprocessor typed emission
  * Next — per-processor MSGPACK config option (one-line branch
    each, calling sketchlib-go `SerializeMsgpack` from PR #51 and
    setting `*SketchEncodingMsgpack` from PR #157). Note: for KLL
    specifically, sketchlib-go #50/#51 out-of-scope'd the msgpack
    wire format because sketchlib-go's KLL and sketch-core's KLL
    don't share a byte-level backend — so KLL producers should
    keep using `_ENCODING_PROTO`. The MSGPACK enum value in PR
    #157 is reserved but not usable for KLL today.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@zzylol
zzylol merged commit 0adfe9f into main Apr 15, 2026
@zzylol
zzylol deleted the feat/hll-typed-datapoint branch April 15, 2026 20:55
zzylol added a commit that referenced this pull request Apr 15, 2026
Last of the four processor typed-emission refactors (PR #158:
countmin, PR #159: countsketch, PR #160: hll dead-code cleanup,
this PR: kll). Replaces Gauge-with-byte-attribute emission with
typed `KLLSketchDataPoint` messages so ASAPQuery-backend's
modified-OTLP sketch router sees them as `Metric.data = KLLSketch{...}`
variants instead of anonymous Gauges.

## Why

Before this PR the `TransmitSketch` path called `appendKLLSketchDataPoint`
which emitted:

  dp := metric.Gauge().DataPoints().AppendEmpty()
  dp.Attributes().PutInt("kll.k", int64(k))
  dp.Attributes().PutInt("kll.count", int64(sketch.Count()))
  dp.Attributes().PutEmptyBytes("kll.sketch_payload").FromRaw(payload)
  dp.SetDoubleValue(float64(sketch.Count()))

ASAPQuery-backend's modified-OTLP decoder matches on
`Metric.data = KLLSketch{data_points: [...]}` (oneof tag 14, typed
`KLLSketchDataPoint`). The Rust-side KLL decoder (ASAPQuery PR #8
§KLL, with lossy statistical reconstruction via item replay) was
already wired up, but no processor produced the typed data points
it wanted. The processor and the decoder were both ready for each
other but speaking past each other on the wire.

## What changed

### `processor.go`

  * **Batch path** (around line 226) — `TransmitSketch` branch now
    calls `findOrCreateKLLSketchMetric` (creates a typed
    `pmetric.MetricTypeKLLSketch` metric with
    `AggregationTemporalityDelta`) and `appendTypedKLLSketchDataPoint`
    (writes `SetSketch` / `SetEncoding` / `SetCount` on a typed
    `KLLSketchDataPoint`).

  * **Windowed path** (around line 486) — same two helpers. The
    inline `m.SetEmptyGauge()` is replaced with
    `m.SetEmptyKLLSketch().SetAggregationTemporality(...)`.

  * New helper `findOrCreateKLLSketchMetric` mirrors the existing
    `findOrCreateGaugeMetric` but creates typed KLL metrics and
    matches on `MetricType` so legacy Gauge metrics with the same
    name don't get accidentally reused.

  * New helper `appendTypedKLLSketchDataPoint` replaces the old
    `appendKLLSketchDataPoint`. Writes the sketch payload via
    `SetSketch` and tags the encoding with
    `KLLSketchEncodingProto`. Still carries `kll.k` on the
    attribute map for operator visibility (the typed DP has no
    dedicated setter for it; the Rust side derives k from the
    serialized payload). Sum/Min/Max fields on the typed DP are
    left at zero because sketchlib-go's `KLLSketch` type doesn't
    track them — KLL is quantile-only and the proto fields are
    observability-only.

  * Old `appendKLLSketchDataPoint` function deleted. Old
    `findOrCreateGaugeMetric` retained because the
    non-TransmitSketch quantile-emission path (lines 233-246 and
    503-540) still exports gauge-shaped scalar quantile series.

### `processor_test.go`

`TestBatchMode_TransmitSketch` (lines 68-115) previously asserted
on `m.Gauge().DataPoints().At(0)` and read the payload from the
`kll.sketch_payload` byte attribute. Updated to:

  * Assert `m.Type() == pmetric.MetricTypeKLLSketch`
  * Read the payload from `outDP.Sketch()` directly
  * Assert `outDP.Encoding() == pmetric.KLLSketchEncodingProto`

Other tests in the file (TestBatchModeNoStatePersistence and
below) all target the quantile-emission path
(`TransmitSketch: false`), which still uses Gauge — they're
unaffected.

## Validation

Same pre-existing `go.opentelemetry.io/collector/processor/selfmonitor`
resolution issue as PRs #158/#159/#160 blocks local `go build`.
`gofmt -l` clean on both modified files. All API methods used
(`pmetric.MetricTypeKLLSketch`, `SetEmptyKLLSketch`,
`KLLSketch().DataPoints().AppendEmpty()`, `SetSketch`,
`SetEncoding`, `SetCount`, `KLLSketchEncodingProto`) already
exist on the pmetric patch.

## Stack

  * PR #158 (merged) — countminsketchprocessor typed emission
  * PR #159 — countsketchprocessor typed emission
  * PR #160 — hllprocessor dead-code cleanup + broken-test fix
  * **This PR** — kllprocessor typed emission
  * Next — per-processor MSGPACK config option (one-line branch
    each, calling sketchlib-go `SerializeMsgpack` from PR #51 and
    setting `*SketchEncodingMsgpack` from PR #157). Note: for KLL
    specifically, sketchlib-go #50/#51 out-of-scope'd the msgpack
    wire format because sketchlib-go's KLL and sketch-core's KLL
    don't share a byte-level backend — so KLL producers should
    keep using `_ENCODING_PROTO`. The MSGPACK enum value in PR
    #157 is reserved but not usable for KLL today.

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant