Rate Limit List

Usage

Full, up-to-date usage information can be found with tilegroxy ratelimit list -h.

Output of tilegroxy ratelimit list -h

Lists the configured rate limit rules matching every filter given, in
the order they're configured. With no filters every rule is listed.

The optional search matches any part of a rule's name, ignoring case.
Each flag matches a rule if it matches any of its values. --layer takes
a layer ID or a name from a tile request, and matches rules the layer
enforces including through extend. --segment matches rules segmented by
the value, or by nothing for "all".

This only reads the configuration, so it works with every store and
doesn't connect to one.

Usage:
  tilegroxy ratelimit list [search] [flags]

The JSON output also includes each rule’s segments and the full list of its overrides.

Flags

Flags
Flag	Type	Default	Description
`-h`, `--help`	bool	`false`	help for list
`--json`	bool	`false`	Output in JSON
`-l`, `--layer`	strings		Only rules enforced on these layers
`-p`, `--policy`	strings		Only rules enforced by these policies, including those they extend
`--segment`	strings		Only rules segmented by these values. One of user, tenant, ip, layer, or all

Global flags

The following global flags are available for supplying your configuration:

  -c, --config string            A file path to the configuration file to use.
                                 The file should have an extension of either
                                 json or yml/yaml and be readable.
                                 (default "./tilegroxy.yml")
      --remote-endpoint string   The endpoint to use to connect to the remote
                                 provider (default "http://127.0.0.1:2379")
      --remote-path string       The path to use to select the configuration
                                 on the remote provider
                                 (default "/config/tilegroxy.yml")
      --remote-provider string   The provider to pull configuration from.
                                 One of: etcd, etcd3, consul, firestore, nats
      --remote-type string       The file format to use to parse the configuration
                                 from the remote provider (default "yaml")

Example

Using the policies from the Rate Limiting example:

tilegroxy ratelimit list -c tilegroxy.yml
tilegroxy ratelimit list -c tilegroxy.yml month --segment tenant

The first command produces an output like:

Rule                    Limit     Period    Overrides    Layers
standard.user.1s        50        1s        0            basemap, satellite
premium.tenant.month    100000    month     0            satellite