Skip to content

Commit

Permalink
docs: add telemetry report claim
Browse files Browse the repository at this point in the history
  • Loading branch information
moonrailgun committed Feb 15, 2025
1 parent d6af45e commit fc67dba
Show file tree
Hide file tree
Showing 19 changed files with 179 additions and 64 deletions.
28 changes: 9 additions & 19 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

25 changes: 25 additions & 0 deletions website/docs/install/telemetry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
sidebar_position: 99
---

# Telemetry

## About Anonymous Telemetry

To enhance the user experience, we have **enabled anonymous telemetry by default** in your self-hosted Tianji service.

We understand that data privacy is important to you. Rest assured, this telemetry has the following characteristics:

- **Completely Anonymous**: We do not collect any personally identifiable information or service content.
- **Extremely Limited Scope**: It only includes basic usage data, helping us minimally understand Tianji's usage to continuously improve the product.
- **Fully Transparent**: All telemetry data transmissions can be observed in your service’s network panel, ensuring complete transparency.

Additionally, we fully respect your choice. If you prefer to **disable anonymous telemetry entirely**, simply set the following environment variable:

```bash
DISABLE_ANONYMOUS_TELEMETRY=1
```

For detailed configuration instructions, please refer to the Environment Variables Documentation.

With this approach, we aim to improve Tianji while ensuring privacy and security. If you have any questions or feedback, please feel free to reach out to us!
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
---
sidebar_position: 1
_i18n_hash: a3862480440a66a996f471d85570603d
_i18n_hash: f0ed5671d5832e683b6ba533651a0eb7
---
# Ereignisverfolgung

Sie können Benutzeraktionen auf Ihrer Website verfolgen. Tianji bietet eine einfache Möglichkeit, dies zu tun.

## Verwendung des Skript-Tags
## Verwendung des Script-Tags

Wenn Sie das Skript-Tag verwenden, müssen Sie einfach die `track`-Funktion an beliebiger Stelle nach dem Einfügen des Skripts aufrufen.
Wenn Sie das Script-Tag verwenden, müssen Sie einfach die `track`-Funktion an irgendeiner Stelle aufrufen, nachdem Sie das Skript eingefügt haben.

```ts
tianji.track(eventName, data);
```

## Verwendung des SDK

Wenn Sie das SDK verwenden, müssen Sie einfach die Funktion `reportEvent()` aufrufen, nachdem Sie `initTianjiTracker()` aufgerufen haben.
Wenn Sie das SDK verwenden, müssen Sie einfach die `reportEvent()`-Funktion aufrufen, nachdem Sie `initTianjiTracker()` ausgeführt haben.

