Devices: Overview

Devices are the first stage in the DataStream processing flow. They receive telemetry from external sources and convert that data to a standardized format for pipeline processing.

Provider → Device → Preprocessing → Pipeline → Postprocessing → Target → Consumer

As such, they are defined using a standardized YAML configuration format that specifies its behavior, connection parameters, and processing options. DataStream uses devices as an abstraction layer that decouples data sources from pipelines.

note

Each device type provides specific configuration options detailed in their respective sections. For GUI-based device management, see Devices Management. To apply reusable collection rules across multiple devices, see Datasets and Profiles.

Definitions

Devices operate on the following principles:

1. Unified Configuration Structure: All devices share a common configuration framework with device-specific properties.
2. Data Collection: Devices receive data through network connections, APIs, or direct system access.
3. Pipeline Integration: Devices can link to preprocessing pipelines for data transformation.
4. Stateful Operation: Devices maintain their operational state and can be enabled or disabled.

note

Devices enable:

Authentication: Basic authentication, API keys, HMAC signing, and client certificates.
Encryption: TLS/SSL, SNMPv3 privacy, and custom encryption.
Firewalling: Source-IP access_list rules on the network and OTLP listeners, applied before parsing and authentication.

They also provide access control, and audit logging.

Configuration

All devices share the following base configuration fields:

Field	Required	Default	Description
id	Y	-	Unique numeric identifier
name	Y	-	Device name
description	N	-	Optional description of the device's purpose
type	Y	-	Device type identifier (e.g., http, syslog, tcp)
tags	N	-	Array of labels for categorization
pipelines	N	-	Array of preprocessing pipeline references (processed sequentially). On Agents, enables local processing before data reaches Director.
status	N	true	Boolean flag to enable/disable the device

tip

Each device type provides specific options detailed in its respective section.

Use the id of the device to refer to it in your configurations.

Example:

devices:
  - id: 1
    name: http_logs
    type: http
    properties:
      port: 8080
      content_type: "application/json"

This is an HTTP device listening on port 8080, and it expects the incoming data to be in JSON format.

Device-to-Pipeline Handoff

When a device receives data, it performs initial format conversion before passing to pipelines:

1. Raw Input: Device receives data in its native protocol format (syslog message, HTTP POST body, Kafka record, etc.)
2. Parsing: Device parses protocol-specific headers and metadata
3. Normalization: Device creates a standardized event structure with common fields (message, host, timestamp)
4. Pipeline Input: Normalized event is passed to any attached preprocessing pipelines (via the pipelines field)

Preprocessing pipelines attached to devices execute sequentially in the order specified. This enables filtering, enrichment, and transformation before data enters the routing stage.

Device Types

Devices are either push-type, where the source connects to DataStream and DataStream listens, or pull-type, where DataStream connects outbound to the source and polls it. Pull-type devices are marked Pull-type in the catalog.

The supported types are grouped by platform and protocol family - cloud services, message queues, databases, analytics platforms, operating systems, network protocols, and honeypots. See Devices: Catalog for the complete list.

Honeypots differ from every other device type: they are decoy services that emulate a real protocol and log each interaction, so they receive no production telemetry. The connection attempt is itself the observation, and captured credentials are recorded in cleartext or as crackable hashes. Several can be deployed together under one shared identity to emulate a complete Active Directory Domain Controller - see Domain Controller.

Use Cases

Devices can be used in the following scenarios:

• Infrastructure monitoring: Provides system performance metrics, event logs, resource utilization, and service availability information.

• Security operations: Enables security event monitoring, threat detection, compliance monitoring, and provides audit trails.

• Application telemetry: Provides application logs and performance metrics, and enables error tracking and user activity monitoring.

• Network monitoring: Provides network device logs and SNMP data, and enables traffic analysis and connection tracking.

Implementation Strategies

The following strategies optimize device deployment and data collection.

Monitoring

For monitoring operating systems, Director uses a unified agent-based approach with two types of deployment. For full deployment details, see Agents.

Managed (Traditional): The agent is installed and managed by system administrators. This provides persistent installation on the target system. Local data is buffered in the emergence of network issues. Director supports Windows, Linux, macOS, Solaris, and AIX.

Auto-managed (Agentless): The agent is automatically deployed and managed, no manual installation is required. Auto-managed agents provide local data buffering, network resilience, and performance optimization. This deployment type is self-healing, since the agent is automatically redeployed if the process terminates. Also, it supports remote credential management. Deployment is done using WinRM for Windows, and SSH for Linux, macOS, Solaris, and AIX.

Both approaches provide local data processing, store-and-forward capability against connectivity issues, real-time metrics and events, and native OS monitoring. The key difference is deployment and lifecycle management, not functionality.

Layered Collectors

Configure multiple devices to handle different aspects of data collection:

• External-facing HTTP endpoints for application logs
• Internal TCP/UDP listeners for network device logs
• Specialized connectors for cloud and security products