Skip to content

Commit 7ac53a8

Browse files
committed
Add troubleshooting info to Usage and Billing page
Turn the section on validating usage data into the intro paragraph for a troubleshooting section. We don't actually need to compare the usage reporting system to audit events, and removing the comparison makes this information concise enough for an introductory paragraph. Add H2s for issues we have identified with usage reporting and billing on self-hosted clusters.
1 parent 039e83e commit 7ac53a8

File tree

1 file changed

+52
-19
lines changed

1 file changed

+52
-19
lines changed

docs/pages/usage-billing.mdx

Lines changed: 52 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -64,25 +64,6 @@ Set the `TELEPORT_REPORTING_HTTPS_PROXY` and `TELEPORT_REPORTING_HTTP_PROXY`
6464
environment variables to your proxy address. That will apply as the HTTP connect
6565
proxy setting overriding `HTTPS_PROXY` and `HTTP_PROXY` just for outbound usage reporting.
6666

67-
### Validating usage reports
68-
69-
The system that Teleport uses for submitting usage reports is independent of the
70-
system that Teleport uses for submitting audit events.
71-
72-
Teleport processes submit audit events to the Teleport Auth Service, which
73-
stores them on its audit event backend for retrieval by Teleport API clients. In
74-
contrast, usage reports are aggregated on a submission service that runs either
75-
on self-hosted Teleport infrastructure or Teleport Cloud, depending on the
76-
user's plan. The submission service persists usage reports in the case of a
77-
submission failure. After a successful submission, the submission service
78-
deletes the reports.
79-
80-
It is not possible for Teleport users to independently validate usage event
81-
data, as there is no way to set up a third-party usage event destination or
82-
retrieve usage events from a Teleport backend. Reach out to
83-
support@goteleport.com if you have questions about usage reporting on your
84-
Teleport account.
85-
8667
## Billing metrics
8768

8869
Teleport uses the anonymized usage data described in the previous section to
@@ -144,6 +125,11 @@ to compute a daily TPR. Then we average the daily TPR over a monthly period,
144125
which starts on the subscription start date and ends on each monthly anniversary
145126
thereafter.
146127

128+
If you recreate a single resource more than once an hour, this will affect the
129+
hourly average. For example, if were to create then delete 10 servers three
130+
times in one hour, Teleport would display 10 servers at any given time. However,
131+
for the entire hour, Teleport would report 30 protected servers.
132+
147133
## Usage measurement for billing
148134

149135
We aggregate all counts of the billing metrics on a monthly basis starting on
@@ -155,3 +141,50 @@ Subscription, also known as a high water mark calculation.
155141

156142
Reach out to sales@goteleport.com if you have questions about the
157143
commercial editions of Teleport.
144+
145+
## Troubleshooting usage and billing
146+
147+
Teleport aggregates usage reports on a submission service that runs either on
148+
self-hosted Teleport infrastructure or Teleport Cloud, depending on the user's
149+
plan. The submission service persists usage reports in the case of a submission
150+
failure, and deletes the reports after a successful submission. It is not
151+
possible to set up a third-party destination for usage events to independently
152+
verify usage event data.
153+
154+
If you are using Teleport Enterprise (Cloud), your usage data is accurate as
155+
long as Teleport-managed reporting infrastructure works as expected (check the
156+
[status page](https://status.teleport.sh/) for any incidents). On self-hosted
157+
Teleport Enterprise clusters, some conditions can interfere with data reporting.
158+
This section describes some scenarios that can lead to inaccurate data on
159+
self-hosted clusters.
160+
161+
If you suspect that any of these scenarios describe your Teleport cluster, or
162+
your usage data appears inaccurate, reach out to support@goteleport.com.
163+
164+
### Multiple Teleport clusters
165+
166+
In versions older than v14.3.1, Teleport does not de-duplicate users as expected
167+
across multiple Teleport clusters that belong to the same account. If you are
168+
running multiple Teleport clusters with affected versions, the count of active
169+
users may be higher than expected.
170+
171+
### Unexpected license differences
172+
173+
When distributing copies of your Teleport Enterprise (Self-Hosted) license
174+
across Auth Service instances, you must not download a license multiple times
175+
from your Teleport account. Instead, you must download a license once and copy
176+
that license across Auth Service instances. Otherwise, the Teleport usage
177+
reporting infrastructure will identify multiple licenses and misrepresent your
178+
usage numbers.
179+
180+
### SSO users
181+
182+
In Teleport, single sign-on (SSO) users are
183+
[ephemeral](reference/user-types.mdx#temporary-users). Teleport deletes an SSO user
184+
when its session expires. To count the number of SSO users in your cluster, you
185+
can examine Teleport audit events for unique SSO users that have authenticated
186+
to Teleport during a given time period. The Teleport documentation includes
187+
[how-to guides](./admin-guides/management/export-audit-events/export-audit-events.mdx) for
188+
exporting audit events to common log management solutions so you can identify
189+
users that have authenticated using an SSO provider.
190+

0 commit comments

Comments
 (0)