Skip to content

Removed outdated get_telemetry_report param #2022

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
syvb merged 4 commits into from
Feb 14, 2023
Merged

Removed outdated get_telemetry_report param #2022

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
81b4f9a
Removed outdated get_telemetry_report param
syvb Feb 9, 2023
240f45c
Apply suggestions from review
syvb Feb 10, 2023
aa077a8
Merge branch 'latest' into sv/rm-old-get_telemetry_report-param
Loquacity Feb 12, 2023
aeae43d
Merge branch 'latest' into sv/rm-old-get_telemetry_report-param
syvb Feb 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 4 additions & 16 deletions api/get_telemetry_report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,28 +11,16 @@ 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 Timescale
servers. If telemetry is disabled, it sends the string that would be sent
if telemetry was enabled.

### 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