The NATS PubSub connector is one of Conduit plugins. It provides both, a source and a destination NATS PubSub connector.
Run make.
Run make test to run all the unit and integration tests, which require Docker and Docker Compose to be installed and running. The command will handle starting and stopping docker containers for you.
The NATS PubSub connector connects to a NATS server or a cluster with the required parameters urls, subject and mode. If your NATS server has a configured authentication you can pass an authentication details in the connection URL. For example, for a token authentication the url will look like: nats://[email protected]:4222, and for a username/password authentication: nats://username:[email protected]:4222. But if your server is using NKey or Credentials file for authentication you must configure them via seperate configuration parameters.
The connector listening on a subject receives messages published on that subject. If the connector is stopped and restarted after a while, it will not get the messages which were published meanwhile.
The connector can use the wildcard tokens such as * and > to match a single token or to match the tail of a subject.
The position is a random binary marshaled UUIDv4. This is because the NATS PubSub model doesn't persist messages and it's not possible to read messages from a specific position.
The config passed to Configure can contain the following fields.
| name | description | required | default |
|---|---|---|---|
urls |
A list of connection URLs joined by comma. Must be a valid URLs. Examples: nats://127.0.0.1:1222nats://127.0.0.1:1222,nats://127.0.0.1:1223nats://myname:[email protected]:4222nats://[email protected]:4222 |
true | |
subject |
A name of a subject from which or to which the connector should read write. | true | |
connectionName |
Optional connection name which will come in handy when it comes to monitoring | false | conduit-connection-<random_uuid> |
nkeyPath |
A path pointed to a NKey pair. Must be a valid file path. Required if your NATS server is using NKey authentication. | false | |
credentialsFilePath |
A path pointed to a credentials file. Must be a valid file path. Required if your NATS server is using file credentials authentication. | false | |
tls.clientCertPath |
A path pointed to a TLS client certificate, must be present if tls.clientPrivateKeyPath field is also present. Must be a valid file path. Required if your NATS server is using TLS. | false | |
tls.clientPrivateKeyPath |
A path pointed to a TLS client private key, must be present if tls.clientCertPath field is also present. Must be a valid file path. Required if your NATS server is using TLS. | false | |
tls.rootCACertPath |
A path pointed to a TLS root certificate, provide if you want to verify server’s identity. Must be a valid file path | false | |
maxReconnects |
Sets the number of NATS server reconnect attempts that will be tried before giving up. If negative, then it will never give up trying to reconnect. | false | 5 |
reconnectWait |
Sets the time to backoff after attempting a reconnect to a NATS server that the connector was already connected to previously. | false | 5s |
bufferSize |
A buffer size for consumed messages. It must be set to avoid the slow consumers problem. Minimum allowed value is 64 |
false | 1024 |
The connector sends message synchronously, one by one.
The config passed to Configure can contain the following fields.
| name | description | required | default |
|---|---|---|---|
urls |
A list of connection URLs joined by comma. Must be a valid URLs. Examples: nats://127.0.0.1:1222nats://127.0.0.1:1222,nats://127.0.0.1:1223nats://myname:[email protected]:4222nats://[email protected]:4222 |
true | |
subject |
A name of a subject from which or to which the connector should read write. | true | |
connectionName |
Optional connection name which will come in handy when it comes to monitoring | false | conduit-connection-<random_uuid> |
nkeyPath |
A path pointed to a NKey pair. Must be a valid file path. Required if your NATS server is using NKey authentication. | false | |
credentialsFilePath |
A path pointed to a credentials file. Must be a valid file path. Required if your NATS server is using file credentials authentication. | false | |
tls.clientCertPath |
A path pointed to a TLS client certificate, must be present if tls.clientPrivateKeyPath field is also present. Must be a valid file path. Required if your NATS server is using TLS. | false | |
tls.clientPrivateKeyPath |
A path pointed to a TLS client private key, must be present if tls.clientCertPath field is also present. Must be a valid file path. Required if your NATS server is using TLS. | false | |
tls.rootCACertPath |
A path pointed to a TLS root certificate, provide if you want to verify server’s identity. Must be a valid file path | false | |
maxReconnects |
Sets the number of NATS server reconnect attempts that will be tried before giving up. If negative, then it will never give up trying to reconnect. | false | 5 |
reconnectWait |
Sets the time to backoff after attempting a reconnect to a NATS server that the connector was already connected to previously. | false | 5s |