Skip to content
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.

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

Docs updates for usage stats #3393

Open
wants to merge 20 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Binary file added astro/public/img/docs/stats-admin-facloud.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added astro/public/img/docs/stats-admin-self.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added astro/public/img/docs/stats-setup-facloud.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added astro/public/img/docs/stats-setup-self.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
558 changes: 558 additions & 0 deletions astro/src/content/docs/_shared/_collected-metrics.mdx

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: Collected Metrics
description: Learn what data FusionAuth collects and how it is used.
section: get started
subcategory: download and install
nestedHeadings: true
---
import CollectedMetrics from 'src/content/docs/_shared/_collected-metrics.mdx';
import * as metrics from 'src/content/docs/_shared/_collected-metrics.mdx';

export const headings = metrics.getHeadings();

<CollectedMetrics />
Original file line number Diff line number Diff line change
Expand Up @@ -151,19 +151,6 @@ If you are in a firewalled or restricted environment and have a paid plan, add t

### Collected Metrics

Currently FusionAuth sends a payload to the metrics endpoint for all instances.
Currently FusionAuth sends a payload to the metrics endpoint for all instances. A self-hosted community user can disable network egress or block access to the metrics endpoint without affecting functionality. Customers on a paid plan must allow a metrics connection [per the license agreement](/license), unless they have an air-gapped license.

Collected metrics include:

* a unique instance identifier
* the total number of users
* the total number of monthly active users
* the total number of monthly logins
* the number of nodes in the instance
* the product version
* the license Id (only for licensed instances with a plan)
* the version of the metrics data (currently always version 1)

A self-hosted community user can disable network egress or block access to the metrics endpoint without affecting functionality.

Customers on a paid plan must allow a metrics connection [per the license agreement](/license), unless they have an air-gapped license.
To learn more about what metrics we collect and how they are used, view the [collected metrics documentation](/docs/get-started/download-and-install/collected-metrics).
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Collected Metrics
description: Learn what data FusionAuth collects and how it is used.
canonicalUrl: /docs/get-started/download-and-install/collected-metrics
section: get started
subcategory: run in the cloud
nestedHeadings: true
---
import CollectedMetrics from 'src/content/docs/_shared/_collected-metrics.mdx';
import * as metrics from 'src/content/docs/_shared/_collected-metrics.mdx';

export const headings = metrics.getHeadings();

<CollectedMetrics />
10 changes: 10 additions & 0 deletions config/vale/styles/config/vocabularies/FusionAuth/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -637,12 +637,14 @@ anbraten
ange
apikey|ApiKey
applicationI[Dd]
applicationNumber
architected
architecting
arg
aspnetcore|AspNetCore
astro
asynchrony
atdCaptcha
athleisure
audiobooks
auditable
Expand Down Expand Up @@ -750,6 +752,7 @@ emailConfiguration
emailTemplate
enpdpoint
entityType
entitiesNumber
enum
errors_message
esign
Expand All @@ -763,6 +766,7 @@ ey
facto
failover
falogins
failsafe
fastpath|FastPath
fav
favicon
Expand Down Expand Up @@ -832,6 +836,7 @@ influencer
influencers
infographic
initializer
instanceNodes
integratable
intercorporate
interoperate
Expand Down Expand Up @@ -869,6 +874,8 @@ masse
meatspace
menubar
messageTemplate
messengersGeneric
messengersKafka
meta_key
meta_value
midwest
Expand Down Expand Up @@ -989,6 +996,7 @@ sanitization
satisify
scaffolded
scalably
scimEnabled
scopeDescription
screencap
scriptage
Expand All @@ -1013,6 +1021,7 @@ spammy
ssh's
standarized
startRow
statsVersion
stdout
stringifies
stringify
Expand All @@ -1032,6 +1041,7 @@ systemd
techcentric
telcos
telehealth
tenantNumber
tesserarius
textarea
thegrugq
Expand Down