Skip to content

Commit

Permalink
feat(docs): Document telemetry endpoint (#1008)
Browse files Browse the repository at this point in the history
Signed-off-by: Javier Rodriguez <javier@chainloop.dev>
  • Loading branch information
javirln committed Jun 21, 2024
1 parent 4801f98 commit 0d44596
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
4 changes: 4 additions & 0 deletions docs/docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,7 @@ That said, there are [benefits](/reference/operator/contract#runner-context) for
#### Does Chainloop store my Artifacts and Attestation metadata?

No. They are stored in [your Content-Addressable Storage (CAS)](/reference/operator/cas-backend).

#### Our firewall is flagging a request to crb.chainloop.dev, what's this?

That is our telemetry endpoint. We collect telemetry data to help us enhance Chainloop by gaining insights into its usage. You can learn more about it and even how to deactivate it [here](reference/operator/cli-telemetry.mdx#what-do-we-use-to-collect-telemetry-data).
3 changes: 2 additions & 1 deletion docs/docs/reference/operator/cli-telemetry.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,11 @@ The following information is included in telemetry:

Chainloop implements the Console [Do Not Track (DNT) standard](https://consoledonottrack.com). As a result, you can deactivate the telemetry by setting the environment variable DO_NOT_TRACK=1 before running the Chainloop CLI.


## What do we use to collect telemetry data?

We use [PostHog](https://posthog.com/). PostHog is an open-source product analytics platform that allows us to collect and analyze telemetry data.
All telemetry data is stored in our PostHog instance sent via the following endpoint: `https://crb.chainloop.dev`.

We did it in such a way that anyone can set up their own PostHog instance and use it to collect telemetry. To do so
compile Chainloop CLI from its source code and set up the following linker flags to the Golang compiler:

Expand Down

0 comments on commit 0d44596

Please sign in to comment.