連線至 SumoLogic
可使用下列步驟連線至 SumoLogic 實例。
先決條件
◦ 如果 ThingWorx 已在執行中，請停止 Tomcat 服務。
◦ 安裝 Docker Engine (Docker Desktop)。如需詳細資訊，請參閱安裝 Docker Engine。
◦ 從 PTC 軟體下載頁下載 ThingWorx Docker 檔案。解壓縮 OpenTelemetry 收集器 docker-compose-otel-collector.override.yml 檔案。
◦ 完成 ThingWorx Foundation 安裝。如需詳細資訊，請參閱設定、建構及配置 ThingWorx Docker。
使用獨立 ThingWorx Docker 設定連線至 SumoLogic 的 OpenTelemetry 收集器 Docker
1. 開啟 docker-compose-otel-collector.override.yml。
a. 更新 x-platform section 之下的下列參數
▪ SUMOLOGIC_SOURCE：<SUMOLOGIC_SOURCE>
▪ SUMOLOGIC_COLLECTOR：<SUMOLOGIC_COLLECTOR>
▪ ENABLE_OPENTELEMETRY_FOR_LOGGING: true
b. 更新 x-otel-collector 區段之下的下列參數，
▪ OTEL_COL_OTLPHTTP_EXPORTER_ENDPOINT: <ENDPOINT_URL>
2. 執行下列指令來啟動 ThingWorx 伺服器。
docker compose -f docker-compose-postgres.yml -f -docker-compose-otel-collector.override.yml up -d
3. 欲查看記錄檔，請參閱如何存取 ThingWorx 記錄檔。
使用高可用性 Docker 設定連線至 SumoLogic 的 OpenTelemetry 收集器 Docker
1. 轉至下載的 docker 檔案，並開啟任何 ThingWorx 所支援資料庫的叢集資料夾。
2. 在編輯模式下開啟 .env 檔案。例如，PostgreSQL 檔案可能位於 \docker-compose-postgres-clustered\.env。
3. 將 ENABLE_OPENTELEMETRY_FOR_LOGGING 設定為 true。
4. 在 Sumologic 組態部份新增或更新下列參數。
◦ SUMOLOGIC_SOURCE：<SUMOLOGIC_SOURCE>
◦ SUMOLOGIC_COLLECTOR: <SUMOLOGIC_COLLECTOR>
5. 在「OpenTelemetry 收集器」部份新增或更新下列參數。
◦ OTEL_COL_OTLPHTTP_EXPORTER_ENDPOINT: <ENDPOINT_URL>
6. 執行下列指令來啟動 ThingWorx 伺服器。
docker compose -f docker-compose-postgres.yml -f docker-compose-otel-collector.override.yml up -d
7. 欲查看記錄檔，請參閱如何存取 ThingWorx 記錄檔。
 | 請等待幾分鐘，並確保已透過 ThingWorx docker 檔案提取 OpenTelemetry 映像檔。OpenTelemetry 收集器應單獨啟動並執行。 |
如何存取 ThingWorx 記錄檔
1. 存取 ThingWorx Composer URL。
2. 轉至 > > > > 部份。
3. 核對記錄檔擷取策略物件名稱已設定為 DefaultLogRetrievalStrategyThing。
4. 開啟 DefaultLogRetrievalStrategyThing 實體並轉至「組態」頁。
5. 針對 SumoLogic 實例更新「搜尋工作 API URL」、「存取 ID」、「存取鍵」與「回應逾時 (秒)」。按一下「儲存」。
6. 匯入延伸功能並從匯入的物形式建立物件。如需有關建立自訂記錄檔擷取策略物形式的詳細資訊，請參閱針對從外部來源查詢記錄檔自訂記錄檔擷取策略。
7. 等待並觀察 SumoLogic 中的記錄檔。
8. 開啟 > ，並觀察特定記錄檔。
| | 欲從 SumoLogic 啟用記錄檔，請參閱 OpenTelemetry 組態。 |
使用透過安裝程式安裝的 ThingWorx 連線至 SumoLogic 的 OpenTelemetry 收集器 Docker
1. 建立下列環境變數：
◦ SUMOLOGIC_SOURCE：<SUMOLOGIC_SOURCE>
◦ SUMOLOGIC_COLLECTOR：<SUMOLOGIC_COLLECTOR>
◦ NAMESPACE: <NAMESPACE>
2. 建立您自己的 docker-compose.yaml 檔案並新增以下這些行。
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. 請確定您已更新參數 OTEL_COL_OTLPHTTP_EXPORTER_ENDPOINT 的端點 URL。
b. 請確定 NAMESPACE 值與系統環境變數相同。
c. 請確定在如先決條件所述下載並解壓縮 docker 檔案之後，< config/config.yaml 檔案的路徑> 已由實際檔案路徑取代。
4. 使用下列指令執行 OpenTelemetry 收集器容器。
docker-compose up -d
5. 轉至 ThingWorx Foundation 安裝資料夾。
6. 在編輯器中開啟 platform-settings.json 檔案。
7. 新增下列設定：
a. 將 BasicSettings > EnableOpenTelemetryForLogging 設定為 true。
b. 新增下列區段。
"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"
},
確認 OtlpGRPCLogExporterEndpoint URL。
8. 啟動 Tomcat 服務以啟動 ThingWorx Foundation 伺服器。
9. 欲查看記錄檔，請參閱如何存取 ThingWorx 記錄檔。