Skip to content

Commit ca4d6c1

Browse files
authored
Doc enhancement for eventstats and bin command (opensearch-project#4117)
* distinct_count doc for eventstats Signed-off-by: Kai Huang <ahkcs@amazon.com> * doc enhancement Signed-off-by: Kai Huang <ahkcs@amazon.com> * add fields for consistency between different Java versions Signed-off-by: Kai Huang <ahkcs@amazon.com> * remove changes Signed-off-by: Kai Huang <ahkcs@amazon.com> * add bin to index.rst Signed-off-by: Kai Huang <ahkcs@amazon.com> * add link Signed-off-by: Kai Huang <ahkcs@amazon.com> * fix Signed-off-by: Kai Huang <ahkcs@amazon.com> --------- Signed-off-by: Kai Huang <ahkcs@amazon.com>
1 parent 9f1ee08 commit ca4d6c1

3 files changed

Lines changed: 11 additions & 1 deletion

File tree

docs/user/ppl/cmd/bin.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ bin
99
:depth: 2
1010

1111

12+
.. note::
13+
14+
Available since version 3.3
15+
16+
1217
Description
1318
============
1419
| The ``bin`` command groups numeric values into buckets of equal intervals, making it useful for creating histograms and analyzing data distribution. It takes a numeric field and generates a new field with values that represent the lower bound of each bucket.

docs/user/ppl/cmd/eventstats.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -283,7 +283,10 @@ DISTINCT_COUNT, DC(Since 3.3)
283283
Description
284284
>>>>>>>>>>>
285285

286-
Usage: DISTINCT_COUNT(expr), DC(expr). Returns the approximate number of distinct values of expr using HyperLogLog++ algorithm. Both ``DISTINCT_COUNT`` and ``DC`` are equivalent and provide the same functionality.
286+
Usage: DISTINCT_COUNT(expr), DC(expr). Returns the approximate number of distinct values using the HyperLogLog++ algorithm. Both functions are equivalent.
287+
288+
For details on algorithm accuracy and precision control, see the `OpenSearch Cardinality Aggregation documentation <https://docs.opensearch.org/latest/aggregations/metric/cardinality/#controlling-precision>`_.
289+
287290

288291
Example::
289292

docs/user/ppl/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@ The query start with search command and then flowing a set of command delimited
5454

5555
- `appendcol command <cmd/appendcol.rst>`_
5656

57+
- `bin command <cmd/bin.rst>`_
58+
5759
- `dedup command <cmd/dedup.rst>`_
5860

5961
- `describe command <cmd/describe.rst>`_

0 commit comments

Comments
 (0)