Skip to content

Commit ece5d40

Browse files
committed
docs: Combine API Benchmarking and Coordinate Generation documentation
1 parent f886d3f commit ece5d40

File tree

4 files changed

+54
-2
lines changed

4 files changed

+54
-2
lines changed

docs/.vitepress/config.js

+1-2
Original file line numberDiff line numberDiff line change
@@ -291,8 +291,7 @@ export default withMermaid(defineVersionedConfig({
291291
{text: 'Tag Filtering', link: '/technical-details/tag-filtering'},
292292
{text: 'Graph Management', link: '/technical-details/graph-repo-client/'},
293293
{text: 'Integration Tests', link: '/technical-details/integration-tests'},
294-
{text: 'Coordinate Generators', link: '/technical-details/coordinate-generators'},
295-
{text: 'API Benchmarks', link: '/technical-details/api-benchmarks'},
294+
{text: 'API Benchmarks', link: '/technical-details/api-benchmarks'}
296295
]
297296
},
298297
{text: 'FAQ', link: '/frequently-asked-questions'}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Openrouteservice API Benchmarks
2+
3+
The Openrouteservice API Benchmarking suite provides tools to measure and optimize the performance of your openrouteservice instance. This toolkit helps you understand how your setup handles load, identifies performance bottlenecks, and assists in capacity planning.
4+
5+
## What Is The Openrouteservice API Benchmarking?
6+
7+
API benchmarking is the process of systematically testing an API's performance under various conditions to:
8+
9+
- Measure response times under different loads
10+
- Determine maximum throughput capabilities
11+
- Identify performance bottlenecks and breaking points
12+
- Compare different configuration settings
13+
- Validate performance requirements
14+
15+
## When To Use These Tools
16+
17+
You should consider using these benchmarking tools when:
18+
19+
- Setting up a new openrouteservice live environment
20+
- Changing hardware resources or configuration
21+
- Testing different routing profiles or algorithms
22+
- Implementing custom models or modifications
23+
- Planning for expected traffic increases
24+
- Troubleshooting performance issues
25+
26+
## Available Tools
27+
28+
The openrouteservice benchmarking suite consists of two main components:
29+
30+
### 1. [Coordinate Generation Tools](./coordinate-generators.md)
31+
32+
These tools help you generate realistic test data as an input for the benchmark tests:
33+
34+
- **Route Generator** - Creates origin-destination coordinate pairs for routing requests
35+
- **Snapping Generator** - Creates coordinates snapped to the road network
36+
37+
### 2. [API Benchmarking Tools](./api-benchmarks.md)
38+
39+
These tools simulate specific scenarios for load and performance testing:
40+
41+
- **Isochrones Range Load Test** - Tests the Isochrones API under various load conditions with range options.
42+
- **Routing Algorithm Load Test** - Tests the Directions API with different routing algorithms and compare the performance.
43+
44+
## Getting Started
45+
46+
To get started with benchmarking your openrouteservice instance:
47+
48+
1. First, prepare your openrouteservice instance or ensure access to a remote API.
49+
2. Use the [Coordinate Generation Tools](./coordinate-generators.md) to create test coordinates for your benchmarking scenarios.
50+
3. Then, use those coordinates to run benchmarks with the [API Benchmarking Tools](./api-benchmarks.md)
51+
4. Analyze the results and adjust your configuration as needed
52+
53+
Both tools provide detailed documentation on usage options and examples to help you create meaningful performance tests for your specific use case.

0 commit comments

Comments
 (0)