Synadia Cloud
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
- name: <string>
description: <string>
type: synadia
pipelines: <pipeline[]>
status: <boolean>
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>
debug:
status: <boolean>
dont_send_logs: <boolean>
Configuration
The following fields are used to define the target:
| Field | Required | Default | Description |
|---|---|---|---|
name | Y | Target name | |
description | N | - | Optional description |
type | Y | Must be synadia | |
pipelines | N | - | Optional post-processor pipelines |
status | N | true | Enable/disable the target |
Connection
| Field | Required | Default | Description |
|---|---|---|---|
url | Y | - | Synadia Cloud NATS URL (e.g., nats://connect.ngs.global:4222) |
subject | Y | - | NATS subject name for message publishing |
username | N | - | Synadia Cloud account username or NKey seed |
password | N | - | Synadia Cloud account password or JWT |
timeout | N | 30 | Connection timeout in seconds |
Batch Configuration
| Field | Required | Default | Description |
|---|---|---|---|
batch_size | N | 1000 | Number of messages to batch before publishing (minimum 1) |
max_retries | N | 3 | Maximum retry attempts for failed publish operations |
retry_delay | N | 1 | Delay between retry attempts in seconds |
Processing
| Field | Required | Default | Description |
|---|---|---|---|
field_format | N | - | Data normalization format. See applicable Normalization section |
TLS Configuration
| Field | Required | Default | Description |
|---|---|---|---|
tls.status | N | false | Enable TLS encryption |
tls.verify | N | true | Verify server TLS certificate |
tls.cert_name | N* | - | Client certificate filename (PEM format) |
tls.key_name | N* | - | Client private key filename (PEM format) |
tls.min_tls_version | N | tls1.2 | Minimum TLS version: tls1.0, tls1.1, tls1.2, tls1.3 |
tls.max_tls_version | N | tls1.3 | Maximum TLS version: tls1.0, tls1.1, tls1.2, tls1.3 |
* = Conditionally required. Both cert_name and key_name must be provided together or omitted together.
Scheduling
See Scheduling and Pool Behavior for interval and cron fields shared by all targets.
Debug Options
| Field | Required | Default | Description |
|---|---|---|---|
debug.status | N | false | Enable debug logging |
debug.dont_send_logs | N | false | Process logs but don't send to target (testing) |
Details
The Synadia Cloud target uses the NATS JetStream protocol to publish log messages. This target shares its implementation with the generic NATS target (type: nats) — the same Go code handles both types. The synadia type is provided for organizational clarity when connecting to Synadia's managed NATS service.
Synadia Cloud supports three credential modes via username and password: traditional username/password, NKey seed (set password to the NKey seed string), and JWT (set password to the JWT token). All three are optional in the YAML — omitting both disables SASL authentication entirely.
The global endpoint nats://connect.ngs.global:4222 routes to the nearest regional cluster. Regional endpoints are available in the Synadia Cloud console for latency-sensitive deployments.
Messages are accumulated in batches and published to NATS JetStream subjects. JetStream must be enabled on the Synadia Cloud account. Each message is published with per-event retry logic up to max_retries attempts, waiting retry_delay seconds between attempts.
Both tls.cert_name and tls.key_name must be provided together when using client certificate authentication. Providing only one will result in a configuration error.
Ensure the Synadia Cloud account has publish permissions for the configured subjects. Permission denials cause publish failures.
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... | |