Halon Rate Service

This is the documentation for Halon Rate Service halon-rated.

It’s a lightweight clustered sliding window rate limit service using opportunistic UDP for synchronization.

For more advanced use-cases (or where a sliding window rate isn’t needed) softwares like Redis may be more appropriate.

• It is important to note that since the rated daemon is using UDP for syncing the rates it’s not possible to 100% guarantee that packets are never lost, either during the initial sync at startup or during regular operation. Because of this we recommend using the rate function for things where it’s not critical that the rates are always 100% identical in the cluster and that rate data is never lost.

• The aim of the rated process is to be a very simple and fast rate database which is why it has been designed this way. Other solutions might be a better fit if data consistency is very important.

The package consists of one service called halon-rated which can be used to coordinate various rates from within HSL in a cluster. It needs the client library of halon-extras-rate.

Table of contents

• 1. Installation
  • 1.1. Prerequisites
  • 1.2. Distributions
    • 1.2.1. Ubuntu
    • 1.2.2. RHEL
  • 1.3. Startup
  • 1.4. Docker & K8s
• 2. Upgrade
• 3. Configuration
  • 3.1. Startup configuration
    • 3.1.1. Listener directives
    • 3.1.2. Clustering directives
    • 3.1.3. Environment directives
      • 3.1.3.1. Configuration paths
      • 3.1.3.2. Other environment
  • 3.2. Running configuration
    • 3.2.1. Peers directive
• 4. Command line interface
  • 4.1. Configuration management
    • 4.1.1. Reloading configurations
  • 4.2. Rate function

• Changelog