Skip to content

Add a Usage Reporting and Billing page#34254

Merged
ptgott merged 3 commits intomasterfrom
paul.gottschling/34220-usage
Nov 8, 2023
Merged

Add a Usage Reporting and Billing page#34254
ptgott merged 3 commits intomasterfrom
paul.gottschling/34220-usage

Conversation

@ptgott
Copy link
Copy Markdown
Contributor

@ptgott ptgott commented Nov 6, 2023

Closes #34220

Add a docs page to the Home section that describes the way we calculate customer usage data and billing for commercial editions of Teleport.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Nov 6, 2023

The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with changelog: followed by the changelog entries for the PR.

@zmb3 zmb3 requested review from espadolini and timothyb89 November 6, 2023 16:30
@ptgott ptgott added backport/branch/v12 no-changelog Indicates that a PR does not require a changelog entry labels Nov 6, 2023
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Nov 6, 2023

🤖 Vercel preview here: https://docs-33au27086-goteleport.vercel.app/docs/ver/preview

@bl-nero
Copy link
Copy Markdown
Contributor

bl-nero commented Nov 6, 2023

I took a look per @zmb3 's request; no comments from my side.

Comment thread docs/pages/usage-billing.mdx Outdated
Comment thread docs/pages/usage-billing.mdx Outdated
Comment on lines 17 to 18
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is only accurate for on-prem, since all Cloud versions of Teleport will send individual anonymized events when they happen rather than aggregating them in counts.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How should this be corrected then?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not quite sure how we should word it - especially since usage events on Cloud are actually more extended than just the ones that we use for billing - but the gist is that in Cloud we keep an anonymized log of each individual "billing" event when it happens and then we count and sum over the billing period, whereas for on-prem (only Enterprise, currently) the Teleport cluster does a first aggregation step on a 15-min basis and we receive the pre-aggregated counts of events per user, which we then count or sum over the billing period.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, @ptgott can we just change "a count" to "an anonymized log"?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How important is it to customers that we describe the precise nature of the data, i.e., whether we aggregate it on the Teleport Cloud infra vs. whether it comes pre-aggregated from the customer's Teleport deployment? If it's important to specify, it looks like "anonymized log" is only accurate for Teleport Cloud.

I'll suggest:

- For each Teleport user, the anonymized user name and a count of interactions
 with infrastructure resources enrolled in your Teleport cluster. 

Self-hosted Teleport deployments aggregate interaction data before it reaches Teleport Cloud. 
Teleport Cloud accounts provide this information as an anonymized log, which 
Teleport aggregates over the billing period.

Comment thread docs/pages/usage-billing.mdx Outdated
Comment on lines 30 to 37
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bl-nero when we get to the implementation of RFD 0014e we should update this to mention that the HMAC key might be in the license file instead.

@twakes
Copy link
Copy Markdown
Contributor

twakes commented Nov 6, 2023

This looks good to me. I'm not sure how to address @espadolini comment about roll-ups but once it is it can be deployed.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Nov 7, 2023

🤖 Vercel preview here: https://docs-b260h5fyd-goteleport.vercel.app/docs/ver/preview

Copy link
Copy Markdown
Contributor

@twakes twakes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ptgott ptgott force-pushed the paul.gottschling/34220-usage branch from 290035e to 36724f7 Compare November 7, 2023 20:09
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Nov 7, 2023

🤖 Vercel preview here: https://docs-3mzvxbgvd-goteleport.vercel.app/docs/ver/preview

Comment thread docs/pages/usage-billing.mdx Outdated
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Nov 7, 2023

🤖 Vercel preview here: https://docs-lo3qyodvb-goteleport.vercel.app/docs/ver/preview

@ptgott ptgott force-pushed the paul.gottschling/34220-usage branch from 4ea8a2e to 379fe19 Compare November 7, 2023 22:31
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Nov 7, 2023

🤖 Vercel preview here: https://docs-12i0rsexh-goteleport.vercel.app/docs/ver/preview

@ptgott ptgott force-pushed the paul.gottschling/34220-usage branch from 379fe19 to 4c0aecb Compare November 7, 2023 22:54
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Nov 7, 2023

🤖 Vercel preview here: https://docs-mt8onzbe9-goteleport.vercel.app/docs/ver/preview

@ptgott ptgott force-pushed the paul.gottschling/34220-usage branch from 4c0aecb to 5011d77 Compare November 8, 2023 15:20
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Nov 8, 2023

🤖 Vercel preview here: https://docs-h3pbk4e0t-goteleport.vercel.app/docs/ver/preview

ptgott and others added 3 commits November 8, 2023 15:02
Closes #34220

Add a docs page to the Home section that describes the way we calculate
customer usage data and billing for commercial editions of Teleport.
- Remove specific edition names
- Clarify counts
Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
@ptgott ptgott force-pushed the paul.gottschling/34220-usage branch from 5011d77 to 212aabc Compare November 8, 2023 20:02
@ptgott ptgott added this pull request to the merge queue Nov 8, 2023
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Nov 8, 2023

🤖 Vercel preview here: https://docs-5jva7utw8-goteleport.vercel.app/docs/ver/preview

Merged via the queue into master with commit 33bf6f0 Nov 8, 2023
@ptgott ptgott deleted the paul.gottschling/34220-usage branch November 8, 2023 20:20
@public-teleport-github-review-bot
Copy link
Copy Markdown

@ptgott See the table below for backport results.

Branch Result
branch/v12 Create PR
branch/v13 Create PR
branch/v14 Create PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation no-changelog Indicates that a PR does not require a changelog entry size/sm

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document usage reporting and billing metric calculations

5 participants