From 5cafab6c99426d5f12ec0522ea31103f0043f6b6 Mon Sep 17 00:00:00 2001
From: sgoral-splunk <138458044+sgoral-splunk@users.noreply.github.com>
Date: Wed, 21 Aug 2024 11:11:45 +0200
Subject: [PATCH] docs: update of documentation regarding the monitoring
 dashboard (#1318)

**Issue
number:[ADDON-72792](https://splunk.atlassian.net/browse/ADDON-72792)**

## Summary

Update of documentation regarding the monitoring dashboard.

### Changes

Added information about "all time" issue for overview section.
Added information about new optional parameter `license_usage_source` in
the solnlib lib in version 5.2

### User experience

Better documentation.

## Checklist

If your change doesn't seem to apply, please leave them unchecked.

* [x] I have performed a self-review of this change
* [x] Changes have been tested
* [x] Changes are documented
* [x] PR title follows [conventional commit
semantics](https://www.conventionalcommits.org/en/v1.0.0/)
---
 docs/dashboard.md | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

diff --git a/docs/dashboard.md b/docs/dashboard.md
index 2a1fccdbd..5676baa07 100644
--- a/docs/dashboard.md
+++ b/docs/dashboard.md
@@ -21,10 +21,15 @@ As of now, 4 pre-built panels are supported:
 * Errors in the add-on.
 * Resource consumption.
 
-**IMPORTANT**: To fully use the panels available on the monitoring dashboard, use the `solnlib.log`'s [`events_ingested` function](https://github.com/splunk/addonfactory-solutions-library-python/blob/v5.2.0/solnlib/log.py#L280), to record events.
+**IMPORTANT**:
+
+* To fully use the panels available on the monitoring dashboard, use the `solnlib.log`'s [`events_ingested` function](https://github.com/splunk/addonfactory-solutions-library-python/blob/v5.2.0/solnlib/log.py#L280), to record events.
 Due to some changes in dashboard queries in UCC version **5.49.0**, you must use `solnlib` in at least version **5.2.0**.
+* Sometimes, especially with a short data collection period, the first chart in the overview section may not display data when the **all time** period is selected.
+This is because the `join` function used to aggregate data volume and number of ingested events does not have a default **span** for the **all time** range.
+Over time, the problem should automatically disappear.
 
-The above function takes 5 positional parameters which are:
+The above `events_ingested` function takes 5 positional parameters which are:
 
 * `logger`
 * `modular_input_name`
@@ -36,10 +41,15 @@ and 2 optional named parameters:
 
 * `account`
 * `host`
+* `license_usage_source` (available from version 5.2)
 
 If you additionally provide `account` and `host` arguments - you will get a better visibility in your dashboard.
 Please note that as a `modular_input_name` you should pass the full input in the format: **`demo_input://my_input_1`**.
 
+If for your add-on `license usage` file writes data in a source format that doesn't fit the above, the `events_ingested` function in **solnlib v5.2**
+has an additional, optional parameter `license_usage_source` that allows for proper data correlation
+between license usage and data written by the `events_ingested` function.
+
 Example of an `events_ingested` function:
 
 ```python