> For the complete documentation index, see [llms.txt](https://docs.fractalworks.io/joule/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.fractalworks.io/joule/components/analytics/analytic-tools/advanced-analytics/hyperloglog.md).

# HyperLogLog

## Overview

HyperLogLog processor provides an implementation is an algorithm for the count-distinct problem, approximating the number of distinct elements in a multiset.

Calculating the exact cardinality of the distinct elements of a multiset requires an amount of memory proportional to the cardinality, which is impractical for very large data sets.

## Example & DSL attributes

```yaml
hyperloglog:
  name: distinctIMSICounter
  hash type: HASH64
  log2m: 3
  registry width: 3
  fields:
    - imsi
```

### Response

The processor adds a `distinctIMSICounter` attribute with the following result

```
distinctIMSICounter:
  505010000011111 : 101
  904130454090869 : 78
```

### Attributes schema

<table><thead><tr><th width="193">Attribute</th><th width="217">Description</th><th width="219">Data Type</th><th data-type="checkbox">Required</th></tr></thead><tbody><tr><td>name</td><td>name of the counter</td><td>String</td><td>true</td></tr><tr><td>hash type</td><td><p>Hashing algorithm to be applied to event field.</p><p></p><p>Supported types:</p><p>DEFAULT (object hashcode), HASH32, HASH64</p></td><td><p>Long</p><p>Default: DEFAULT</p></td><td>false</td></tr><tr><td>log2m</td><td>the number of probabilistic HLL registers</td><td><p>Integer</p><p>Default: 11</p></td><td>false</td></tr><tr><td>registry width</td><td><p>The size (width) each register in bits. Supported range between 1 to 8 bits.</p><p></p></td><td><p>Integer</p><p>Default: 5</p></td><td>false</td></tr><tr><td>fields</td><td>List of fields to perform distinct counts</td><td>List</td><td>true</td></tr></tbody></table>

## Additional Information

* Article about [HyperLogLog](https://en.wikipedia.org/wiki/HyperLogLog) for more information


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.fractalworks.io/joule/components/analytics/analytic-tools/advanced-analytics/hyperloglog.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
