content.md 8.7 KB
NATS Streaming: A high-performance cloud native messaging streaming system.
%%LOGO%%
nats-streaming is a high performance streaming server for the NATS Messaging System.
Example usage
# Run a NATS Streaning server
# Each server exposes multiple ports
# 4222 is for clients.
# 8222 is an HTTP management port for information reporting.
# use -p or -P as needed.
$ docker run -d nats-streaming
Output that you would get if you had started with `-ti` instead of `d` (for daemon):
[1] 2017/01/19 20:27:37.540307 [INF] Starting nats-streaming-server[test-cluster] version 0.3.8
[1] 2017/01/19 20:27:37.540462 [INF] Starting nats-server version 0.9.6
[1] 2017/01/19 20:27:37.540493 [INF] Starting http monitor on 0.0.0.0:8222
[1] 2017/01/19 20:27:37.540550 [INF] Listening for client connections on 0.0.0.0:4222
[1] 2017/01/19 20:27:37.540574 [INF] Server is ready
[1] 2017/01/19 20:27:37.825728 [INF] STAN: Message store is MEMORY
[1] 2017/01/19 20:27:37.825798 [INF] STAN: --------- Store Limits ---------
[1] 2017/01/19 20:27:37.825828 [INF] STAN: Channels: 100 *
[1] 2017/01/19 20:27:37.825853 [INF] STAN: -------- channels limits -------
[1] 2017/01/19 20:27:37.825859 [INF] STAN: Subscriptions: 1000 *
[1] 2017/01/19 20:27:37.825864 [INF] STAN: Messages : 1000000 *
[1] 2017/01/19 20:27:37.825876 [INF] STAN: Bytes : 976.56 MB *
[1] 2017/01/19 20:27:37.825945 [INF] STAN: Age : unlimited *
[1] 2017/01/19 20:27:37.825949 [INF] STAN: --------------------------------
To use a file based store instead, you would run:
$ docker run -d nats-streaming -store file -dir datastore
[1] 2017/01/19 20:28:45.169437 [INF] Starting nats-streaming-server[test-cluster] version 0.3.8
[1] 2017/01/19 20:28:45.169722 [INF] Starting nats-server version 0.9.6
[1] 2017/01/19 20:28:45.169748 [INF] Listening for client connections on 0.0.0.0:4222
[1] 2017/01/19 20:28:45.169816 [INF] Server is ready
[1] 2017/01/19 20:28:45.449668 [INF] STAN: Message store is FILE
[1] 2017/01/19 20:28:45.449705 [INF] STAN: --------- Store Limits ---------
[1] 2017/01/19 20:28:45.449714 [INF] STAN: Channels: 100 *
[1] 2017/01/19 20:28:45.449719 [INF] STAN: -------- channels limits -------
[1] 2017/01/19 20:28:45.449724 [INF] STAN: Subscriptions: 1000 *
[1] 2017/01/19 20:28:45.449729 [INF] STAN: Messages : 1000000 *
[1] 2017/01/19 20:28:45.449799 [INF] STAN: Bytes : 976.56 MB *
[1] 2017/01/19 20:28:45.449805 [INF] STAN: Age : unlimited *
[1] 2017/01/19 20:28:45.449828 [INF] STAN: --------------------------------
You can also connect to a remote NATS Server running in a docker image.
First, run NATS Server:
$ docker run -d --name=nats-main nats
Now, start the Streaming server and link it to the above docker image:
$ docker run -d --link nats-main nats-streaming -store file -dir datastore -ns nats://nats-main:4222
[1] 2017/01/19 20:29:19.178044 [INF] Starting nats-streaming-server[test-cluster] version 0.3.8
[1] 2017/01/19 20:29:19.459272 [INF] STAN: Message store is FILE
[1] 2017/01/19 20:29:19.459322 [INF] STAN: --------- Store Limits ---------
[1] 2017/01/19 20:29:19.459336 [INF] STAN: Channels: 100 *
[1] 2017/01/19 20:29:19.459343 [INF] STAN: -------- channels limits -------
[1] 2017/01/19 20:29:19.459351 [INF] STAN: Subscriptions: 1000 *
[1] 2017/01/19 20:29:19.459375 [INF] STAN: Messages : 1000000 *
[1] 2017/01/19 20:29:19.459396 [INF] STAN: Bytes : 976.56 MB *
[1] 2017/01/19 20:29:19.459407 [INF] STAN: Age : unlimited *
[1] 2017/01/19 20:29:19.459413 [INF] STAN: --------------------------------
Notice that the output shows that the NATS Server was not started, as opposed to the first output.
Commandline Options
Streaming Server Options:
-cid, --cluster_id <cluster ID> Cluster ID (default: test-cluster)
-st, --store <type> Store type: MEMORY|FILE (default: MEMORY)
--dir <directory> For FILE store type, this is the root directory
-mc, --max_channels <number> Max number of channels (0 for unlimited)
-msu, --max_subs <number> Max number of subscriptions per channel (0 for unlimited)
-mm, --max_msgs <number> Max number of messages per channel (0 for unlimited)
-mb, --max_bytes <number> Max messages total size per channel (0 for unlimited)
-ma, --max_age <seconds> Max duration a message can be stored ("0s" for unlimited)
-ns, --nats_server <url> Connect to this external NATS Server (embedded otherwise)
-sc, --stan_config <file> Streaming server configuration file
-hbi, --hb_interval <duration> Interval at which server sends heartbeat to a client
-hbt, --hb_timeout <duration> How long server waits for a heartbeat response
-hbf, --hb_fail_count <number> Number of failed heartbeats before server closes the client connection
Streaming Server File Store Options:
--file_compact_enabled Enable file compaction
--file_compact_frag File fragmentation threshold for compaction
--file_compact_interval <int> Minimum interval (in seconds) between file compactions
--file_compact_min_size <int> Minimum file size for compaction
--file_buffer_size <int> File buffer size (in bytes)
--file_crc Enable file CRC-32 checksum
--file_crc_poly <int> Polynomial used to make the table used for CRC-32 checksum
--file_sync Enable File.Sync on Flush
--file_slice_max_msgs Maximum number of messages per file slice (subject to channel limits)
--file_slice_max_bytes Maximum file slice size - including index file (subject to channel limits)
--file_slice_max_age Maximum file slice duration starting when the first message is stored (subject to channel limits)
--file_slice_archive_script Path to script to use if you want to archive a file slice being removed
Streaming Server TLS Options:
-secure Use a TLS connection to the NATS server without
verification; weaker than specifying certificates.
-tls_client_key Client key for the streaming server
-tls_client_cert Client certificate for the streaming server
-tls_client_cacert Client certificate CA for the streaming server
Streaming Server Logging Options:
-SD, --stan_debug Enable STAN debugging output
-SV, --stan_trace Trace the raw STAN protocol
-SDV Debug and trace STAN
(See additional NATS logging options below)
Embedded NATS Server Options:
-a, --addr <host> Bind to host address (default: 0.0.0.0)
-p, --port <port> Use port for clients (default: 4222)
-P, --pid <file> File to store PID
-m, --http_port <port> Use port for http monitoring
-ms,--https_port <port> Use port for https monitoring
-c, --config <file> Configuration file
Logging Options:
-l, --log <file> File to redirect log output
-T, --logtime Timestamp log entries (default: true)
-s, --syslog Enable syslog as log method
-r, --remote_syslog <addr> Syslog server addr (udp://localhost:514)
-D, --debug Enable debugging output
-V, --trace Trace the raw protocol
-DV Debug and trace
Authorization Options:
--user <user> User required for connections
--pass <password> Password required for connections
--auth <token> Authorization token required for connections
TLS Options:
--tls Enable TLS, do not verify clients (default: false)
--tlscert <file> Server certificate file
--tlskey <file> Private key for server certificate
--tlsverify Enable TLS, verify client certificates
--tlscacert <file> Client certificate CA for verification
NATS Clustering Options:
--routes <rurl-1, rurl-2> Routes to solicit and connect
--cluster <cluster-url> Cluster URL for solicited routes
Common Options:
-h, --help Show this message
-v, --version Show version
--help_tls TLS help.
Configuration
Details on how to configure further the NATS Streaming server can be found here