```ts
import { initTianjiTracker, reportEvent } from 'tianji-sdk-client';
Expand All @@ -26,7 +26,7 @@ initTianjiTracker({
websiteId,
});

reportEvent('Demo-Event', {
reportEvent('Demo-Ereignis', {
foo: 'bar',
});
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
sidebar_position: 99
_i18n_hash: 9fa3e7353cb78796a908a1d850e9c68d
---
# Telemetrie

## Über anonyme Telemetrie

Um das Benutzererlebnis zu verbessern, haben wir die **anonyme Telemetrie standardmäßig** in Ihrem selbstgehosteten Tianji-Dienst aktiviert.

Wir verstehen, dass Datenschutz für Sie wichtig ist. Seien Sie versichert, dass diese Telemetrie folgende Eigenschaften hat:

- **Völlig anonym**: Wir sammeln keine personenbezogenen Daten oder Inhalte von Diensten.
- **Extrem eingeschränkter Umfang**: Sie umfasst lediglich grundlegende Nutzungsdaten, die uns helfen, die Nutzung von Tianji minimal zu verstehen und das Produkt kontinuierlich zu verbessern.
- **Vollständig transparent**: Alle Übertragungen von Telemetriedaten können im Netzwerkbereich Ihres Dienstes beobachtet werden, was vollständige Transparenz gewährleistet.

Darüber hinaus respektieren wir Ihre Entscheidung voll und ganz. Wenn Sie die **anonyme Telemetrie vollständig deaktivieren** möchten, setzen Sie einfach die folgende Umgebungsvariable:

```bash
DISABLE_ANONYMOUS_TELEMETRY=1
```

Für detaillierte Konfigurationsanweisungen beziehen Sie sich bitte auf die Dokumentation zu Umgebungsvariablen.

Mit diesem Ansatz wollen wir Tianji verbessern und gleichzeitig Datenschutz und Sicherheit gewährleisten. Wenn Sie Fragen oder Feedback haben, zögern Sie bitte nicht, uns zu kontaktieren!
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
sidebar_position: 99
_i18n_hash: c46b537016a415c25d7bb7d82021aacd
_i18n_hash: 6bc67c1ed8a9a26ff57ad81aa4fa0b16
---
# Besonderer Dank

## Open-Source-Projekt

Tianji ist von diesen Projekten sehr inspiriert. Vielen Dank für eure Beiträge zur Open-Source-Community.
Tianji ist von diesen Projekten sehr inspiriert, danke für eure Beiträge zur Open-Source-Community.

Ich liebe auch diese Projekte. Hochachtung vor diesen hervorragenden Projekten!
Ich liebe auch diese Projekte. Ein Salut auf diese ausgezeichneten Projekte!

- [umami](https://github.com/umami-software/umami)
- [uptime kuma](https://github.com/louislam/uptime-kuma)
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_position: 1
_i18n_hash: dbe4f3d388e41faf5b22d03df590fec6
_i18n_hash: 3e7ad33b9d88240c2ee01504fb17ed2d
---
# Verwendung in Docusaurus

Expand All @@ -13,7 +13,7 @@ const config = {

scripts: [
{
src: 'https://<deine-domain>/tracker.js',
src: 'https://<dein-domäne>/tracker.js',
async: true,
defer: true,
'data-website-id': '<deine-website-id>',
Expand Down
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
---
sidebar_position: 1
_i18n_hash: a3862480440a66a996f471d85570603d
_i18n_hash: f0ed5671d5832e683b6ba533651a0eb7
---
# Suivi des Événements
# Suivi d'Événements

Vous pouvez suivre les actions des utilisateurs sur votre site Web. Tianji fournit un moyen simple de le faire.
Vous pouvez suivre les actions des utilisateurs sur votre site web. Tianji fournit un moyen simple de le faire.

## Utilisation de la balise Script
## Utilisation de la Balise Script

Si vous utilisez une balise de script, il vous suffit d'appeler la fonction `track` à n'importe quel endroit après avoir injecté le script.
Si vous utilisez une balise script, vous devez simplement appeler la fonction `track` n'importe après avoir injecté le script.

```ts
tianji.track(nomÉvénement, données);
tianji.track(eventName, data);
```

## Utilisation du SDK

Si vous utilisez le SDK, il vous suffit d'appeler la fonction `reportEvent()` après avoir `initTianjiTracker()`.
Si vous utilisez le SDK, vous devez simplement appeler la fonction `reportEvent()` après avoir exécuté `initTianjiTracker()`.

```ts
import { initTianjiTracker, reportEvent } from 'tianji-sdk-client';

initTianjiTracker({
url: urlBackend,
url: backendUrl,
websiteId,
});

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
sidebar_position: 99
_i18n_hash: 9fa3e7353cb78796a908a1d850e9c68d
---
# Télémétrie

## À propos de la télémétrie anonyme

Pour améliorer l'expérience utilisateur, nous avons **activé la télémétrie anonyme par défaut** dans votre service Tianji auto-hébergé.

Nous comprenons que la confidentialité des données est importante pour vous. Soyez assuré que cette télémétrie a les caractéristiques suivantes :

- **Complètement Anonyme** : Nous ne collectons aucune information personnellement identifiable ni de contenu de service.
- **Portée Extrêmement Limitée** : Elle comprend uniquement des données d'utilisation de base, nous aidant à comprendre de manière minimale l'utilisation de Tianji pour améliorer continuellement le produit.
- **Entièrement Transparent** : Toutes les transmissions de données de télémétrie peuvent être observées dans le panneau réseau de votre service, garantissant une transparence totale.

De plus, nous respectons totalement votre choix. Si vous préférez **désactiver entièrement la télémétrie anonyme**, il vous suffit de définir la variable d'environnement suivante :

```bash
DISABLE_ANONYMOUS_TELEMETRY=1
```

Pour des instructions de configuration détaillées, veuillez vous référer à la documentation sur les variables d'environnement.

