internal/beater/config/ratelimit.go

// Licensed to Elasticsearch B.V. under one or more contributor
// license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright
// ownership. Elasticsearch B.V. licenses this file to you under
// the Apache License, Version 2.0 (the "License"); you may
// not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

package config

// RateLimit holds configuration related to IP and event rate limiting.
type RateLimit struct {
	// EventLimit holds the event rate limit per IP, measured in
	// events per second.
	EventLimit int `config:"event_limit"`

	// IPLimit holds the maximum number of client IPs for which we
	// will maintain a distinct event rate limit. Once this has been
	// reached, clients will begin sharing rate limiters. This is
	// done to avoid DDoS attacks.
	IPLimit int `config:"ip_limit"`
}