Skip to main content
Version: 1.5.1

Synadia Cloud

Managed NATS Message Queue

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

FieldTypeRequiredDescription
namestringYUnique identifier for this target
descriptionstringNHuman-readable description
typestringYMust be synadia
pipelinesarrayNPipeline names to apply before sending
statusbooleanNEnable (true) or disable (false) this target

Synadia Cloud Connection

FieldTypeRequiredDescription
urlstringYSynadia Cloud NATS URL (e.g., nats://connect.ngs.global:4222)
subjectstringYNATS subject name for message publishing
usernamestringYSynadia Cloud account username/NKey
passwordstringYSynadia Cloud account password/JWT
timeoutintegerNConnection timeout in seconds. Default: 30

Batch Configuration

FieldTypeRequiredDescription
batch_sizeintegerNNumber of messages to batch before publishing. Default: 1000
max_retriesintegerNMaximum retry attempts for failed operations. Default: 3
retry_delayintegerNDelay between retry attempts in seconds. Default: 1

TLS Configuration

FieldTypeRequiredDescription
tls.statusbooleanNEnable TLS encryption. Default: false
tls.verifybooleanNVerify server TLS certificate. Default: true
tls.cert_namestringN*Client certificate filename (PEM format)
tls.key_namestringN*Client private key filename (PEM format)
tls.min_tls_versionstringNMinimum TLS version. Default: tls1.2
tls.max_tls_versionstringNMaximum TLS version. Default: tls1.3

* Both cert_name and key_name must be provided together or omitted together

Normalization

FieldTypeRequiredDescription
field_formatstringNApply format normalization (ECS, ASIM, UDM)

Scheduler

FieldTypeRequiredDescription
intervalstring/numericNExecution frequency (realtime by default)
cronstringNCron expression for scheduled execution

Debug Options

FieldTypeRequiredDescription
debug.statusbooleanNEnable debug logging for this target
debug.dont_send_logsbooleanNLog 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
Synadia Cloud Credentials

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
Subject Permissions

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...

targets:
- name: synadia-logs
type: synadia
properties:
url: "nats://connect.ngs.global:4222"
subject: "logs.production"
username: "${SYNADIA_USERNAME}"
password: "${SYNADIA_PASSWORD}"

With NKey Authentication

Using NKey-based authentication for enhanced security...

targets:
- name: synadia-nkey
type: synadia
properties:
url: "nats://connect.ngs.global:4222"
subject: "telemetry.events"
username: "${SYNADIA_NKEY_USER}"
password: "${SYNADIA_NKEY_SEED}"
timeout: 30

High-Volume Configuration

Optimizing for high-volume telemetry ingestion with larger batches...

targets:
- name: synadia-high-volume
type: synadia
properties:
url: "nats://connect.ngs.global:4222"
subject: "metrics.streaming"
username: "${SYNADIA_USERNAME}"
password: "${SYNADIA_PASSWORD}"
batch_size: 1000
max_retries: 3
retry_delay: 1

With TLS Encryption

Enabling TLS encryption for secure data transmission...

targets:
- name: synadia-secure
type: synadia
properties:
url: "nats://connect.ngs.global:4222"
subject: "security.logs"
username: "${SYNADIA_USERNAME}"
password: "${SYNADIA_PASSWORD}"
tls:
status: true
verify: true
min_tls_version: tls1.2
max_tls_version: tls1.3

Multi-Subject Publishing

Publishing different event types to separate subjects...

targets:
- name: synadia-security
type: synadia
properties:
url: "nats://connect.ngs.global:4222"
subject: "logs.security"
username: "${SYNADIA_USERNAME}"
password: "${SYNADIA_PASSWORD}"

- name: synadia-application
type: synadia
properties:
url: "nats://connect.ngs.global:4222"
subject: "logs.application"
username: "${SYNADIA_USERNAME}"
password: "${SYNADIA_PASSWORD}"

With Normalization

Applying ECS normalization before publishing to Synadia Cloud...

targets:
- name: synadia-normalized
type: synadia
properties:
url: "nats://connect.ngs.global:4222"
subject: "logs.normalized"
username: "${SYNADIA_USERNAME}"
password: "${SYNADIA_PASSWORD}"
field_format: ECS

Production Configuration

Production-ready configuration with NKey authentication, TLS encryption, and batch optimization...

targets:
- name: synadia-production
type: synadia
properties:
url: "nats://connect.ngs.global:4222"
subject: "production.telemetry"
username: "${SYNADIA_NKEY_USER}"
password: "${SYNADIA_NKEY_SEED}"
timeout: 30
batch_size: 1000
max_retries: 3
retry_delay: 2
field_format: ASIM
tls:
status: true
verify: true
min_tls_version: tls1.2