KX Sensors Documentation

KX Sensors is a high-performance data platform for real-time and historical time series analysis, built on kdb+ for use cases in the energy utilities and manufacturing sectors. This site covers configuration, day-to-day operations, monitoring, and upgrades for KX Sensors v3 and above.

Get started

• About KX Sensors — what KX Sensors is and what this site covers
• What's new — what's different between v2 and v3
• KX Sensors on KDB-X — what changes when KX Sensors runs on KDB-X
• Release notes — release-by-release changes for v3
• Before you begin — upgrade prerequisites and checklist
• KX Sensors application architecture — high-level view of the system components
• Key processes — the core KX Sensors processes and what they do

Core sections

Architecture

KX Sensors uses a layered, extensible architecture built around a core set of processes for ingestion, storage, and query routing. This section covers how the system and its core processes are structured. Highlights:

• Application architecture
• Key processes
• Layered architecture
• KXS directory structure

Develop

The KX Sensors architecture is designed for customization. This section is for developers looking to define custom schemas, ingestion pipelines, and queries. Highlights:

• Tables and schemas
• APIs
• Add an external feed
• Custom packages

Configure and Deploy

Once your schemas and pipelines are defined, this section covers configuring, tuning, and deploying KX Sensors for your environment. Highlights:

• Configure service classes in manifest.yaml
• System parameters systemParams.yaml
• High availability overview
• User authentication

Operate

This section covers day-to-day operation of a running KX Sensors deployment: starting and stopping services, monitoring, and troubleshooting. Highlights:

• About kxsctl
• Using the maintenance console
• Overview of performance monitoring
• Operator-initiated actions