Test :: tilegroxy docs

Usage

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

Output of tilegroxy test -h

Tests that everything is working end-to-end for all or some layers including caching. This goes further than 'config check' and instead of just validating the configuration can be parsed it actually makes sample request(s) and populates the result in the cache. This is similar to running 'seed' for a single tile or standing up the server and making a cURL request for each layer. The output will list each layer and the status, with any error encountered if applicable.

If you don't specify a tile coordinate with -z/-x/-y, one is picked automatically for each layer. A layer with a center configured uses the tile containing that point, at the center's zoom if it has one. Otherwise the tile comes from its configured bounds and minzoom/maxzoom. A layer with no center, bounds, or zoom range configured falls back to a fixed default tile that might be outside the area your layer actually serves

A layer using a pattern is tested through its "examples" configurations if available. A pattern layer with no examples configured is skipped with a warning.

Use --file to write a summary to a file. The standard output will still render in stdout, use a bash redirect if you want that in a file. If using both --file and --json, only the file output will be in JSON

Usage:
  tilegroxy test [flags]

Flags

Flags
Flag	Type	Default	Description
`-f`, `--file`	string		Write a run summary to this file. The file is JSON if --json is set, otherwise plain text
`-h`, `--help`	bool	`false`	help for test
`--json`	bool	`false`	Output in JSON. If used with --file this only outputs the written file, not standard out
`-l`, `--layer`	strings		The ID(s) of the layer to test. Tests all layers by default
`--no-cache`	bool	`false`	Don’t write to the cache. The Cache configuration must still be syntactically valid
`--tenant`	string		The tenant ID to test as, standing in for what authentication would supply on a real request. Required to test a specific tenant’s tiles when using a tenant cache
`-t`, `--threads`	uint16	`1`	How many layers to test at once. Be mindful of spamming upstream providers
`--user`	string		The user ID to test as, standing in for what authentication would supply on a real request
`-x`, `--x-coordinate`	int	`123`	The x coordinate to use to test
`-y`, `--y-coordinate`	int	`534`	The y coordinate to use to test
`-z`, `--z-coordinate`	uint	`10`	The z coordinate to use to test

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

tilegroxy test -c test_config.yml -l osm -z 10 -x 123 -y 534