Mit SumoLogic verbinden
Führen Sie den folgenden Schritt aus, um eine Verbindung zur SumoLogic-Instanz herzustellen.
Voraussetzung
◦ Halten Sie den Tomcat-Dienst an, wenn ThingWorx bereits ausgeführt wird.
◦ Installieren Sie Docker-Engine (Docker Desktop). Weitere Informationen finden Sie unter Docker-Engine installieren.
◦ Laden Sie ThingWorx Docker-Dateien von der PTC-Seite Software herunterladen herunter. Extrahieren Sie die Dateien docker-compose-otel-collector.override.yml des OpenTelemetry Collector.
◦ Schließen Sie die ThingWorx Foundation Installation ab. Weitere Informationen finden Sie unter ThingWorx Docker einrichten, erstellen und konfigurieren.
OpenTelemetry Collector-Docker zum Herstellen einer Verbindung zu SumoLogic mit eigenständigen ThingWorx Docker-Setup
1. Öffnen Sie die Datei docker-compose-otel-collector.override.yml.
a. Aktualisieren Sie die folgenden Parameter unter x-platform section,
▪ SUMOLOGIC_SOURCE: <SUMOLOGIC_SOURCE>
▪ SUMOLOGIC_COLLECTOR: <SUMOLOGIC_COLLECTOR>
▪ ENABLE_OPENTELEMETRY_FOR_LOGGING: true
b. Aktualisieren Sie die folgenden Parameter im Abschnitt x-otel-collector ,
▪ OTEL_COL_OTLPHTTP_EXPORTER_ENDPOINT: <ENDPOINT_URL>
2. Führen Sie den folgenden Befehl aus, um ThingWorx Server zu starten.
docker compose -f docker-compose-postgres.yml -f -docker-compose-otel-collector.override.yml up -d
3. Informationen zu den Protokollen finden Sie unter So greifen Sie auf ThingWorx Protokolle zu.
OpenTelemetry Collector-Docker zum Herstellen einer Verbindung zu SumoLogic mit Hochverfügbarkeits-Docker-Setup
1. Gehen Sie zu heruntergeladenen Docker-Dateien, und öffnen Sie den Cluster-Ordner einer beliebigen von ThingWorx unterstützten Datenbank.
2. Öffnen Sie die Datei .env im Bearbeitungsmodus. Die PostgreSQL-Datei kann sich beispielsweise im Ordner \docker-compose-postgres-clustered\.env befinden.
3. Legen Sie ENABLE_OPENTELEMETRY_FOR_LOGGING auf true fest.
4. Fügen Sie die folgenden Parameter im Abschnitt mit der SumoLogic-Konfiguration hinzu, oder aktualisieren Sie sie.
◦ SUMOLOGIC_SOURCE: <SUMOLOGIC_SOURCE>
◦ SUMOLOGIC_COLLECTOR: <SUMOLOGIC_COLLECTOR>
5. Fügen Sie die folgenden Parameter im Abschnitt "OpenTelemetry Collector" hinzu, oder aktualisieren Sie sie.
◦ OTEL_COL_OTLPHTTP_EXPORTER_ENDPOINT: <ENDPOINT_URL>
6. Führen Sie den folgenden Befehl aus, um ThingWorx Server zu starten.
docker compose -f docker-compose-postgres.yml -f docker-compose-otel-collector.override.yml up -d
7. Informationen zu den Protokollen finden Sie unter So greifen Sie auf ThingWorx Protokolle zu.
 | Warten Sie einige Minuten, und stellen Sie sicher, dass das OpenTelemetry-Image über die ThingWorx Docker-Dateien abgerufen wird. Es sollte ein separater OpenTelemetry Collector ausgeführt werden. |
So greifen Sie auf ThingWorx Protokolle zu
1. Greifen Sie auf die ThingWorx Composer URL zu.
2. Wechseln Sie zum Abschnitt > > > > .
3. Vergewissern Sie sich, dass der Name des Dings für den Protokollabruf auf DefaultLogRetrievalStrategyThing festgelegt ist.
4. Öffnen Sie die Entität DefaultLogRetrievalStrategyThing, und gehen Sie zur Seite Konfiguration.
5. Aktualisieren Sie Job-API-URL für die Suche, Zugriffs-ID, Zugriffsschlüssel und Antwort-Timeout in Sekunden für die SumoLogic-Instanz. Klicken Sie auf Speichern.
6. Importieren Sie die Erweiterung, und erstellen Sie ein Ding aus der importierten Dingform. Weitere Informationen zum Erstellen einer benutzerdefinierten Protokollabrufstrategie-Dingform finden Sie unter Benutzerdefinierte Protokollabrufstrategie für die Abfrage von Protokollen aus externen Quellen.
7. Warten Sie, und beobachten Sie die Protokolle in SumoLogic.
8. Öffnen Sie > , und beobachten Sie bestimmte Protokolle.
| | Informationen zum Aktivieren von Protokollen aus SumoLogic finden Sie unter OpenTelemetry-Konfiguration. |
OpenTelemetry Collector-Docker zum Herstellen einer Verbindung zu SumoLogic mit ThingWorx bei Installation über das Installationsprogramm
1. Erstellen Sie die folgenden Umgebungsvariablen:
◦ SUMOLOGIC_SOURCE: <SUMOLOGIC_SOURCE>
◦ SUMOLOGIC_COLLECTOR: <SUMOLOGIC_COLLECTOR>
◦ NAMESPACE: <NAMESPACE>
2. Erstellen Sie Ihre eigene Datei docker-compose.yaml, und fügen Sie die folgenden Zeilen hinzu.
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. Stellen Sie sicher, dass Sie die Endpunkt-URL für den Parameter OTEL_COL_OTLPHTTP_EXPORTER_ENDPOINT aktualisiert haben.
b. Stellen Sie sicher, dass NAMESPACE dem Wert der Systemumgebungsvariablen entspricht.
c. Stellen Sie sicher, dass <Pfad zur Datei config/otel-config.yaml> durch den tatsächlichen Dateipfad ersetzt wird, nachdem die Docker-Dateien wie in den Voraussetzungen beschrieben heruntergeladen und extrahiert wurden.
4. Führen Sie den OpenTelemetry Collector-Container mit dem folgenden Befehl aus.
docker-compose up -d
5. Wechseln Sie zum ThingWorx Foundation Installationsordner.
6. Öffnen Sie die Datei platform-settings.json in einem Editor.
7. Fügen Sie die folgenden Einstellungen hinzu:
a. Legen Sie BasicSettings > EnableOpenTelemetryForLogging auf true fest.
b. Fügen Sie den folgenden Abschnitt hinzu.
"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"
},
Bestätigen Sie die URL OtlpGRPCLogExporterEndpoint.
8. Starten Sie den Tomcat-Dienst, um ThingWorx Foundation Server zu starten.
9. Informationen zu den Protokollen finden Sie unter So greifen Sie auf ThingWorx Protokolle zu.