Sandbox - Docs - Twitter - YouTube
Memphis{dev} is an open-source real-time data processing platform
that provides end-to-end support for in-app streaming use cases using Memphis distributed message broker.
Memphis' platform requires zero ops, enables rapid development, extreme cost reduction,
eliminates coding barriers, and saves a great amount of dev time for data-oriented developers and data engineers.
After installing and running memphis broker,
In your project's directory:
go get github.com/memphisdev/memphis.go
import "github.com/memphisdev/memphis.go"
c, err := memphis.Connect("<memphis-host>",
"<application type username>",
"<broker-token>")
It is possible to pass connection configuration parameters, as function-parameters.
// function params
c, err := memphis.Connect("<memphis-host>",
"<application type username>",
"<broker-token>",
memphis.Port(<int>),
memphis.Reconnect(<bool>),
memphis.MaxReconnect(<int>),
// for TLS connection:
memphis.Tls("<cert-client.pem>", "<key-client.pem>", "<rootCA.pem>"),
)
Once connected, all features offered by Memphis are available.
To disconnect from Memphis, call Close() on the Memphis connection object.
c.Close();
Stations can be created from Conn
Passing optional parameters using functions
If a station already exists nothing happens, the new configuration will not be applied
s0, err = c.CreateStation("<station-name>")
s1, err = c.CreateStation("<station-name>",
memphis.RetentionTypeOpt(<Messages/MaxMeMessageAgeSeconds/Bytes>),
memphis.RetentionVal(<int>),
memphis.StorageTypeOpt(<Memory/Disk>),
memphis.Replicas(<int>),
memphis.IdempotencyWindow(<time.Duration>), // defaults to 2 minutes
memphis.SchemaName(<string>),
memphis.SendPoisonMsgToDls(<bool>), // defaults to true
memphis.SendSchemaFailedMsgToDls(<bool>) // defaults to true
)
Memphis currently supports the following types of retention:
memphis.MaxMeMessageAgeSeconds
The above means that every message persists for the value set in the retention value field (in seconds).
memphis.Messages
The above means that after the maximum number of saved messages (set in retention value)
has been reached, the oldest messages will be deleted.
memphis.Bytes
The above means that after maximum number of saved bytes (set in retention value)
has been reached, the oldest messages will be deleted.
Memphis currently supports the following types of messages storage:
memphis.Disk
The above means that messages persist on disk.
memphis.Memory
The above means that messages persist on the main memory.
Destroying a station will remove all its resources (including producers and consumers).
err := s.Destroy();
err := conn.AttachSchema("<schema-name>", "<station-name>")
err := conn.DetachSchema("<station-name>")
The most common client operations are producing messages and consuming messages.
Messages are published to a station and consumed from it
by creating a consumer and calling its Consume function with a message handler callback function.
Consumers are pull-based and consume all the messages in a station
unless you are using a consumers group,
in which case messages are spread across all members in this group.
Memphis messages are payload agnostic. Payloads are byte slices, i.e []byte.
In order to stop receiving messages, you have to call consumer.StopConsume()
.
The consumer will terminate regardless of whether there are messages in flight for the client.
// from a Conn
p0, err := c.CreateProducer(
"<station-name>",
"<producer-name>",
memphis.ProducerGenUniqueSuffix()
)
// from a Station
p1, err := s.CreateProducer("<producer-name>")
p.Produce("<message in []byte or map[string]interface{}/[]byte or protoreflect.ProtoMessage or map[string]interface{}(schema validated station - protobuf)/struct with json tags or map[string]interface{} or interface{}(schema validated station - json schema) or []byte/string (schema validated station - graphql schema)>", memphis.AckWaitSec(15)) // defaults to 15 seconds
hdrs := memphis.Headers{}
hdrs.New()
err := hdrs.Add("key", "value")
p.Produce(
"<message in []byte or map[string]interface{}/[]byte or protoreflect.ProtoMessage or map[string]interface{}(schema validated station - protobuf)/struct with json tags or map[string]interface{} or interface{}(schema validated station - json schema) or []byte/string (schema validated station - graphql schema)>",
memphis.AckWaitSec(15),
memphis.MsgHeaders(hdrs) // defaults to empty
)
Meaning your application won't wait for broker acknowledgement - use only in case you are tolerant for data loss
p.Produce(
"<message in []byte or map[string]interface{}/[]byte or protoreflect.ProtoMessage or map[string]interface{}(schema validated station - protobuf)/struct with json tags or map[string]interface{} or interface{}(schema validated station - json schema) or []byte/string (schema validated station - graphql schema)>",
memphis.AckWaitSec(15),
memphis.AsyncProduce()
)
Stations are idempotent by default for 2 minutes (can be configured), Idempotency achieved by adding a message id
p.Produce(
"<message in []byte or map[string]interface{}/[]byte or protoreflect.ProtoMessage or map[string]interface{}(schema validated station - protobuf)/struct with json tags or map[string]interface{} or interface{}(schema validated station - json schema) or []byte/string (schema validated station - graphql schema)>",
memphis.AckWaitSec(15),
memphis.MsgId("343")
)
p.Destroy();
// creation from a Station
consumer0, err = s.CreateConsumer("<consumer-name>",
memphis.ConsumerGroup("<consumer-group>"), // defaults to consumer name
memphis.PullInterval(<pull interval time.Duration), // defaults to 1 second
memphis.BatchSize(<batch-size int), // defaults to 10
memphis.BatchMaxWaitTime(<time.Duration>), // defaults to 5 seconds, has to be at least 1 ms
memphis.MaxAckTime(<time.Duration>), // defaults to 30 sec
memphis.MaxMsgDeliveries(<int>), // defaults to 10
memphis.ConsumerGenUniqueSuffix(),
memphis.ConsumerErrorHandler(func(*Consumer, error){})
memphis.StartConsumeFromSeq(<uint64>)// start consuming from a specific sequence. defaults to 1
memphis.LastMessages(<int64>)// consume the last N messages, defaults to -1 (all messages in the station)
)
// creation from a Conn
consumer1, err = c.CreateConsumer("<station-name>", "<consumer-name>", ...)
First, create a callback function that receives a slice of pointers to memphis.Msg
and an error.
Then, pass this callback into consumer.Consume
function.
The consumer will try to fetch messages every pullInterval
(that was given in Consumer's creation) and call the defined message handler.
func handler(msgs []*memphis.Msg, err error) {
if err != nil {
m := msgs[0]
fmt.Println(string(m.Data()))
m.Ack()
}
}
consumer.Consume(handler)
You can trigger a single fetch with the Fetch() method
msgs, err := consumer.Fetch()
Acknowledging a message indicates to the Memphis server to not
re-send the same message again to the same consumer or consumers group.
message.Ack();
Get headers per message
headers := msg.GetHeaders()
Get message sequence number
sequenceNumber, err := msg.GetSequenceNumber()
consumer.Destroy();