Concepts¶

Includes explanations of terms such as TrueWatch components, features, clients, mobile, versions, and billing.

Components¶

TrueWatch components include the front-end console Studio, data gateway DataWay, data collection Agent DataKit, and the extensible programming platform Func.

Component	Description
Studio	Studio is TrueWatch's console, supporting comprehensive querying and analysis of collected data.
DataWay	DataWay is TrueWatch's data gateway, mainly used to receive data sent by DataKit, then report it to DataFlux for storage.
DataKit	DataKit is TrueWatch's real-time data collection Agent, supporting hundreds of types of data collection. After DataKit collects data, it sends it to the DataWay data gateway, which then reports it to the center for storage and analysis. DataKit needs to be deployed in the user's own IT environment and supports multiple operating systems. Default collection frequency: 5 minutes
Func	Func is DataFlux Func, TrueWatch's extensible programming platform, used for function development, management, and execution. It is simple to use; just write code and publish it, automatically generating an HTTP API interface for the function. The official provides various ready-to-use script libraries, easily allowing TrueWatch to call them.

Storage Engine Suite¶

Component	Description
truewatch-select	A sub-component of TrueWatch's storage suite, specifically responsible for querying and analyzing observable data.
truewatch-insert	A sub-component of TrueWatch's storage suite, specifically responsible for writing observable data.
truewatch-storage	TrueWatch's time series metric data storage engine, responsible for storing time series metric data.
Doris	TrueWatch's non-time-series data storage engine, suitable for logs, APM, RUM, and event data.

Architecture diagram:

Features¶

Includes scenarios, events, infrastructure, Metrics, logs, application performance monitoring, real-user monitoring, synthetic testing, security checks, etc., providing full-chain-level data analysis and insight capabilities for collected data.

Feature	Description
Integrations	TrueWatch supports over a hundred data collectors, including HOST, CONTAINERS, logs, Nginx, APM, RUM, etc. Simply install DataKit to start real-time data collection and reporting to TrueWatch workspaces for data analysis. You can refer to integrations on how to install Datakit, Func, DCA, and mobile.
Scenarios	In scenarios, you can visualize the collected data with charts. Currently, three display methods are supported: Dashboards, Notes, and Explorers. Dashboard: Dashboards consist of multiple visual charts for viewing and analyzing topic-related data comprehensively. Layouts and chart sizes can be freely adjusted; Note: Notes consist of text documents and other visual charts with fixed layouts from top to bottom. They allow combined textual and visual data analysis and summary reporting; Explorer: Here you can quickly set up a log explorer, support adding custom statistical charts, setting default display properties and filter conditions, customizing your log viewing needs. Built-in Views: Includes two parts, System Views and User Views. System views are officially provided view templates, while user views are user-defined created and saved as templates. Supports cloning from system views for binding to scenarios and explorers details.
Events	Events are generated by monitors, intelligent inspections, SLOs, system operations, and Open API writes. They support real-time monitoring, unified querying, unresolved event statistics, and data export based on event data to trace anomalies that occurred during a specific time period.
Infrastructure	Physical infrastructure for data collection. Currently supports HOSTs, CONTAINERS, processes, K8s entities, and more.
Metrics	Measurements: Collections of the same type of Metrics. Generally, Metrics in the same Measurement have identical tags, and one Measurement can contain multiple Metrics. Metrics: Metrics help understand the overall availability of the system, such as server CPU usage, website loading time, remaining disk space, etc. Metrics consist of Metric names and Metric values. Metric names are aliases identifying the Metric, while Metric values represent the specific numerical values collected. Tags: Sets of attributes identifying the objects of data point collection. Tags consist of tag names and tag values, and one data point can have multiple tags. For example, when collecting the Metric `CPU Usage`, it identifies attributes like `host`, `os`, `product`, etc., collectively referred to as tags. Time Series: In the current workspace, the number of combinations based on labels in reported Metric data. In TrueWatch, Time Series is composed of Metrics, tags (fields), and data retention periods, where "Metrics" and "tags (fields)" form the primary key for data storage.
Logs	Records real-time operational or behavioral data produced by systems or software, supporting front-end visualization, filtering, and analysis.
APM	Tracks and analyzes the time spent handling requests by services, request statuses, and other attribute information, useful for monitoring application performance.
RUM	Real-User Monitoring refers to collecting data related to the real experiences and behaviors of users interacting with your websites and applications. TrueWatch supports four types of real-user monitoring: Web, Mobile (Android & IOS), and Mini Programs.
Synthetic Tests	Uses globally distributed test nodes to monitor websites, domains, API interfaces, etc., via protocols such as HTTP, TCP, ICMP periodically. Supports analyzing site quality through trends in availability rates and delays.
Security Check	Conducts inspections on systems, software, and logs using new security scripts, supporting real-time data output and synchronization of abnormal issues, understanding device operation status and environmental changes, discovering facility defects and security risks, and taking timely effective measures.
CI	TrueWatch supports visualization of Gitlab’s built-in CI processes and results. You can view all visualized Pipelines and their success rates, failure reasons, and specific failed stages in TrueWatch, helping ensure code updates.
Monitoring	Monitors: By configuring detection rules, trigger conditions, and event notifications, receive alert notifications promptly to identify and resolve problems. Includes threshold detection, mutation detection, range detection, outlier detection, log detection, process anomaly detection, infrastructure survival detection, application performance indicator detection, user access indicator detection, security inspection anomaly detection, synthetic testing anomaly detection, and network data detection. Intelligent Inspection: Based on TrueWatch’s intelligent algorithms, automatically detects and predicts infrastructure and application problems, helping users discover issues occurring during IT system operation. Through root cause analysis, quickly locate the causes of abnormal problems. SLO: SLO monitoring revolves around DevOps indicators to test whether system service availability meets target requirements. Not only does it help users monitor the quality of service provided by service providers but also protects service providers from SLA violations.
Workspaces	TrueWatch's collaborative space for data insights. Each workspace operates independently. Users can perform data queries and analyses within workspaces and join one or more workspaces via creation or invitation.
DQL	DQL (Debug Query Language) is TrueWatch's data query language. Users can use DQL query syntax in TrueWatch to query Metrics-type/Log-type data and visualize data charts.
Pipeline	Pipeline is TrueWatch's data processing tool. By defining parsing rules, it supports structuring Metrics, logs, RUM, APM, basic objects, Resource Catalogs, NETWORK, Security Checks, and other data into required structured data.

