Pour surveiller et déboguer les requêtes Firestore en mode Datastore (Datastore) de bout en bout, vous pouvez activer les traces dans la bibliothèque cliente Java. Le traçage côté client peut fournir un signal sur les performances telles qu'elles sont perçues par votre application, ainsi que des informations qui peuvent vous aider à déboguer les problèmes.
Les traces côté client, qui sont collectées en exécutant des RPC depuis le client, fournissent les informations suivantes :
- Plages avec des codes temporels indiquant quand le client a envoyé la requête RPC et quand il a reçu la réponse RPC, y compris la latence introduite par le réseau et le système client
- Attributs (paires clé/valeur) qui fournissent des informations sur le client et sa configuration.
- Journaux associés aux événements clés dans les spans.
- Traces de pile en cas de plantage sur le client.
OpenTelementry
Les traces de la bibliothèque cliente Java sont instrumentées à l'aide des API OpenTelemetry. OpenTelemetry est un framework d'observabilité Open Source conforme aux normes du secteur. OpenTelemetry propose un large éventail d'outils tels que des API et des SDK d'instrumentation, des collecteurs, des exportateurs spécifiques au backend et des options de configuration flexibles telles que des contrôles d'échantillonnage, des limites de portée, etc.
Exporter des traces avec des exportateurs et des collecteurs
Dans vos configurations, vous pouvez exporter vos traces vers un backend d'observabilité. La plupart des fournisseurs de services d'observabilité proposent des exportateurs que vous pouvez utiliser, tels que Cloud Trace.
En plus d'un exportateur, OpenTelemetry recommande de configurer un collecteur. Un collecteur permet à votre service de décharger rapidement les données et de gérer d'autres tâches telles que les nouvelles tentatives, le traitement par lot et le chiffrement. Un collecteur s'exécute à côté de votre application. Le collecteur reçoit les messages du protocole OpenTelemetry (OTLP), les traite et les exporte vers votre backend d'observabilité.
Limites
Les portées de trace ne sont disponibles que pour la bibliothèque cliente Java.
Facturation
En plus de l'utilisation de Datastore, le traçage côté client peut entraîner des frais.
La collecte de traces et l'utilisation du framework OpenTelemetry sont gratuites.
L'ingestion de délais de trace dans votre backend d'observabilité peut être facturable. Par exemple, si vous utilisez Cloud Trace comme backend, vous serez facturé selon les tarifs de Cloud Trace. Si vous utilisez un autre fournisseur de services d'observabilité, renseignez-vous sur son modèle de facturation et les coûts associés.
Pour mieux comprendre la facturation, commencez par un faible taux d'échantillonnage des traces (tracez un petit pourcentage de vos RPC) en fonction de votre trafic.
Avant de commencer
Avant de commencer :
Assurez-vous de configurer le compte de service sous lequel votre application écrit des traces dans votre backend d'observabilité avec les rôles Identity and Access Management nécessaires :
Opération de trace Rôle IAM Lire les traces roles/cloudtrace.user
Écrire des traces roles/cloudtrace.agent
Traces de lecture/écriture roles/cloudtrace.admin
Vérifiez que l'API Trace est activée pour ce projet.
Configurer des traces côté client
Cette section fournit des exemples de configurations pour les traces côté client. Vous pouvez exporter les données vers un collecteur ou directement vers un backend d'observabilité. Vous disposez également des options suivantes pour configurer les traces côté client :
- Vous pouvez configurer des traces avec les API OpenTelemetry. Cela nécessite des modifications du code de votre application. Voici quelques exemples :
- Vous pouvez configurer des traces sans modifier le code à l'aide d'agents automatiques. Vous devez définir la variable d'environnement
DATASTORE_ENABLE_TRACING=ON
. Vous devez également définir d'autres paramètres de configuration, comme décrit dans Configuration de l'agent. Voici quelques exemples :
Exporter des traces vers un collecteur avec les API OpenTelemetry
Le code suivant configure la bibliothèque cliente Java Datastore pour exporter les spans avec un taux d'échantillonnage de 10 % vers un collecteur OpenTelemetry.
Java
Resource resource = Resource
.getDefault().merge(Resource.builder().put(SERVICE_NAME, "My App").build());
OtlpGrpcSpanExporter otlpGrpcSpanExporter =
OtlpGrpcSpanExporter
.builder()
.setEndpoint("http://localhost:4317") // Replace with your OTLP endpoint
.build();
// Using a batch span processor
// You can use `.setScheduleDelay()`, `.setExporterTimeout()`,
// `.setMaxQueueSize`(), and `.setMaxExportBatchSize()` to further customize.
BatchSpanProcessor otlpGrpcSpanProcessor =
BatchSpanProcessor.builder(otlpGrpcSpanExporter).build();
// Export to a collector that is expecting OTLP using gRPC.
OpenTelemetrySdk otel = OpenTelemetrySdk.builder()
.setTracerProvider(SdkTracerProvider.builder()
.setResource(resource)
.addSpanProcessor(otlpGrpcSpanProcessor)
.setSampler(Sampler.traceIdRatioBased(0.1))
.build())
.build();
DatastoreOptions datastoreOptions = DatastoreOptions
.newBuilder()
.setOpenTelemetryOptions(
DatastoreOpenTelemetryOptions.newBuilder()
.setTracingEnabled(true)
.setOpenTelemetry(otel)
.build())
.build();
Datastore datastore = datastoreOptions.getService();
Exporter directement vers un backend d'observabilité avec les API OpenTelemetry
Le code suivant configure la bibliothèque cliente Java pour exporter directement les spans de trace vers Cloud Trace avec un taux d'échantillonnage de trace de 10 %. Vous pouvez utiliser les exportateurs d'autres fournisseurs de services d'observabilité pour exporter directement vers leur backend. Si votre backend d'observabilité est compatible avec l'ingestion OTLP, vous pouvez utiliser OpenTelemetry OtlpGrpcSpanExporter
pour exporter vers votre backend au lieu d'utiliser un exportateur personnalisé.
Java
// TraceExporter needed for this use case
import com.google.cloud.opentelemetry.trace.TraceExporter;
Resource resource = Resource
.getDefault().merge(Resource.builder().put(SERVICE_NAME, "My App").build());
SpanExporter gcpTraceExporter = TraceExporter.createWithDefaultConfiguration();
// Using a batch span processor
// You can use `.setScheduleDelay()`, `.setExporterTimeout()`,
// `.setMaxQueueSize`(), and `.setMaxExportBatchSize()` to further customize.
SpanProcessor gcpBatchSpanProcessor =
BatchSpanProcessor.builder(gcpTraceExporter).build();
// Export directly to Cloud Trace with 10% trace sampling ratio
OpenTelemetrySdk otel = OpenTelemetrySdk.builder()
.setTracerProvider(SdkTracerProvider.builder()
.setResource(resource)
.addSpanProcessor(gcpBatchSpanProcessor)
.setSampler(Sampler.traceIdRatioBased(0.1))
.build())
.build();
DatastoreOptions datastoreOptions = DatastoreOptions
.newBuilder()
.setOpenTelemetryOptions(
DatastoreOpenTelemetryOptions.newBuilder()
.setTracingEnabled(true)
.setOpenTelemetry(otel)
.build())
.build();
Datastore datastore = datastoreOptions.getService();
Exporter vers un collecteur avec des agents automatiques
Exécutez votre collecteur OpenTelemetry avec les récepteurs OTLP gRPC activés. Définissez l'exportateur de l'agent sur otlp
et spécifiez le point de terminaison vers lequel l'agent doit exporter les données. L'exemple suivant utilise un taux d'échantillonnage de 10 % et envoie des traces au collecteur qui écoute le port localhost 4317
.
Terminal
DATASTORE_ENABLE_TRACING=ON \
java \
-javaagent:path/to/opentelemetry-javaagent.jar \
-Dotel.traces.exporter=otlp \
-Dotel.exporter.otlp.endpoint="http://localhost:4317" \
-Dotel.traces.sampler=traceidratio \
-Dotel.traces.sampler.arg=0.1 \
-Dotel.service.name="My App" \
-jar myapp.jar
Exporter directement vers un backend d'observabilité avec les agents automatiques
En plus de définir la variable d'environnement DATASTORE_ENABLE_TRACING=ON
, vous devez ajouter l'extension de l'agent Java OpenTelemetry pour votre backend spécifique. L'exemple suivant utilise l'extension d'exportateur de trace et un taux d'échantillonnage de trace de 10 %.
Terminal
DATASTORE_ENABLE_TRACING=ON \
java \
-javaagent:path/to/opentelemetry-javaagent.jar \
-Dotel.javaagent.extensions=/path/to/exporter-auto-0.26.0-alpha-shaded.jar \
-Dotel.traces.exporter=google_cloud_trace \
-Dotel.traces.sampler=traceidratio \
-Dotel.traces.sampler.arg=0.1 \
-Dotel.service.name="My Application" \
-jar myapp.jar
Exemple de trace
Les exemples suivants montrent comment les informations de trace s'affichent dans Cloud Trace. Pour en savoir plus sur les attributs et valeurs possibles, consultez Attributs et événements de portée Trace.
Exemple de span de trace
Exemple de journal des événements
Exemples de valeurs d'attribut
Étapes suivantes
- Consultez la référence pour les attributs et événements de portée de trace.
- En savoir plus sur la surveillance côté serveur