连接到 SumoLogic
使用以下步骤连接到 SumoLogic 实例。
先决条件
◦ 如果 ThingWorx 正在运行，则停止 Tomcat 服务。
◦ 安装 Docker Engine (Docker Desktop)。有关详细信息，请参阅安装 Docker Engine。
◦ 从 PTC 软件下载页面下载 ThingWorx Docker 文件。提取 OpenTelemetry Collector docker-compose-otel-collector.override.yml 文件。
◦ 完成 ThingWorx Foundation 安装。有关详细信息，请参阅设置、构建和配置 ThingWorx Docker。
OpenTelemetry Collector Docker 连接到具有独立 ThingWorx Docker 设置的 SumoLogic
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 日志的方法。
OpenTelemetry Collector Docker 连接到具有高可用性 Docker 设置的 SumoLogic
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 Collector 部分添加或更新以下参数。
◦ 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 日志的方法。
 | 等待几分钟，并确保已将 OpenTelemetry 图像拖过 ThingWorx Docker 文件。应有单独运行的 OpenTelemetry Collector。 |
访问 ThingWorx 日志的方法
1. 访问 ThingWorx Composer URL。
2. 转至 > > > > 部分。
3. 验证日志检索策略事物名称已设置为 DefaultLogRetrievalStrategyThing。
4. 打开 DefaultLogRetrievalStrategyThing 实体并转至“配置”页面。
5. 更新 SumoLogic 实例的“搜索作业 API URL”、“访问 ID”、“访问密钥”和“响应超时 (秒)”。单击“保存”。
6. 导入扩展并基于导入的事物形态创建事物。有关创建自定义日志检索策略事物形态的详细信息，请参阅用于从外部源查询日志的自定义日志检索策略。
7. 等待并查看 SumoLogic 中的日志。
8. 打开 > 并查看特定日志。
| | 要启用来自 SumoLogic 的日志，请参阅 OpenTelemetry 配置。 |
OpenTelemetry Collector Docker 连接到通过安装程序安装 ThingWorx 的 SumoLogic
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/otel-config.yaml 文件路径> 路径替换为实际文件路径。
4. 使用以下命令执行 OpenTelemetry Collector 容器。
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 日志的方法。