Client DCA¶

Client DCA (DataKit Control App) is an online DataKit management platform that supports viewing DataKit runtime status and managing configurations for collectors, blacklists, and Pipelines uniformly.

Versions¶

TrueWatch offers Free Plan, Commercial Plan, and Deployment Plan versions.

Version	Description
Free Plan	Register to experience TrueWatch feature modules.
Commercial Plan	Cloud-based SaaS public version, pay-as-you-go, plug-and-play. After installing DataKit, configure relevant data collectors to complete observability access. For billing rules, refer to Billing Method.

Billing¶

TrueWatch provides a dedicated billing account management platform Billing Center where you can recharge accounts, check balances and bill details, bind workspaces, change settlement methods, and more.

For explanations of billing methods and items, refer to the document Billing Method.

Feature	Description
Settlement Methods	TrueWatch fee settlement methods, supporting TrueWatch enterprise accounts, cloud accounts, and more. TrueWatch enterprise account: TrueWatch Billing Center is exclusively used to manage independent accounts related to charges incurred from using TrueWatch products. One enterprise account can be associated with multiple workspace billings. Cloud Accounts: TrueWatch Billing Center supports Amazon cloud accounts, Alibaba Cloud accounts, and Huawei Cloud accounts. Users can choose to bind cloud accounts for fee settlements.
Account Management	TrueWatch Billing Center account management, including account profile changes, password modifications, real-name authentication, and cloud account management.
Workspace Management	TrueWatch Billing Center account-bound workspace management. An account can bind multiple TrueWatch workspaces. Workspace management allows modifying TrueWatch workspace settlement methods.
Bill Management	TrueWatch Billing Center bill management, including monthly bills, consumption details, income and expenditure details, voucher details, and package details management.
Support Center	TrueWatch Support Center where users can submit and manage tickets. TrueWatch technical expert teams will promptly contact users to resolve issues after receiving tickets.