Connexion à SumoLogic
Pour vous connecter à l'instance de SumoLogic, procédez comme suit.
Conditions préalables
◦ Arrêtez le service Tomcat si ThingWorx est déjà en cours d'exécution.
◦ Installez Docker Engine (Docker Desktop). Pour plus d'informations, consultez la page Install Docker Engine (en anglais).
◦ Téléchargez les fichiers ThingWorx Docker à partir de la page de téléchargement des logiciels PTC. Extrayez les fichiers docker-compose-otel-collector.override.yml du collecteur OpenTelemetry.
◦ Terminez l'installation de ThingWorx Foundation. Pour plus d'informations, consultez la rubrique Installation, génération et configuration de ThingWorx Docker.
Utilisation du collecteur OpenTelemetry Docker pour se connecter à SumoLogic avec l'installation autonome de ThingWorx Docker
1. Ouvrez le fichier docker-compose-otel-collector.override.yml.
a. Mettez à jour les paramètres suivants sous x-platform section,
▪ SUMOLOGIC_SOURCE : <SUMOLOGIC_SOURCE>
▪ SUMOLOGIC_COLLECTOR : <SUMOLOGIC_COLLECTOR>
▪ ENABLE_OPENTELEMETRY_FOR_LOGGING : true
b. Mettez à jour les paramètres suivants sous la section x-otel-collector ,
▪ OTEL_COL_OTLPHTTP_EXPORTER_ENDPOINT : <ENDPOINT_URL>
2. Exécutez la commande suivante pour démarrer le serveur ThingWorx.
docker compose -f docker-compose-postgres.yml -f -docker-compose-otel-collector.override.yml up -d
3. Pour observer les journaux, consultez la rubrique Comment accéder aux journaux ThingWorx.
Utilisation du collecteur OpenTelemetry Docker pour se connecter à SumoLogic avec une configuration haute disponibilité de Docker
1. Accédez aux fichiers Docker téléchargés et ouvrez le dossier de cluster de n'importe quelle base de données ThingWorx prise en charge.
2. Ouvrez le fichier .env en mode de modification. Par exemple, le fichier PostgreSQL peut se trouver à l'emplacement \docker-compose-postgres-clustered\.env.
3. Définissez ENABLE_OPENTELEMETRY_FOR_LOGGING sur true.
4. Ajoutez ou mettez à jour les paramètres suivants dans la section dédiée à la configuration de SumoLogic.
◦ SUMOLOGIC_SOURCE : <SUMOLOGIC_SOURCE>
◦ SUMOLOGIC_COLLECTOR : <SUMOLOGIC_COLLECTOR>
5. Ajoutez ou mettez à jour les paramètres suivants dans la section dédiée au collecteur OpenTelemetry.
◦ OTEL_COL_OTLPHTTP_EXPORTER_ENDPOINT : <ENDPOINT_URL>
6. Exécutez la commande suivante pour démarrer le serveur ThingWorx.
docker compose -f docker-compose-postgres.yml -f docker-compose-otel-collector.override.yml up -d
7. Pour observer les journaux, consultez la rubrique Comment accéder aux journaux ThingWorx.
 | Attendez quelques minutes et assurez-vous que l'image OpenTelemetry est extraite des fichiers ThingWorx Docker. Un collecteur OpenTelemetry distinct doit être en cours d'exécution. |
