Configuration d'OpenTelemetry pour la journalisation
Les paramètres de configuration OpenTelemetry suivants sont disponibles dans la section BasicSettings du fichier platform-settings.json.
Paramètre
Type
Valeur par défaut
Description
EnableOpenTelemetryForLogging
BOOLEAN
false
Définissez la valeur sur true pour activer le collecteur OpenTelemetry.
Lorsque le serveur ThingWorx Platform démarre, le collecteur OpenTelemetry établit une connexion avec le serveur ThingWorx Platform.
DisableFileLogging
BOOLEAN
false
Lorsque vous définissez cette valeur sur true :
Les journaux ne sont pas écrits dans le dossier /ThingworxStorage/logs.
Les journaux ne s'affichent pas sur la page Composer > Surveillance.
Le message suivant s'affichera sur la page Composer > Surveillance :
Logging is disabled. Please refer to ThingWorx Platform configuration file to enable it.
Ce paramètre arrête uniquement les journaux internes ThingWorx. Les journaux configurés via logback.xml, tels que les journaux externes, continuent de fonctionner.
Les journaux Console logs et HTTP.out ne sont pas affectés et continuent de fonctionner.
Si DisableFileLogging est défini sur true et EnableOpenTelemetryForLogging est défini sur false :
Le message suivant s'affichera sur la page Composer > Surveillance :
Logging is disabled. Please refer to platform configuration file to enable it.
La stratégie de récupération du journal sera définie sur DefaultLogRetrievalStrategy.
Si DisableFileLogging est défini sur false et que EnableOpenTelemetryForLogging est défini sur true, les journaux sont disponibles dans les fichiers journaux de ThingWorx sur la plateforme et dans les logiciels tiers intégrés avec OpenTelemetry.
Configuration d'OpenTelemetry SDK
Les paramètres de configuration OpenTelemetry suivants sont disponibles dans la section OpenTelemetrySettings du fichier platform-settings.json.
Paramètre
Valeur par défaut
Description
BatchLogProcessorMaxQueueSize
2048
Nombre maximal d'enregistrements de journaux pouvant être mis en file d'attente avant le traitement et l'exportation. Des valeurs supérieures augmentent le débit, mais nécessitent plus de mémoire.
BatchLogProcessorScheduledDelay
10 millisecondes
Délai d'attente (en millisecondes) du processeur avant d'exporter un nouveau lot de journaux, même si le lot n'est pas plein.
BatchLogProcessorMaxExportBatchSize
512
Nombre maximal d'entrées de journaux envoyées dans un lot d'exportation. Ce paramètre permet de contrôler la taille de la charge utile et l'utilisation du réseau.
BatchLogProcessorExportTimeout
1 000 millisecondes
Délai d'expiration, en millisecondes, pendant lequel le système attend l'exécution d'une demande d'exportation de journal.
OtlpGRPCLogExporterEndpoint
URL du point de terminaison OTLP gRPC où ThingWorx Platform exporte les journaux (par exemple, http://localhost:4317). Requis pour l'ingestion de journaux distants via le collecteur OpenTelemetry ou tout back-end compatible avec OTLP gRPC.
OtlpGRPCEnableSSL
false
Permet d'activer ou de désactiver SSL/TLS pour l'exportation de journaux gRPC OTLP.
true
: utilise une transmission sécurisée
false : utilise du texte brut.
OtlpGRPCTrustStorePath
N/A
Chemin d'accès au fichier TrustStore qui contient des certificats approuvés pour valider le collecteur OpenTelemetry ou le back-end cible lors de la communication SSL.
OtlpGRPCTrustStorePassword
N/A
Mot de passe permettant d'accéder au TrustStore configuré dans OtlpGRPCTrustStorePath.
OtlpGRPCKeyStorePath
N/A
Chemin d'accès au fichier KeyStore contenant le certificat client et la clé privée pour authentification TLS mutuelle (mTLS).
OtlpGRPCKeyStorePassword
N/A
Mot de passe permettant d'accéder au KeyStore configuré dans OtlpGRPCKeyStorePath.
RetryOtlpGRPCLogExporterMaxAttempts
5
Nombre maximal de tentatives en cas d'échec de l'exportation du journal en raison d'erreurs temporaires.
RetryOtlpGRPCLogExporterBackOffMultiplier
1.5
Multiplicateur utilisé pour calculer la temporisation exponentielle. Après chaque tentative infructueuse d'exportation des données, le temps d'attente est multiplié par ce facteur.
RetryOtlpGRPCLogExporterInitialBackOff
1 seconde
Délai, en secondes, avant la première nouvelle tentative.
RetryOtlpGRPCLogExporterMaxBackOff
5 secondes
Nombre de secondes entre les tentatives pendant une temporisation exponentielle.
OtlpGRPCMetricExporterEndpoint
N/A
URL du point de terminaison OTLP gRPC où ThingWorx Platform exporte les mesures (par exemple, http://localhost:4317). Cette URL est requise pour l'ingestion de mesures via le collecteur OpenTelemetry ou tout back-end compatible avec OTLP gRPC.
EnableOpenTelemetryInternalMetrics
true
Permet d'envoyer des mesures à la plateforme d'observabilité via le collecteur OpenTelemetry.
Rubriques connexes
Est-ce que cela a été utile ?