Skip to content

Commit

Permalink
Update docs about Countly being shut down (#134)
Browse files Browse the repository at this point in the history
* Update README.md about Countly being shut down

This is in support of the Countly account shutdown discussed in #133

* Update README.md
* Update COLLECTION_POLICY.md
* Update FAQs.md
  • Loading branch information
BigLep authored Feb 1, 2024
1 parent 56e3c88 commit 898ca62
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@

> UI library for gathering metrics for ignite team projects
# ❗️ Attention: metrics are not being stored ❗️ <!-- omit in toc -->
As of 2024-02-18, the backend service account with Countly that was used for collecting data from ignite-metrics has been deactivated. Data is still being POSTed, but our previous 3rd-party vendor, Countly, is dropping it. We have a backlog item in [issue #133](https://github.com/ipfs-shipyard/ignite-metrics/issues/133) to move to an alternative service, Plausible.

## Table of contents <!-- omit in toc -->

- [Install](#install)
Expand Down
3 changes: 3 additions & 0 deletions docs/telemetry/COLLECTION_POLICY.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ For an up to date list of projects we own that follow this policy, please see:
* https://github.com/ipfs/ipfs-gui#primary-projects
* https://github.com/ipfs/ipfs-gui#other-ipfs-gui--tools-owned-projects

## ❗️ Attention: metrics are not being stored ❗️
As of 2024-02-18, the backend service account with Countly that was used for collecting data from ignite-metrics has been deactivated. Data is still being POSTed, but our previous 3rd-party vendor, Countly, is dropping it. We have a backlog item in [issue #133](https://github.com/ipfs-shipyard/ignite-metrics/issues/133) to move to an alternative service, Plausible.

## History

Before 2022Q4, telemetry was only implemented in https://github.com/ipfs/ipfs-webui and https://github.com/ipfs/ipfs-desktop, using our [self-hosted countly](https://count.ly/product) server. The telemetry implemented within ipfs-webui and ipfs-desktop was opt-in only. i.e. metrics data was sent only if a user specifically opted-in to collecting metrics.
Expand Down
5 changes: 5 additions & 0 deletions docs/telemetry/FAQs.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# FAQs - Frequently asked questions

## Are metrics being stored?
As of 2024-02-18, the backend service account with Countly that was used for collecting data from ignite-metrics has been deactivated. Data is still being POSTed, but our previous 3rd-party vendor, Countly, is dropping it. We have a backlog item in [issue #133](https://github.com/ipfs-shipyard/ignite-metrics/issues/133) to move to an alternative service, Plausible.

One could still use this library as is and pass in an API key with their own Countly account, but the APIs keys for the apps/sites listed in [issue #133](https://github.com/ipfs-shipyard/ignite-metrics/issues/133) have been disabled.

## Why are you collecting metrics?

We are collecting metrics for all of our projects to assist with prioritizing work and provide proof that our work is valuable. Our prior state (<2023) had the following issues:
Expand Down

0 comments on commit 898ca62

Please sign in to comment.