Avec cette approche, nous visons à améliorer Tianji tout en garantissant la confidentialité et la sécurité. Si vous avez des questions ou des commentaires, n'hésitez pas à nous contacter !
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
sidebar_position: 99
_i18n_hash: c46b537016a415c25d7bb7d82021aacd
_i18n_hash: 6bc67c1ed8a9a26ff57ad81aa4fa0b16
---
# Remerciements spéciaux

## Projet open source

Tianji s'inspire beaucoup de ces projets, merci pour vos contributions à la communauté open source.
Tianji est très inspiré par ces projets, merci pour vos contributions à la communauté open source.

J'adore aussi ces projets. Salutations à ces excellents projets !
J'aime également ces projets. Salutations à ces excellents projets !

- [umami](https://github.com/umami-software/umami)
- [uptime kuma](https://github.com/louislam/uptime-kuma)
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_position: 1
_i18n_hash: dbe4f3d388e41faf5b22d03df590fec6
_i18n_hash: 3e7ad33b9d88240c2ee01504fb17ed2d
---
# Utilisation dans Docusaurus

Expand All @@ -16,7 +16,7 @@ const config = {
src: 'https://<votre domaine>/tracker.js',
async: true,
defer: true,
'data-website-id': '<votre-id-de-site-web>',
'data-website-id': '<votre-id-site>',
},
],
};
Expand Down
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
---
sidebar_position: 1
_i18n_hash: a3862480440a66a996f471d85570603d
_i18n_hash: f0ed5671d5832e683b6ba533651a0eb7
---
# イベントトラッキング

ウェブサイト上でユーザーのアクションを追跡できます。Tianjiは、そのためのシンプルな方法を提供します
ウェブサイト上のユーザーのアクションを追跡できます。Tianjiは、それを簡単に行う方法を提供します

## スクリプトタグを使用する場合

スクリプトタグを使用している場合、スクリプトをインジェクトした後の任意の場所で`track`関数を呼び出すだけです。
スクリプトタグを使用している場合は、スクリプトをインジェクトした後の任意の場所で`track`関数を呼び出すだけです。

```ts
tianji.track(eventName, data);
```

## SDKを使用する場合

SDKを使用している場合`initTianjiTracker()`の後に`reportEvent()`関数を呼び出すだけです。
SDKを使用している場合は`initTianjiTracker()`の後に`reportEvent()`関数を呼び出すだけです。

```ts
import { initTianjiTracker, reportEvent } from 'tianji-sdk-client';
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
sidebar_position: 99
_i18n_hash: 9fa3e7353cb78796a908a1d850e9c68d
---
# テレメトリ

## 匿名テレメトリについて

ユーザー体験を向上させるために、自己ホスト型のTianjiサービスでは**匿名テレメトリがデフォルトで有効**になっています。

データプライバシーが重要であることを理解していますので、このテレメトリには以下の特徴があります:

- **完全に匿名**: 個人を特定できる情報やサービスコンテンツは収集しません。
- **極めて限定的な範囲**: 基本的な使用データのみを含んでおり、Tianjiの使用状況を最小限理解し、製品の継続的な改善に役立ちます。
- **完全な透明性**: すべてのテレメトリデータの送信は、サービスのネットワークパネルで観察でき、完全な透明性が確保されています。

さらに、皆様の選択を完全に尊重します。もし**匿名テレメトリを完全に無効にしたい**場合は、以下の環境変数を設定してください:

```bash
DISABLE_ANONYMOUS_TELEMETRY=1
```

詳細な設定手順については、環境変数のドキュメントをご覧ください。

このアプローチにより、プライバシーとセキュリティを確保しつつ、Tianjiを改善することを目指しています。質問やフィードバックがある場合は、お気軽にお問い合わせください!
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
sidebar_position: 99
_i18n_hash: c46b537016a415c25d7bb7d82021aacd
_i18n_hash: 6bc67c1ed8a9a26ff57ad81aa4fa0b16
---
# 特別な感謝

## オープンソースプロジェクト

Tianjiはこれらのプロジェクトに非常に感銘を受けています。オープンソースコミュニティへの貢献に感謝します。
天機はこれらのプロジェクトに非常に刺激を受けています。オープンソースコミュニティへの貢献に感謝します。

私もこれらのプロジェクトが大好きです。これらの素晴らしいプロジェクトに敬意を表します!

Expand Down
Loading

0 comments on commit fc67dba

Please sign in to comment.