From 81b4f9ab73fab1c243e0c6499ec8f3c819b1c4db Mon Sep 17 00:00:00 2001 From: Smittyvb Date: Thu, 9 Feb 2023 13:04:42 -0500 Subject: [PATCH 1/2] Removed outdated get_telemetry_report param Signed-off-by: Smittyvb --- api/get_telemetry_report.md | 19 +++---------------- 1 file changed, 3 insertions(+), 16 deletions(-) diff --git a/api/get_telemetry_report.md b/api/get_telemetry_report.md index 926a32abab..308c01c4f6 100644 --- a/api/get_telemetry_report.md +++ b/api/get_telemetry_report.md @@ -11,28 +11,15 @@ api: # get_telemetry_report() -If background [telemetry][telemetry] is enabled, returns the string sent to our servers. -If telemetry is not enabled, outputs INFO message affirming telemetry is disabled -and returns a NULL report. - -### Optional arguments - -|Name|Type|Description| -|---|---| -| `always_display_report` | BOOLEAN | Set to true to always view the report, even if telemetry is disabled | +Returns the background [telemetry][telemetry] string sent to our servers +(or that would be, if telemetry is disabled). ### Sample usage -If telemetry is enabled, view the telemetry report. +View the telemetry report. ```sql SELECT get_telemetry_report(); ``` -If telemetry is disabled, view the telemetry report locally. - -```sql -SELECT get_telemetry_report(always_display_report := true); -``` - [telemetry]: /timescaledb/:currentVersion:/how-to-guides/configuration/telemetry From 240f45cbb001a49678d70644104f6861fe578b6e Mon Sep 17 00:00:00 2001 From: Smitty Date: Fri, 10 Feb 2023 15:13:40 -0500 Subject: [PATCH 2/2] Apply suggestions from review Co-authored-by: Lana Brindley Signed-off-by: Smittyvb --- api/get_telemetry_report.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/api/get_telemetry_report.md b/api/get_telemetry_report.md index 308c01c4f6..1c9727c9d2 100644 --- a/api/get_telemetry_report.md +++ b/api/get_telemetry_report.md @@ -11,12 +11,13 @@ api: # get_telemetry_report() -Returns the background [telemetry][telemetry] string sent to our servers -(or that would be, if telemetry is disabled). +Returns the background [telemetry][telemetry] string sent to Timescale +servers. If telemetry is disabled, it sends the string that would be sent +if telemetry was enabled. ### Sample usage -View the telemetry report. +View the telemetry report: ```sql SELECT get_telemetry_report();