SDKs par langage

SDKs par langage pour ClickStack - La stack d’observabilité ClickHouse

Les données sont généralement envoyées à ClickStack via le collector OpenTelemetry (OTel), soit directement depuis les SDKs par langage, soit via un collector OpenTelemetry intermédiaire agissant comme agent, par exemple pour collecter les métriques et les logs de l’infrastructure.

Les SDKs par langage sont chargés de collecter la télémétrie au sein de votre application, en particulier les traces et les logs, puis d’exporter ces données vers le collector OpenTelemetry via l’endpoint OTLP, qui gère l’ingestion dans ClickHouse.

Dans les environnements basés sur le navigateur, les SDKs peuvent également collecter les données de session, notamment les événements de l’UI, les clics et la navigation, ce qui permet de rejouer les sessions utilisateur.

​

Comment ça fonctionne

1. Votre application utilise un SDK ClickStack (par ex., Node.js, Python, Go). Ces SDKs s’appuient sur les OpenTelemetry SDKs, avec des fonctionnalités supplémentaires et des améliorations en matière de convivialité.
2. Le SDK collecte et exporte les traces et les logs via OTLP (HTTP ou gRPC).
3. Le collector OpenTelemetry reçoit la télémétrie et l’écrit dans ClickHouse via les exporters configurés.

​

Langues prises en charge

Compatibilité OpenTelemetry

Bien que ClickStack propose ses propres SDKs par langage avec une télémétrie et des fonctionnalités améliorées, vous pouvez également utiliser sans difficulté vos SDKs OpenTelemetry existants.

Langage	Description	Lien
AWS Lambda	Instrumentez vos fonctions AWS Lambda	Documentation
Browser	SDK JavaScript pour les applications exécutées dans le navigateur	Documentation
Elixir	Applications Elixir	Documentation
Go	Applications et microservices Go	Documentation
Java	Applications Java	Documentation
NestJS	Applications NestJS	Documentation
Next.js	Applications Next.js	Documentation
Node.js	Environnement d’exécution JavaScript pour les applications côté serveur	Documentation
Deno	Applications Deno	Documentation
Python	Applications Python et services web	Documentation
React Native	Applications mobiles React Native	Documentation
Ruby	Applications Ruby on Rails et services web	Documentation

​

Sécurisation avec une API key

Non requis pour Managed ClickStack

L’API key n’est pas requise pour Managed ClickStack.

Pour envoyer des données à ClickStack via l’OTel collector, les SDKs doivent spécifier une API key d’ingestion. Celle-ci peut être définie soit à l’aide d’une fonction init dans le SDK, soit à l’aide de la variable d’environnement OTEL_EXPORTER_OTLP_HEADERS :

OTEL_EXPORTER_OTLP_HEADERS='authorization=<YOUR_INGESTION_API_KEY>'

Cette clé API est générée par l’application ClickStack UI (HyperDX) et est accessible dans l’application, sous Team Settings → API Keys.

Pour la plupart des SDKs par langage et des bibliothèques de télémétrie compatibles avec OpenTelemetry, vous pouvez simplement définir la variable d’environnement OTEL_EXPORTER_OTLP_ENDPOINT dans votre application ou la spécifier lors de l’initialisation du SDK :

export OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318

​

Intégration Kubernetes

Tous les SDKs prennent en charge la corrélation automatique avec les métadonnées Kubernetes (nom du pod, espace de noms, etc.) lorsqu’ils s’exécutent dans un environnement Kubernetes. Cela vous permet de :

• Afficher les métriques Kubernetes des pods et des nœuds associés à vos services
• Corréler les logs et les traces de l’application avec les métriques de l’infrastructure
• Suivre l’utilisation des ressources et les performances à l’échelle de votre cluster Kubernetes

Pour activer cette fonctionnalité, configurez le collector OpenTelemetry pour transmettre les tags de ressource aux pods. Consultez le guide d’intégration Kubernetes pour obtenir des instructions de configuration détaillées.