Skip to content

Latest commit

 

History

History
62 lines (42 loc) · 4.78 KB

Readme.md

File metadata and controls

62 lines (42 loc) · 4.78 KB

Motor.NET Logo

GitHub GitHub Workflow Status Nuget Codacy Badge

About Motor.NET

Motor.NET is a micro-service framework for .NET built on top of Microsoft Generic Hosting. It provides easy integration of RabbitMQ, Kafka (WIP) and HTTP as well as helpers for logging and tracing.

You should be up and running with just a few lines of code.

Examples

You find working examples for different use-cases under the examples folder.

Support Matrix

Component Consume Publish CloudEvents (Protocol) CloudEvents (JSON) Metrics Compression Custom
RabbitMQ ✔️ ✔️ ✔️ ✔️ ✔️ ✔️ priority, dynamic routing
Kafka ✔️ ✔️ ✔️ ✔️ ✔️ ✔️ partitioning key, dynamic topic
Timer (:heavy_check_mark:) -
SQS (:heavy_check_mark:) -
NATS (:heavy_check_mark:) ✔️ ✔️

CloudEvents (Protocol): If supported, the protocol format uses headers from Kafka or RabbitMQ to store CloudEvent metadata. CloudEvents (JSON): If supported, CloudEvent published in the enveloped variant, see https://github.com/cloudevents/spec/blob/v1.0.1/json-format.md#3-envelope.

Health Checks

Motor.NET comes by default already with two health checks for message processing services (RabbitMQ, Kafka, Timer, and SQS):

  • MessageProcessingHealthCheck: Fails when no messages were consumed in a certain time frame from the Motor.NET internal queue although it has at least some messages.
  • TooManyTemporaryFailuresHealthCheck: Fails when too many messages led to a failure since the last message was correctly handled (either successful or as invalid input).

Compression (Optional)

Gzip compression can optionally be enabled for consumers and publishers. By enabling it for a publisher, the payload of all published messages will be compressed. Enabling it for a consumer will allow the consumer to decompress these messages. Consumers can however still consume uncompressed messages. This should make it easy to enable compression in an existing environment that does not use compression yet. It just needs to be enabled first for the consumers and afterwards for the publishers.

Thread Starvation Handling

Since .NET 6, Environment.ProcessorCount can be overwritten using env DOTNET_PROCESSOR_COUNT, see issue and blog. This can be particularly helpful within container runtimes with cpu resources being limited by cgroups.

License

Motor.NET is provided under the MIT license.