Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/prashant-shahi/shikhandi-topology-generator
This project is a topology JSON generator for Shikandi, light weight load generator for OpenTelemetry.
https://github.com/prashant-shahi/shikhandi-topology-generator
Last synced: 9 days ago
JSON representation
This project is a topology JSON generator for Shikandi, light weight load generator for OpenTelemetry.
- Host: GitHub
- URL: https://github.com/prashant-shahi/shikhandi-topology-generator
- Owner: prashant-shahi
- License: mit
- Created: 2022-07-08T20:38:29.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-07-08T20:51:16.000Z (over 2 years ago)
- Last Synced: 2024-10-05T16:41:38.324Z (3 months ago)
- Language: Python
- Size: 12.7 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Shikhandi Topology Generator
This project is a topology JSON generator for [Shikhandi](https://github.com/srikanthccv/shikhandi),
light weight load generator for OpenTelemetry.
## Usage
```bash
usage: generator.py [-h] -s SERVICE_COUNT [-i MAX_INSTANCE_COUNT] [-r MAX_ROUTE_COUNT] [-d MAX_DOWNSTREAMCALL_COUNT] [-o OUTPUT_TOPOLOGY] [--console]
options:
-h, --help show this help message and exit
-s SERVICE_COUNT, --service-count SERVICE_COUNT
Total number of services
-i MAX_INSTANCE_COUNT, --max-instance-count MAX_INSTANCE_COUNT
Maximum number of instances
-r MAX_ROUTE_COUNT, --max-route-count MAX_ROUTE_COUNT
Maximum number of routes
-d MAX_DOWNSTREAMCALL_COUNT, --max-downstreamcall_count MAX_DOWNSTREAMCALL_COUNT
Maximum downstream calls count
-o OUTPUT_TOPOLOGY, --output-topology OUTPUT_TOPOLOGY
File to write the generated topology JSON
--console Write generated topology JSON on console
```
## How Does It Work?
When running the generator script, `service-count` is mandatory, which
dictates how many services to generate.
The generator assumes that all services form a binary tree such that there are no
cyclic traversals or many random downstream calls. When creating downstream calls,
from any node we traverse to its descendants service nodes randomly.
```mermaid
graph TD;
S0-->S1;
S0-->S2;
S1-->S3;
S1-->S4;
S2-->S5;
S2-->S6;
```
For each of the services, we randomly generate the following:
- services metadata
- 1-3 instances
- 3 routes for first service and 1-3 routes for other services
- 2 common attribute sets
- 1 random attribute set
- event sets for the first service
_*Note: Feel free to modify the `constants.py` according to your need to generate from custom set of attribute sets and event sets.._
## Examples
To generate topology JSON with 5 services:
```bash
python generator.py -s 5
```
_*Note: Above command generates `topology.json` file with 5 services with default configurations._
To generate topology JSON with 10 services to file `topology-tree.json`:
```bash
python generator.py -s 10 -o topology-tree.json
```
To generate topology JSON with 3 services and print to console:
```bash
python generator.py -s 10 --console
```
# License
MIT License
Copyright (c) 2022 Prashant Shahi