feat: anonymous telemetry #423
Conversation
embedchain/config/apps/AppConfig.py
Outdated
| @@ -16,14 +16,15 @@ class AppConfig(BaseAppConfig): | |||
| Config to initialize an embedchain custom `App` instance, with extra config options. | |||
| """ | |||
|
|
|||
| def __init__(self, log_level=None, host=None, port=None, id=None, collection_name=None): | |||
| def __init__(self, log_level=None, host=None, port=None, id=None, collection_name=None, anonymous_telemetry=None): | |||
There was a problem hiding this comment.
note for future: we should have a master class for app config from which AppConfig, OpenSourceConfig and CustomAppConfig can inherit.
There was a problem hiding this comment.
can leave this for now, but @cachho can you open an issue for future?
There was a problem hiding this comment.
I think you should do it, because you know exactly what you want and I dont.
embedchain/config/apps/AppConfig.py
Outdated
| @@ -32,6 +33,7 @@ def __init__(self, log_level=None, host=None, port=None, id=None, collection_nam | |||
| port=port, | |||
| id=id, | |||
| collection_name=collection_name, | |||
| anonymous_telemetry=anonymous_telemetry, | |||
There was a problem hiding this comment.
lets call this flag as collect_metrics
reasoning: "Metrics" is a broad term that can encompass various kinds of quantitative data. "Collect" explicitly describes the action of gathering data, making the purpose of the flag straightforward. we want to use this metrics to improve our package and everything will be anonymized.
|
also tackles #109 now, by returning values from |
|
assumes the use of #320. Otherwise, telemetry for |
| @@ -10,6 +10,7 @@ title: '🔍 Query configurations' | |||
| | embedding_fn| embedding function | chromadb.utils.embedding_functions | \{text-embedding-ada-002\} | | |||
| | db | vector database (experimental) | BaseVectorDB | ChromaDB | | |||
| | collection_name | initial collection name for the database | string | embedchain_store | | |||
| | collection_metrics | collect anonymous telemetry data to improve embedchain | boolean | true | | |||
There was a problem hiding this comment.
it should be collect_metrics in the first column.
Description
adds asynchronous anonymous telemetry
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
Please delete options that are not relevant.
Checklist:
Maintainer Checklist