How to use this documentation

Updated

How to use this documentation

This article explains how the LoadGen Load Testing and Monitoring Platform documentation is organized, how every page article is built up, and how the platform's own pages are structured. Five minutes here makes every other article in this category faster to use.

How this category is organized

The documentation mirrors the platform's navigation: one section per module, one article per page.

  • Every module you see in the platform (Testing, API Testing, End-to-End Monitoring, Uptime Monitoring, Service Levels, Alerting, Analytics, Insight, SessionSight, Sync, Operations, Infrastructure) has its own documentation section.
  • Configuration pages are documented in dedicated sections per area, matching the platform's Configuration menu: Configuration (shared building blocks), Configuration LoadGen Agents, Configuration Systems Under Test, Configuration Testing, Configuration API Testing, Configuration End-to-End Monitoring, Configuration Insight, Configuration SessionSight, and Configuration Service Levels.
  • Articles are titled after the module and page they document, in the form "Module: Page". The article for the Run Test page in the Testing module is Testing: Run Test; the article for the Datasources page under Configuration is Configuration: Datasources.
  • The LoadGen Appliance section is the exception to the page-article pattern: it contains deployment and operations guides for the appliance itself (system requirements, per-platform deployment, initial setup, networking, SSL, backup and restore, updates).

So when you want to know something about a page you are looking at in the platform, the fastest route is: note the module and page name, then open the article with that exact title.

How every page article is built up

Every page article in this category follows the same nine blocks, in the same order. Knowing what each block is for tells you exactly where to look:

| Block | What it tells you |

|---|---|

| Overview | What the page is and what it does, in two to five sentences. Read this to confirm you are on the right article. |

| When to use it | The situations and tasks this page is for, as a short list. |

| Before you begin | Prerequisites: licenses, permissions, agents, or configuration that must exist before the page is useful. |

| Controls reference | Every button, link, and control on the page. Each control gets a description plus When to use and Side effects, so you know what happens before you click. |

| Common workflows | The how-to's: complete tasks as numbered step-by-step instructions, each labeled with the persona it is written for (for example load test operator, system administrator, performance analyst). |

| Steps | A walkthrough of the page as you see it on screen, with annotated screenshots. On-screen labels are printed in bold, so you can match the text to the interface. |

| Verify the result | How to confirm the page (or your change) worked: what you should see when everything is correct. |

| Troubleshooting | Known failure modes of this page and what to do about them, for example a disabled button and the conditions that enable it. |

| Related articles | Pointers to neighboring articles. |

How to find a how-to

There are how-to's for every page; they live inside the page articles rather than as separate articles:

1. Know the page, want the task. Open the page's article and go straight to Common workflows. Each workflow is a numbered, self-contained procedure. The Controls reference covers anything a workflow step mentions.

2. Know the task, not the page. Use Help Center search with the words you see on screen or the task name (for example "run test", "maintenance window", "auth profile"). Article titles match the platform's own module and page names, so the right article ranks near the top.

3. Setting things up end to end. Follow Getting started with the LoadGen Platform; it sequences the pages in the order a new environment needs them and links each step to the right article.

4. Troubleshooting something. Go to the page's article and check Troubleshooting first, then Before you begin (most issues are missing prerequisites).

How the platform's pages are built up

The platform itself uses a small number of page patterns. Once you recognize them, every new page feels familiar, and the matching article block is predictable:

  • Navigation. Modules are reached from the navigation menu, with Configuration grouped separately from the operational pages. The documentation sections mirror this split, so the path in the platform and the section in the docs carry the same names.
  • Dashboard pages present KPI cards along the top with detail panels below, plus quick actions that jump into the operational pages. Examples: the Home dashboard's four KPI cards and two feature panels (Main: Home), the Uptime Monitoring: Dashboard, and the cross-feature Analytics: Dashboard.
  • List pages are searchable tables of items with status information, row-level actions, and a create button. When nothing exists yet, the page shows setup guidance instead of an empty table. Examples: Alerting: Triggers, Uptime Monitoring: Checks, API Testing: Flows.
  • Tabbed configuration pages group related settings into tabs on one page. Examples: Operations: Settings (security tokens, AI providers, support, trackers) and Configuration: Datasources (one tab per functional area).
  • Wizards walk multi-step tasks through guided stages. Example: SessionSight: Journeys, which goes from context selection through correlation analysis to export.
  • Live operational pages update in real time while something runs, and combine metrics with operator controls. Example: Testing: Active Test.
  • Calendar and timeline views visualize schedules and history. Examples: the weekly calendar on End-to-End Monitoring: Schedules and the commit timeline with comparison on Sync: History.

The Steps block of each article walks through the page exactly as these patterns render it, screenshot by screenshot.

Conventions used in the articles

  • Bold text in steps and control references quotes a label as it appears on screen (a button, link, card, or field name).
  • Workflows name a persona so you can tell at a glance whether a procedure is meant for operators, administrators, or analysts.
  • Side effects that move you off the page or change system state (for example starting a test) are called out per control in the Controls reference.

Other places in the Help Center

For the platform tour, read What is the LoadGen Load Testing and Monitoring Platform? For first-use setup, read Getting started with the LoadGen Platform.

Was this article helpful?
0 out of 0 found this helpful