Comment accéder aux journaux ThingWorx
1. Accédez à l'URL de ThingWorx Composer.
2. Accédez à la section > > > > .
3. Vérifiez que le nom de l'objet de stratégie de récupération de journaux est défini sur DefaultLogRetrievalStrategyThing.
4. Ouvrez l'entité DefaultLogRetrievalStrategyThing et accédez à la page Configuration.
5. Mettez à jour les champs URL d'API de recherche, ID d'accès, Clé d'accès et Délai de réponse en secondes pour l'instance de SumoLogic. Cliquez sur Enregistrer.
6. Importez l'extension et créez un objet à partir de la forme d'objet importée. Pour plus d'informations sur la création d'une forme d'objet de stratégie de récupération de journaux personnalisée, consultez la rubrique Stratégie de récupération de journaux personnalisée pour l'interrogation des journaux provenant de sources externes.
7. Attendez et observez les journaux dans SumoLogic.
8. Ouvrez > et observez les journaux spécifiques.
| | Pour activer les journaux de SumoLogic, consultez la rubrique Configuration OpenTelemetry. |
Utilisation du collecteur OpenTelemetry Docker pour se connecter à SumoLogic avec une instance de ThingWorx installée via le programme d'installation
1. Créez les variables d'environnement suivantes :
◦ SUMOLOGIC_SOURCE : <SUMOLOGIC_SOURCE>
◦ SUMOLOGIC_COLLECTOR : <SUMOLOGIC_COLLECTOR>
◦ NAMESPACE : <NAMESPACE>
2. Créez votre propre fichier docker-compose.yaml et ajoutez les lignes suivantes.
version: '2.4'
services:
otel-collector:
image: otel/opentelemetry-collector-contrib:0.93.0
volumes:
- <path to the downloaded conf/otel-config.yaml file>:/config.yaml
# Configure the following files in accordance with the TLS/mTLS settings specified in the 'otel-config.yaml' file.
# - ./conf/client.crt:/client.crt
# - ./conf/client.key:/client.key
# - ./conf/server.crt:/server.crt
ports:
- 4317:4317
# - 8881:8881 # to view internal otel internal metrics
command: ["--config=/config.yaml"]
environment:
NAMESPACE: <NAMESPACE>
OTEL_COL_OTLP_RECEIVER_GRPC_ENDPOINT: 4317
OTEL_COL_OTLPHTTP_EXPORTER_ENDPOINT: <SUMOLOGIC ENDPOINT URL >
OTEL_COL_BATCH_PROCESSOR_SEND_BATCH_SIZE: 8192
OTEL_COL_BATCH_PROCESSOR_TIMEOUT: 200ms
OTEL_COL_MEMORY_LIMITER_PROCESSOR_CHECK_INTERVAL: 3s
OTEL_COL_MEMORY_LIMITER_PROCESSOR_LIMIT_PERCENTAGE: 75
OTEL_COL_MEMORY_LIMITER_PROCESSOR_SPIKE_LIMIT_PERCENTAGE: 30
OTEL_COL_OTLPHTTP_EXPORTER_RETRY_ON_FAILURE_INIT_INTERVAL: 5s
OTEL_COL_OTLPHTTP_EXPORTER_RETRY_ON_FAILURE_MAX_INTERVAL: 30s
OTEL_COL_OTLPHTTP_EXPORTER_RETRY_ON_FAILURE_MAX_ELAPSED_TIME: 300s
OTEL_COL_OTLPHTTP_EXPORTER_SENDING_QUEUE_NUM_CONSUMERS: 10
OTEL_COL_OTLPHTTP_EXPORTER_SENDING_QUEUE_SIZE: 1000
OTEL_COL_OTLPHTTP_EXPORTER_TIMEOUT: 5s
services:
otel-collector:
image: otel/opentelemetry-collector-contrib:0.93.0
volumes:
- <path to the downloaded conf/otel-config.yaml file>:/config.yaml
# Configure the following files in accordance with the TLS/mTLS settings specified in the 'otel-config.yaml' file.
# - ./conf/client.crt:/client.crt
# - ./conf/client.key:/client.key
# - ./conf/server.crt:/server.crt
ports:
- 4317:4317
# - 8881:8881 # to view internal otel internal metrics
command: ["--config=/config.yaml"]
environment:
NAMESPACE: <NAMESPACE>
OTEL_COL_OTLP_RECEIVER_GRPC_ENDPOINT: 4317
OTEL_COL_OTLPHTTP_EXPORTER_ENDPOINT: <SUMOLOGIC ENDPOINT URL >
OTEL_COL_BATCH_PROCESSOR_SEND_BATCH_SIZE: 8192
OTEL_COL_BATCH_PROCESSOR_TIMEOUT: 200ms
OTEL_COL_MEMORY_LIMITER_PROCESSOR_CHECK_INTERVAL: 3s
OTEL_COL_MEMORY_LIMITER_PROCESSOR_LIMIT_PERCENTAGE: 75
OTEL_COL_MEMORY_LIMITER_PROCESSOR_SPIKE_LIMIT_PERCENTAGE: 30
OTEL_COL_OTLPHTTP_EXPORTER_RETRY_ON_FAILURE_INIT_INTERVAL: 5s
OTEL_COL_OTLPHTTP_EXPORTER_RETRY_ON_FAILURE_MAX_INTERVAL: 30s
OTEL_COL_OTLPHTTP_EXPORTER_RETRY_ON_FAILURE_MAX_ELAPSED_TIME: 300s
OTEL_COL_OTLPHTTP_EXPORTER_SENDING_QUEUE_NUM_CONSUMERS: 10
OTEL_COL_OTLPHTTP_EXPORTER_SENDING_QUEUE_SIZE: 1000
OTEL_COL_OTLPHTTP_EXPORTER_TIMEOUT: 5s
a. Assurez-vous d'avoir mis à jour l'URL du point de terminaison pour le paramètre OTEL_COL_OTLPHTTP_EXPORTER_ENDPOINT.
b. Assurez-vous que la valeur NAMESPACE est identique à celle de la variable d'environnement système.
c. Assurez-vous que <chemin d'accès au fichier config/authentification-config.yaml> est remplacé par le chemin d'accès réel au fichier après avoir téléchargé et extrait les fichiers Docker, comme indiqué dans les conditions préalables.
4. Exécutez le conteneur du collecteur OpenTelemetry à l'aide de la commande suivante.
docker-compose up -d
5. Accédez au dossier d'installation de ThingWorx Foundation.
6. Ouvrez le fichier platform-settings.json dans un éditeur.
7. Ajoutez les paramètres suivants :
a. Définissez BasicSettings > EnableOpenTelemetryForLogging sur true.
b. Ajoutez la section suivante.
"OpenTelemetrySettings": {
"BatchLogProcessorMaxQueueSize": "2048",
"BatchLogProcessorScheduledDelay": "10",
"BatchLogProcessorMaxExportBatchSize": "512",
"BatchLogProcessorExportTimeout": "1000",
"OtlpGRPCLogExporterEndpoint": "http://localhost:4317",
"OtlpGRPCEnableSSL": "false",
"OtlpGRPCTrustStorePath": "",
"OtlpGRPCTrustStorePassword": "",
"OtlpGRPCKeyStorePath": "",
"OtlpGRPCKeyStorePassword": "",
"RetryOtlpGRPCLogExporterMaxAttempts": "5",
"RetryOtlpGRPCLogExporterBackOffMultiplier": "1.5",
"RetryOtlpGRPCLogExporterInitialBackOff": "1",
"RetryOtlpGRPCLogExporterMaxBackOff": "5",
"OtlpGRPCMetricExporterEndpoint": "http://localhost:4317",
"EnableOpenTelemetryInternalMetrics": "true"
},
"BatchLogProcessorMaxQueueSize": "2048",
"BatchLogProcessorScheduledDelay": "10",
"BatchLogProcessorMaxExportBatchSize": "512",
"BatchLogProcessorExportTimeout": "1000",
"OtlpGRPCLogExporterEndpoint": "http://localhost:4317",
"OtlpGRPCEnableSSL": "false",
"OtlpGRPCTrustStorePath": "",
"OtlpGRPCTrustStorePassword": "",
"OtlpGRPCKeyStorePath": "",
"OtlpGRPCKeyStorePassword": "",
"RetryOtlpGRPCLogExporterMaxAttempts": "5",
"RetryOtlpGRPCLogExporterBackOffMultiplier": "1.5",
"RetryOtlpGRPCLogExporterInitialBackOff": "1",
"RetryOtlpGRPCLogExporterMaxBackOff": "5",
"OtlpGRPCMetricExporterEndpoint": "http://localhost:4317",
"EnableOpenTelemetryInternalMetrics": "true"
},
Confirmez l'URL OtlpGRPCLogExporterEndpoint.
8. Lancez le service Tomcat pour démarrer le serveur ThingWorx Foundation.
9. Pour observer les journaux, consultez la rubrique Comment accéder aux journaux ThingWorx.