Skip to content

Commit

Permalink
Add METRICS_COLLECTION markdown file
Browse files Browse the repository at this point in the history
  • Loading branch information
peter-rr committed Jan 18, 2024
1 parent d57655b commit 16a38a5
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions METRICS_COLLECTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Metrics collection guideline

AsyncAPI CLI collects **anonymous metrics** .
You can find examples of the metrics we collect [here]() an [there]().
You can always disable this by setting the environment variable BLABLA to false.

'AsyncAPI anonymously tracks command executions to improve the specification and tools, ensuring no sensitive data reaches our servers. It aids in comprehending how AsyncAPI tools are used and adopted, facilitating ongoing improvements to our specifications and tools.

## What we collect
We are collecting the following metrics:

- asyncapi_adoption.action.invoked

- asyncapi_adoption.action.executed


## Where we collect
...

## How to disable tracking
To disable tracking, set the "ASYNCAPI_METRICS" env variable to "false" when executing the command. For instance: `ASYNCAPI_METRICS=false asyncapi validate <spec-file-path>`

Remember that keeping this tracking enabled will help AsyncAPI community to provide better specifications and tools in the future.

0 comments on commit 16a38a5

Please sign in to comment.