2024-09-10 14:24:46 -07:00
# Function calling
2024-12-06 13:44:22 -08:00
Rename all arch references to plano across the codebase
Complete rebrand from "Arch"/"archgw" to "Plano" including:
- Config files: arch_config_schema.yaml, workflow, demo configs
- Environment variables: ARCH_CONFIG_* → PLANO_CONFIG_*
- Python CLI: variables, functions, file paths, docker mounts
- Rust crates: config paths, log messages, metadata keys
- Docker/build: Dockerfile, supervisord, .dockerignore, .gitignore
- Docker Compose: volume mounts and env vars across all demos/tests
- GitHub workflows: job/step names
- Shell scripts: log messages
- Demos: Python code, READMEs, VS Code configs, Grafana dashboard
- Docs: RST includes, code comments, config references
- Package metadata: package.json, pyproject.toml, uv.lock
External URLs (docs.archgw.com, github.com/katanemo/archgw) left as-is.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-11 20:15:37 -08:00
This demo shows how you can use Plano's core function calling capabilities.
2024-09-10 14:24:46 -07:00
2024-09-24 14:34:22 -07:00
# Starting the demo
2024-12-06 13:44:22 -08:00
2024-10-10 17:50:57 -07:00
1. Please make sure the [pre-requisites ](https://github.com/katanemo/arch/?tab=readme-ov-file#prerequisites ) are installed correctly
Rename all arch references to plano across the codebase
Complete rebrand from "Arch"/"archgw" to "Plano" including:
- Config files: arch_config_schema.yaml, workflow, demo configs
- Environment variables: ARCH_CONFIG_* → PLANO_CONFIG_*
- Python CLI: variables, functions, file paths, docker mounts
- Rust crates: config paths, log messages, metadata keys
- Docker/build: Dockerfile, supervisord, .dockerignore, .gitignore
- Docker Compose: volume mounts and env vars across all demos/tests
- GitHub workflows: job/step names
- Shell scripts: log messages
- Demos: Python code, READMEs, VS Code configs, Grafana dashboard
- Docs: RST includes, code comments, config references
- Package metadata: package.json, pyproject.toml, uv.lock
External URLs (docs.archgw.com, github.com/katanemo/archgw) left as-is.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-11 20:15:37 -08:00
2. Start Plano
2024-10-10 17:50:57 -07:00
2024-12-06 13:44:22 -08:00
3. ```sh
2024-10-09 15:53:12 -07:00
sh run_demo.sh
2024-09-11 11:37:53 -07:00
```
2024-10-10 17:50:57 -07:00
4. Navigate to http://localhost:18080/
5. You can type in queries like "how is the weather?"
2024-09-10 14:25:52 -07:00
2024-09-24 11:51:31 -07:00
# Observability
2024-12-06 13:44:22 -08:00
Rename all arch references to plano across the codebase
Complete rebrand from "Arch"/"archgw" to "Plano" including:
- Config files: arch_config_schema.yaml, workflow, demo configs
- Environment variables: ARCH_CONFIG_* → PLANO_CONFIG_*
- Python CLI: variables, functions, file paths, docker mounts
- Rust crates: config paths, log messages, metadata keys
- Docker/build: Dockerfile, supervisord, .dockerignore, .gitignore
- Docker Compose: volume mounts and env vars across all demos/tests
- GitHub workflows: job/step names
- Shell scripts: log messages
- Demos: Python code, READMEs, VS Code configs, Grafana dashboard
- Docs: RST includes, code comments, config references
- Package metadata: package.json, pyproject.toml, uv.lock
External URLs (docs.archgw.com, github.com/katanemo/archgw) left as-is.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-11 20:15:37 -08:00
Plano gateway publishes stats endpoint at http://localhost:19901/stats. In this demo we are using prometheus to pull stats from Plano and we are using grafana to visalize the stats in dashboard. To see grafana dashboard follow instructions below,
2024-09-24 11:51:31 -07:00
1. Start grafana and prometheus using following command
```yaml
docker compose --profile monitoring up
```
2024-12-06 13:44:22 -08:00
2. Navigate to http://localhost:3000/ to open grafana UI (use admin/grafana as credentials)
Rename all arch references to plano across the codebase
Complete rebrand from "Arch"/"archgw" to "Plano" including:
- Config files: arch_config_schema.yaml, workflow, demo configs
- Environment variables: ARCH_CONFIG_* → PLANO_CONFIG_*
- Python CLI: variables, functions, file paths, docker mounts
- Rust crates: config paths, log messages, metadata keys
- Docker/build: Dockerfile, supervisord, .dockerignore, .gitignore
- Docker Compose: volume mounts and env vars across all demos/tests
- GitHub workflows: job/step names
- Shell scripts: log messages
- Demos: Python code, READMEs, VS Code configs, Grafana dashboard
- Docs: RST includes, code comments, config references
- Package metadata: package.json, pyproject.toml, uv.lock
External URLs (docs.archgw.com, github.com/katanemo/archgw) left as-is.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-11 20:15:37 -08:00
3. From grafana left nav click on dashboards and select "Intelligent Gateway Overview" to view Plano gateway stats
2024-09-24 11:51:31 -07:00
2024-10-08 23:58:55 -07:00
Here is a sample interaction,
2024-09-10 14:25:52 -07:00
< img width = "575" alt = "image" src = "https://github.com/user-attachments/assets/e0929490-3eb2-4130-ae87-a732aea4d059" >
2024-12-06 13:44:22 -08:00
## Tracing
To see a tracing dashboard follow instructions below,
1. For Jaeger, you can either use the default run_demo.sh script or run the following command:
```sh
sh run_demo.sh jaeger
```
2. For Logfire, first make sure to add a LOGFIRE_API_KEY to the .env file. You can either use the default run_demo.sh script or run the following command:
```sh
sh run_demo.sh logfire
```
3. For Signoz, you can either use the default run_demo.sh script or run the following command:
```sh
sh run_demo.sh signoz
```
If using Jaeger, navigate to http://localhost:16686/ to open Jaeger UI
If using Signoz, navigate to http://localhost:3301/ to open Signoz UI
If using Logfire, navigate to your logfire dashboard that you got the write key from to view the dashboard
### Stopping Demo
2024-12-06 14:02:41 -08:00
1. To end the demo, run the following command:
```sh
sh run_demo.sh down
```