Collecting logs from Yokogawa FAST/TOOLS and sending them to Sumo Logic could be complex due to this unique combination of log sources and SIEM solution. This post will show you how to forward log data from Yokogawa FAST/TOOLS to Sumo Logic using NXLog.
Yokogawa FAST/TOOLS
FAST/TOOLS is Yokogawa’s SCADA software platform. Its client-server architecture comprises three main functional components: a SCADA server, a Web HMI client, and a Web HMI server. The SCADA server is responsible for collecting, processing, and managing the logs it receives from the Web HMI clients. The Web HMI server displays events and other operational data from Web HMI clients while also serving as the human-machine interface for displaying the logs that the SCADA server has processed.
FAST/TOOLS comprises several function-specific modules that include OPC server and client functionality and a history scheduler. The FAST/TOOLS software platform integrates with cloud computing and virtualization infrastructures. It is widely deployed in the oil and gas industry and large manufacturing plants worldwide.
Collecting Yokogawa FAST/TOOLS logs
FAST/TOOLS produces a wide variety of logs about its operations.
These logs are available in flat files and stored in the C:\Users\Public\Yokogawa\tls\log\
system directory.
There is no room for error or trade-offs because Yokogawa FAST/TOOLS monitors and controls the type of operations Its steady, uninterrupted operation is essential to maintaining plant safety. However, due to excessive log noise, valuable information can sometimes remain hidden in the logs it collects. Another challenge is the lack of consistent log formats. The ability to parse data from various log formats is an absolute necessity.
NXLog Enterprise Edition is a lightweight, modular log collection tool capable of tackling the most challenging cases log collection may pose. Its rich features allow it to read almost any log format and parse fields to produce structured data for further processing. It is the perfect tool for monitoring and collecting FAST/TOOLS logs.
- RDBMS data collection
-
FAST/TOOLS provides an ODBC (open database connectivity) interface that collects data from the FAST/TOOLS data set services layer and sends it directly to an external ODBC compliant database. With FAST/TOOLS, you can view table components and perform faster queries, obtaining much quicker insight into your plant operations. FAST/TOOLS includes an embedded relational database management system (RDBMS) that allows you to execute more complex queries and cross-reference FAST/TOOLS data with your own RDBMS environment.
- Collecting FAST/TOOLS logs from file
-
FAST/TOOLS' file-based logs include start logs, diagnostics logs, system monitor logs, and systems error logs. The processes that detect system errors send messages to the FAST/TOOLS unsolicited message handler (UMH), which manages all the necessary information present in these logs. This information includes the name of the process that detected the error, a timestamp, and an error code. You can view these application error logs in the
messages.umh
file of the FAST/TOOLS data directory. NXLog is capable of parsing these complex logs by using regular expressions. - FAST/TOOLS passive network monitoring
-
FAST/TOOLS supports open platform communications (OPC) functionality and includes an embedded OPC Unified Architecture (UA) environment. It also supports classic OPC for distributed communication (DCOM) links across your network. NXLog can passively monitor your network traffic and generate logs for most network protocols.
NXLog’s data normalization and log aggregation capabilities can extend the functionality of Yokogawa FAST/TOOLS. Because NXLog can collect logs from literally any file in any format, it is ideally suited for integrating with FAST/TOOLS' wide variety of log types and file formats.
For more information on integrating NXLog with this SCADA software environment, visit our detailed Yokogawa FAST/TOOLS integration guide.
The log sources mentioned above and NXLog’s features play an important role in normalizing logs to meet Sumo Logic’s requirements.
Sending logs to Sumo Logic
Sumo Logic is a real-time SaaS platform that collects, manages, and analyzes log data while securing cloud-scale applications. NXLog can be configured to send log data to Sumo Logic in syslog format over TCP or via a custom HTTP endpoint. It can also be configured to send host metrics via HTTP.
- Data collection
-
Sumo Logic accepts data from two types of collectors, installed or hosted. Installed collectors are set up by installing agent software provided by Sumo Logic, whereas hosted collectors are used to send data over TCP or HTTP(S) from agents like NXLog.
- Sending logs using TCP
-
Sumo Logic accepts log data as syslog messages in IETF (RFC 5424) format and requires sending data using TLS v1.2 over TCP. A Cloud Syslog Source must be created in Sumo Logic to use this method. Syslog messages should fully comply with RFC 5424 guidelines, otherwise Sumo Logic will drop them. Also, it should be noted that messages larger than 64 KB will be truncated.
- Sending logs using HTTPS
-
Logs and host metrics can be sent to Sumo Logic over HTTP(S) using a unique URL generated for each source. An HTTP Logs & Metrics Source must be created in Sumo Logic for NXLog to be able to send data over HTTPS.
Sumo Logic supports metrics in the Graphite, Carbon 2.0, and Prometheus formats. NXLog can be configured to convert data into practically any desired format. It can read and convert the data to another format on the fly while forwarding, without the need to create a temporary file.
For more information on configuring NXLog and sending logs to Sumo Logic, see the Sumo Logic integration guide in the NXLog User Guide.