# trooperthorn/solarwinds_orionguides architecture

> Architecture diagram of the GitHub repository trooperthorn/solarwinds_orionguides, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-08). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/trooperthorn/solarwinds_orionguides
- Repository: https://github.com/trooperthorn/solarwinds_orionguides

## Overview

SolarWinds Orion Guides is an offline reference and automation repository for Orion/SolarWinds Observability Self-Hosted: it combines platform guidance, an extracted schema, SWQL examples and tools, plus integrations. A typical user looks up the data model or a verb, writes a SWQL query, checks it against the bundled schema, then uses it in an example or an integration. The graph also preserves the documented Porter transfer utility and Grafana data source. Some app subsystems are represented at directory level because their implementation was not sampled; edges are limited to documented or excerpted relationships.

Main entry points: [`apps/porter`](https://github.com/trooperthorn/solarwinds_orionguides/tree/main/apps/porter) (Porter utility), [`apps/grafana-swis-datasource/pkg/plugin/datasource.go`](https://github.com/trooperthorn/solarwinds_orionguides/blob/main/apps/grafana-swis-datasource/pkg/plugin/datasource.go) (SWIS backend), [`tools/schema_query.py`](https://github.com/trooperthorn/solarwinds_orionguides/blob/main/tools/schema_query.py) (Schema lookup), [`tools/validate_swql.py`](https://github.com/trooperthorn/solarwinds_orionguides/blob/main/tools/validate_swql.py) (SWQL validator)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_reference["Guidance and examples"]
  node_platform_docs["Platform guidance"]
  node_swis_docs["SWIS guidance"]
  node_swql_docs["SWQL guidance"]
  node_automation_docs["Automation guides"]
  node_query_examples["SWQL examples"]
end

subgraph group_schema_tools["Schema and query tools"]
  node_schema_data[("Extracted schema<br/>[2026.2]")]
  node_schema_lookup["Schema lookup<br/>[schema_query.py]"]
  node_swql_validator["SWQL validator<br/>[validate_swql.py]"]
  node_python_client["Python REST client<br/>[swis_client.py]"]
end

subgraph group_porter["Configuration transfer"]
  node_porter_app["Porter utility"]
  node_porter_areas["Transfer areas"]
  node_porter_packages["Package handling<br/>[PackageReader.cs]"]
end

subgraph group_grafana["Grafana integration"]
  node_grafana_editor["Query editor<br/>[QueryEditor.tsx]"]
  node_grafana_datasource["Frontend data source<br/>[datasource.ts]"]
  node_grafana_backend["SWIS backend<br/>[datasource.go]"]
end

node_engineer(("Engineer"))
node_swis_service{{"SWIS service"}}
node_grafana_user(("Grafana user"))

node_engineer -->|"reads"| node_platform_docs
node_engineer -->|"learns connection"| node_swis_docs
node_engineer -->|"learns queries"| node_swql_docs
node_engineer -->|"follows workflows"| node_automation_docs
node_engineer -->|"looks up"| node_schema_lookup
node_schema_lookup -->|"searches"| node_schema_data
node_engineer -->|"checks query"| node_swql_validator
node_swql_validator -->|"validates against"| node_schema_data
node_engineer -->|"copies query"| node_query_examples
node_engineer -->|"runs automation"| node_python_client
node_engineer -->|"transfers configuration"| node_porter_app
node_porter_app -.->|"selects area"| node_porter_areas
node_porter_areas -.->|"uses packages"| node_porter_packages
node_porter_app -->|"moves configuration over"| node_swis_service
node_grafana_user -->|"enters SWQL"| node_grafana_editor
node_grafana_editor -->|"updates query"| node_grafana_datasource
node_grafana_datasource -.->|"sends query"| node_grafana_backend
node_grafana_backend -->|"queries REST API"| node_swis_service
node_grafana_backend -->|"invokes allowlisted verbs"| node_swis_service

click node_platform_docs "https://github.com/trooperthorn/solarwinds_orionguides/tree/main/docs/platform"
click node_swis_docs "https://github.com/trooperthorn/solarwinds_orionguides/tree/main/docs/swis"
click node_swql_docs "https://github.com/trooperthorn/solarwinds_orionguides/tree/main/docs/swql"
click node_automation_docs "https://github.com/trooperthorn/solarwinds_orionguides/tree/main/docs/automation"
click node_schema_data "https://github.com/trooperthorn/solarwinds_orionguides/tree/main/data/schema/2026.2"
click node_schema_lookup "https://github.com/trooperthorn/solarwinds_orionguides/blob/main/tools/schema_query.py"
click node_swql_validator "https://github.com/trooperthorn/solarwinds_orionguides/blob/main/tools/validate_swql.py"
click node_query_examples "https://github.com/trooperthorn/solarwinds_orionguides/tree/main/scripts/swql"
click node_python_client "https://github.com/trooperthorn/solarwinds_orionguides/blob/main/scripts/python/swis_client.py"
click node_porter_app "https://github.com/trooperthorn/solarwinds_orionguides/tree/main/apps/porter"
click node_porter_areas "https://github.com/trooperthorn/solarwinds_orionguides/tree/main/apps/porter/Porter/Areas"
click node_porter_packages "https://github.com/trooperthorn/solarwinds_orionguides/blob/main/apps/porter/Porter/Core/PackageReader.cs"
click node_grafana_editor "https://github.com/trooperthorn/solarwinds_orionguides/blob/main/apps/grafana-swis-datasource/src/components/QueryEditor.tsx"
click node_grafana_datasource "https://github.com/trooperthorn/solarwinds_orionguides/blob/main/apps/grafana-swis-datasource/src/datasource.ts"
click node_grafana_backend "https://github.com/trooperthorn/solarwinds_orionguides/blob/main/apps/grafana-swis-datasource/pkg/plugin/datasource.go"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_platform_docs,node_swis_docs,node_swql_docs,node_automation_docs,node_query_examples,node_grafana_user toneBlue
class node_schema_data,node_schema_lookup,node_swql_validator,node_python_client toneAmber
class node_porter_app,node_porter_areas,node_porter_packages toneMint
class node_grafana_editor,node_grafana_datasource,node_grafana_backend toneRose
class node_engineer,node_swis_service toneIndigo
```

## Components

### Guidance and examples

- [Platform guidance](https://github.com/trooperthorn/solarwinds_orionguides/tree/main/docs/platform): `docs/platform`
- [SWIS guidance](https://github.com/trooperthorn/solarwinds_orionguides/tree/main/docs/swis): `docs/swis`
- [SWQL guidance](https://github.com/trooperthorn/solarwinds_orionguides/tree/main/docs/swql): `docs/swql`
- [Automation guides](https://github.com/trooperthorn/solarwinds_orionguides/tree/main/docs/automation): `docs/automation`
- [SWQL examples](https://github.com/trooperthorn/solarwinds_orionguides/tree/main/scripts/swql): `scripts/swql`

### Schema and query tools

- [Extracted schema](https://github.com/trooperthorn/solarwinds_orionguides/tree/main/data/schema/2026.2): `data/schema/2026.2`
- [Schema lookup](https://github.com/trooperthorn/solarwinds_orionguides/blob/main/tools/schema_query.py): `tools/schema_query.py`
- [SWQL validator](https://github.com/trooperthorn/solarwinds_orionguides/blob/main/tools/validate_swql.py): `tools/validate_swql.py`
- [Python REST client](https://github.com/trooperthorn/solarwinds_orionguides/blob/main/scripts/python/swis_client.py): `scripts/python/swis_client.py`

### Configuration transfer

- [Porter utility](https://github.com/trooperthorn/solarwinds_orionguides/tree/main/apps/porter): `apps/porter`
- [Transfer areas](https://github.com/trooperthorn/solarwinds_orionguides/tree/main/apps/porter/Porter/Areas): `apps/porter/Porter/Areas`
- [Package handling](https://github.com/trooperthorn/solarwinds_orionguides/blob/main/apps/porter/Porter/Core/PackageReader.cs): `apps/porter/Porter/Core/PackageReader.cs`

### Grafana integration

- [Query editor](https://github.com/trooperthorn/solarwinds_orionguides/blob/main/apps/grafana-swis-datasource/src/components/QueryEditor.tsx): `apps/grafana-swis-datasource/src/components/QueryEditor.tsx`
- [Frontend data source](https://github.com/trooperthorn/solarwinds_orionguides/blob/main/apps/grafana-swis-datasource/src/datasource.ts): `apps/grafana-swis-datasource/src/datasource.ts`
- [SWIS backend](https://github.com/trooperthorn/solarwinds_orionguides/blob/main/apps/grafana-swis-datasource/pkg/plugin/datasource.go): `apps/grafana-swis-datasource/pkg/plugin/datasource.go`

### Other components

- **Engineer**
- **SWIS service**
- **Grafana user**

## Connections

- Engineer → Platform guidance: reads (evidence: `README.md`)
- Engineer → SWIS guidance: learns connection (evidence: `README.md`)
- Engineer → SWQL guidance: learns queries (evidence: `README.md`)
- Engineer → Automation guides: follows workflows (evidence: `README.md`)
- Engineer → Schema lookup: looks up (evidence: `README.md`)
- Schema lookup → Extracted schema: searches (evidence: `README.md`)
- Engineer → SWQL validator: checks query (evidence: `README.md`)
- SWQL validator → Extracted schema: validates against (evidence: `README.md`)
- Engineer → SWQL examples: copies query (evidence: `README.md`)
- Engineer → Python REST client: runs automation (evidence: `README.md`)
- Engineer → Porter utility: transfers configuration (evidence: `README.md`)
- Porter utility → Transfer areas: selects area (evidence: `apps/porter/Porter/Areas/NodesCpProvider.cs`)
- Transfer areas → Package handling: uses packages (evidence: `apps/porter/Porter/Core/PackageReader.cs`)
- Porter utility → SWIS service: moves configuration over (evidence: `README.md`)
- Grafana user → Query editor: enters SWQL (evidence: `apps/grafana-swis-datasource/src/components/QueryEditor.tsx`)
- Query editor → Frontend data source: updates query (evidence: `apps/grafana-swis-datasource/src/components/QueryEditor.tsx`)
- Frontend data source → SWIS backend: sends query
- SWIS backend → SWIS service: queries REST API (evidence: `apps/grafana-swis-datasource/pkg/plugin/datasource.go`)
- SWIS backend → SWIS service: invokes allowlisted verbs (evidence: `apps/grafana-swis-datasource/pkg/plugin/datasource.go`)
