Synadia Cloud
Send processed telemetry data to Synadia Cloud managed NATS service.
Synopsis
The Synadia Cloud target publishes log messages to Synadia's managed NATS JetStream service with enterprise features including global distribution, automatic scaling, and managed infrastructure. This target extends the standard NATS configuration with Synadia Cloud-specific endpoints and authentication.
Schema
targets:
- name: <string>
type: synadia
properties:
url: <string>
subject: <string>
username: <string>
password: <string>
timeout: <integer>
batch_size: <integer>
max_retries: <integer>
retry_delay: <integer>
tls:
status: <boolean>
verify: <boolean>
cert_name: <string>
key_name: <string>
min_tls_version: <string>
max_tls_version: <string>
field_format: <string>
interval: <string|numeric>
cron: <string>
debug:
status: <boolean>
dont_send_logs: <boolean>
Configuration
Base Target Fields
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Y | Unique identifier for this target |
description | string | N | Human-readable description |
type | string | Y | Must be synadia |
pipelines | array | N | Pipeline names to apply before sending |
status | boolean | N | Enable (true) or disable (false) this target |
Synadia Cloud Connection
| Field | Type | Required | Description |
|---|---|---|---|
url | string | Y | Synadia Cloud NATS URL (e.g., nats://connect.ngs.global:4222) |
subject | string | Y | NATS subject name for message publishing |
username | string | Y | Synadia Cloud account username/NKey |
password | string | Y | Synadia Cloud account password/JWT |
timeout | integer | N | Connection timeout in seconds. Default: 30 |
Batch Configuration
| Field | Type | Required | Description |
|---|---|---|---|
batch_size | integer | N | Number of messages to batch before publishing. Default: 1000 |
max_retries | integer | N | Maximum retry attempts for failed operations. Default: 3 |
retry_delay | integer | N | Delay between retry attempts in seconds. Default: 1 |
TLS Configuration
| Field | Type | Required | Description |
|---|---|---|---|
tls.status | boolean | N | Enable TLS encryption. Default: false |
tls.verify | boolean | N | Verify server TLS certificate. Default: true |
tls.cert_name | string | N* | Client certificate filename (PEM format) |
tls.key_name | string | N* | Client private key filename (PEM format) |
tls.min_tls_version | string | N | Minimum TLS version. Default: tls1.2 |
tls.max_tls_version | string | N | Maximum TLS version. Default: tls1.3 |
* Both cert_name and key_name must be provided together or omitted together
Normalization
| Field | Type | Required | Description |
|---|---|---|---|
field_format | string | N | Apply format normalization (ECS, ASIM, UDM) |
Scheduler
| Field | Type | Required | Description |
|---|---|---|---|
interval | string/numeric | N | Execution frequency (realtime by default) |
cron | string | N | Cron expression for scheduled execution |
Debug Options
| Field | Type | Required | Description |
|---|---|---|---|
debug.status | boolean | N | Enable debug logging for this target |
debug.dont_send_logs | boolean | N | Log events without sending to Synadia Cloud |
Details
Authentication Methods
NKey Authentication (Recommended):
- Use NKey-based authentication for enhanced security
- Generate NKey credentials through Synadia Cloud console
- Provides cryptographic authentication without password transmission
JWT Authentication:
- JSON Web Token-based authentication
- Supports fine-grained permissions and expiration
- Ideal for service-to-service communication
Username/Password:
- Traditional username/password authentication
- Simpler setup for development and testing
- Use environment variables for credential management
Obtain credentials from Synadia Cloud console. Configure accounts with appropriate subject permissions for the subjects your application publishes to.
Connection Endpoints
Global Endpoints:
nats://connect.ngs.global:4222- Global load-balanced endpoint- Automatically routes to nearest regional cluster
- Recommended for production deployments
Regional Endpoints:
- Specific regional endpoints available for latency optimization
- Configure based on primary data source location
- Check Synadia Cloud documentation for current regional endpoints
JetStream Integration
Synadia Cloud fully supports NATS JetStream features:
- Stream Persistence: Durable message storage
- Message Acknowledgment: Guaranteed delivery semantics
- Message Replay: Historical message retrieval
- Consumer Groups: Load distribution across consumers
Performance Considerations
Batch Optimization:
- Larger batches reduce network overhead
- Balance batch size against latency requirements
- Synadia Cloud handles high-throughput workloads efficiently
Connection Pooling:
- Single connection handles multiple concurrent publishers
- Automatic reconnection on connection loss
- Configurable timeout for connection establishment
Global Distribution:
- Use global endpoint for automatic geographic routing
- Consider regional endpoints for latency-sensitive applications
- Multi-region publishing requires separate target configurations
Ensure Synadia Cloud account has publish permissions for configured subjects. Permission denials result in publish failures.
Security Best Practices
Credential Management:
- Store credentials in environment variables
- Rotate credentials periodically
- Use NKey authentication for enhanced security
TLS Configuration:
- TLS encryption available for sensitive data
- Synadia Cloud supports TLS 1.2 and 1.3
- Client certificates optional for mutual TLS
Examples
Basic Configuration
Sending logs to Synadia Cloud using username/password authentication... | |
With NKey Authentication
Using NKey-based authentication for enhanced security... | |
High-Volume Configuration
Optimizing for high-volume telemetry ingestion with larger batches... | |
With TLS Encryption
Enabling TLS encryption for secure data transmission... | |
Multi-Subject Publishing
Publishing different event types to separate subjects... | |
With Normalization
Applying ECS normalization before publishing to Synadia Cloud... | |
Production Configuration
Production-ready configuration with NKey authentication, TLS encryption, and batch optimization... | |