Соединение с SumoLogic
Используйте следующий шаг, чтобы соединиться с экземпляром SumoLogic.
Предварительные требования
◦ Остановите сервис Tomcat, если ThingWorx уже выполняется.
◦ Установите модуль Docker (рабочий стол Docker). Дополнительные сведения см. в разделе Установка модуля Docker.
◦ Загрузите файлы ThingWorx Docker со страницы загрузки программного обеспечения PTC. Извлеките файлы коллектора OpenTelemetry docker-compose-otel-collector.override.yml.
◦ Завершите установку ThingWorx Foundation. Дополнительные сведения см. в разделе Установка, построение и конфигурирование ThingWorx Docker.
Установка коллектора OpenTelemetry Docker для соединения с SumoLogic с автономным экземпляром ThingWorx 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.
Установка коллектора OpenTelemetry Docker для соединения с SumoLogic с модулем 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.
 | Подождите несколько минут и убедитесь, что образ OpenTelemetry извлечен из файлов ThingWorx Docker. Должен существовать и выполняться отдельный коллектор OpenTelemetry. |
Доступ к журналам ThingWorx
1. Перейдите по URL-адресу ThingWorx Composer.
2. Перейдите в раздел > > > > .
3. Убедитесь, что вещь стратегии извлечения журнала имеет наименование DefaultLogRetrievalStrategyThing.
4. Откройте сущность DefaultLogRetrievalStrategyThing и перейдите на страницу Конфигурация.
5. Обновите URL-адрес интерфейса API заданий поиска, ИД доступа, Ключ доступа и Время ожидания отклика (с) для экземпляра SumoLogic. Щелкните Сохранить.
6. Импортируйте расширение и создайте вещь из импортированного профиля вещи. Дополнительные сведения о создании профиля вещи пользовательской стратегии извлечения журналов см. в разделе Пользовательская стратегия извлечения журналов для запроса журналов из внешних источников.
7. Подождите и просмотрите журналы в SumoLogic.
8. Откройте > и просмотрите конкретные журналы.
| | Сведения о включении журналов из SumoLogic см. в разделе Конфигурация OpenTelemetry. |
Коллектор OpenTelemetry Docker для соединения с SumoLogic через ThingWorx, установленного с помощью установщика
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. Убедитесь, что имеется URL-адрес конечной точки для параметра OTEL_COL_OTLPHTTP_EXPORTER_ENDPOINT.
b. Убедитесь, что значение NAMESPACE совпадает с системной переменной среды.
c. Убедитесь, что <путь к файлу config/otel-config.yaml> заменен фактическим путем к файлу после загрузки и извлечения файлов docker, как описано в предварительных требованиях.
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"
},
Подтвердите URL-адрес OtlpGRPCLogExporterEndpoint.
8. Запустите сервис Tomcat, чтобы запустить сервер ThingWorx Foundation.
9. Сведения о просмотре журналов см. в разделе Как получить доступ к журналам ThingWorx.