diff --git a/docs/Data-insights/Features/Applications/application-details.md b/docs/Data-insights/Features/Applications/application-details.md new file mode 100644 index 00000000..e0483ae8 --- /dev/null +++ b/docs/Data-insights/Features/Applications/application-details.md @@ -0,0 +1,64 @@ +# Application Details + +The **Application Details** view breaks a single application down by operation, with ranked operations, per-operation metric graphs, and the traces behind them. + +Navigate to **Applications** > **Application Details** from the left-hand sidebar. The view has two tabs, **Overview** and **Info** - this page covers **Overview**. + +--- + +## Filters + +A filter bar runs across the top: + +| Control | What it does | +|---|---| +| **Catalog / Label** | Group by **Catalog** entry or by **Label** | +| **Application** | Select the application to inspect | +| **Show by** | Choose the metric the Top 20 is ranked by (for example **Throughput**) | +| **Select Status** | Filter transactions by HTTP status code | +| **Select Flavor** | Filter by transaction type (for example a web request or JDBC) | +| **Duration** | Filter transactions by duration | +| **Clear all** | Reset the filters | + +--- + +## Top 20 + +The **Top 20** panel on the left ranks the application's operations by the selected **Show by** metric - its heading reflects the choice, for example **Top 20 - Throughput**. Each row shows the operation (such as `www/getquote.cfm`), its total, and a bar for relative volume. + +--- + +## Metrics + +The **Metrics** panel shows five graphs for the application, each broken down by operation over the selected time range: + +- **Time Taken (%)** +- **Avg Response Time** +- **Max Response Time** +- **Throughput** +- **Errors/s** + +A legend under each graph lists the operations. Collapse the panel with the **Metrics** tab on its left edge. + +--- + +## Traces + +Search by **Trace ID** above the table, or browse the **Traces** list of recent transactions: + +| Column | Description | +|---|---| +| **Service** | The service that handled the request - an error icon marks a trace that contains errors | +| **Span Name** | The operation, such as `GET` or `POST`; a trace whose root span has not arrived yet reads *<root span not yet received>* | +| **Spans** | Number of spans in the trace | +| **Services** | Number of services the trace touched | +| **Trace ID** | Unique identifier - click to open the full trace | +| **Timestamp** | When the transaction occurred | +| **Duration** | How long the transaction took | + +The table loads the most recent 100 traces and fetches more as you scroll. + +--- + +!!! question "Need more help?" + Contact support in the chat bubble and let us know how we can assist. diff --git a/docs/Data-insights/Features/Applications/application-map.md b/docs/Data-insights/Features/Applications/application-map.md new file mode 100644 index 00000000..ca457f95 --- /dev/null +++ b/docs/Data-insights/Features/Applications/application-map.md @@ -0,0 +1,54 @@ +# Application Map + +The **Application Map** shows how your servers and applications connect, as a topology you can pan and zoom. + +Navigate to **Applications** > **Application Map** from the left-hand sidebar. + +--- + +## Filtering the map + +A filter bar runs across the top: + +| Control | What it does | +|---|---| +| **Catalog / Label** | Switch between grouping the map by **Catalog** entry or by **Label** | +| **Select servers or apps** | Narrow the map to specific servers or applications | +| **Select Group** | Filter to a group | +| **Select Instance** | Filter to a specific instance | +| **Clear all** | Reset the filters | + +--- + +## The map + +Nodes are collected into groups - for example `Group: otlp-fr-demo · 1 server · 1 application` - with an arrow from each server to the applications running on it. Each node carries a badge for its type, **FR Server** or **FR App**, and a few live metrics: + +- A **server** node shows its instance ID, the number of **Apps**, and **Errors** per second with a sparkline +- An **application** node shows its **Spans** count and **Errors** per second + +The summary in the top-right corner counts what is on the map - servers, applications, and the total. **Left-click** to pan and **scroll** to zoom; the icons at the top-right of the panel switch to a 3D view and expand the map to full screen. + +--- + +## Servers + +Below the map, the **Servers** table lists the servers behind it, one row each: + +| Column | Description | +|---|---| +| **Group** | The group the server belongs to | +| **Job** | The job name | +| **Instance** | The instance ID - click to open it | +| **Apps** | How many applications run on the server | +| **Avg Req** | Average request time | +| **Errors/s** | Errors per second | +| **Throughput** | Requests per second | +| **CPU** | CPU usage | +| **Memory** | Memory usage | +| **Catalog** | The server's catalog status - **Create** if it is not yet in the [Catalog](../../../Admin-and-data/Catalog/catalog.md), or its badges (for example **FR Server**, **Java**) if it is | + +--- + +!!! question "Need more help?" + Contact support in the chat bubble and let us know how we can assist. diff --git a/docs/Data-insights/Features/Applications/info.md b/docs/Data-insights/Features/Applications/info.md new file mode 100644 index 00000000..896f5019 --- /dev/null +++ b/docs/Data-insights/Features/Applications/info.md @@ -0,0 +1,18 @@ +# Info + +The **Info** tab shows an application's catalog information - its owner, tier, and dependencies. + +Navigate to **Applications** > **Info** from the left-hand sidebar, or open the **Info** tab in [Application Details](application-details.md). Use the **Catalog / Label** toggle and the **Application** selector to choose an application. + +--- + +## Catalog information + +When the selected application has a [Catalog](../../../Admin-and-data/Catalog/catalog.md) entry, Info shows what the catalog holds for it - its **owner**, **tier**, and **dependency** information. + +If the application is not yet catalogued, Info shows an empty state - *"This application has no catalog entry, so there is no owner, tier or dependency information for it"* - with an **Add to catalog** button to create one. + +--- + +!!! question "Need more help?" + Contact support in the chat bubble and let us know how we can assist. diff --git a/docs/Data-insights/Features/Applications/overview.md b/docs/Data-insights/Features/Applications/overview.md new file mode 100644 index 00000000..98bc4947 --- /dev/null +++ b/docs/Data-insights/Features/Applications/overview.md @@ -0,0 +1,49 @@ +# Applications Overview + +Monitor and analyze your application performance and behavior. + +Navigate to **Applications** > **Applications Overview** from the left-hand sidebar to view performance metrics across all your instrumented applications. + +--- + +## The applications table + +Your instrumented applications are listed in a single **Applications** table, one row per application with its key metrics over the selected time range. Use the **Application Filter** to search for a specific application by name. + +The metric columns show a sparkline alongside the current value: + +| Column | Description | +|---|---| +| **Application** | The application name | +| **Span Name Count** | The number of distinct span (operation) names recorded for the application | +| **Top Time Taken** | The highest time-taken percentage among the application's operations | +| **Avg Response** | Average response time across all transactions | +| **Max Response** | The slowest response time recorded in the period | +| **Throughput** | Requests per minute (c/m) | +| **Errors/s** | Errors per second | +| **Catalog** | **Create** adds the application to your [Catalog](../../../Admin-and-data/Catalog/catalog.md) | + +--- + +## Expanding an application + +Click the arrow at the start of an application's row to expand it into five graphs, each breaking a metric down by span (operation) name over the selected time range: + +- **Time Taken (%)** +- **Avg Response Time** +- **Max Response Time** +- **Throughput** +- **Errors/s** + +A legend under each graph lists the operations (for example `www.getquote.cfm` and `www.health.cfm`). Hover over any graph to see the values at a specific point in time. + +--- + +## Time range + +Use the **time picker** in the top right to adjust the time range for all graphs on the page - it defaults to the **Last 1 hour**. You can also highlight a section of a graph to zoom into that timeframe, and **Clear all** resets the filters. + +--- + +!!! question "Need more help?" + Contact support in the chat bubble and let us know how we can assist. diff --git a/docs/Data-insights/Features/applications.md b/docs/Data-insights/Features/applications.md deleted file mode 100644 index 11c791fb..00000000 --- a/docs/Data-insights/Features/applications.md +++ /dev/null @@ -1,90 +0,0 @@ -# Applications - - -![Applications overview](../../Data-insights/Features/images/Applications/new-applications-overview.png) - - -Monitor and analyze your application performance and behavior. - -Navigate to **Applications** from the left-hand sidebar to view performance metrics across all your instrumented applications. - ---- - -## Overview - -The Applications page displays an **Overview** of your applications, with two tabs: - -- **Servers** - view metrics grouped by server -- **Applications** - view metrics grouped by application - -Use the **Application Filter** to search for a specific application by name. - ---- - -## Metrics cards - -Each application is displayed as a set of metric cards showing performance data over the selected time range: - -| Metric | Description | -|---|---| -| **Time Taken (%)** | Percentage of time the application spent processing requests | -| **Average Response Time** | Average response time across all transactions | -| **Max Response Time** | The slowest response time recorded in the period | -| **Throughput** | Number of requests per minute (c/m) | -| **Error Count** | Number of errors returned by the application | - -Each card displays a time-series graph. Hover over any graph to see the values at a specific point in time. - ---- - -## Time range - -Use the **time picker** in the top right to adjust the time range for all graphs on the page. You can also highlight a specific section of a graph to zoom into that timeframe. - ---- - -## Application detail view - -Clicking into an application opens the detail view, showing deeper performance data for that specific application. - -### Filters - -| Filter | Description | -|---|---| -| **Application** | The selected application (e.g. QuoteCF) | -| **Show by** | Switch the top 20 ranking between Throughput, Average Response Time, Max Response Time, and Error Count | -| **Status** | Filter transactions by HTTP status code | -| **Flavor** | Filter by transaction type (e.g. web request, JDBC) | -| **Min / Max Duration** | Filter transactions by duration range | -| **Adhoc Filters** | Add custom label-based filters | - -### Top 20 - -The **Top 20** panel on the left ranks individual transactions by the selected **Show by** metric, with a bar chart showing relative volume. - -### Metrics graphs - -The same five metrics cards from the overview are shown here, scoped to the selected application: - -- Time Taken (%) -- Average Response Time -- Max Response Time -- Throughput -- Error Count - -### Traces - -Below the graphs, a **Traces** table lists recent transactions with: - -| Column | Description | -|---|---| -| **Trace ID** | Unique identifier - click to open the full trace | -| **Start time** | When the transaction began | -| **Service** | The service that handled the request | -| **Name** | HTTP method (GET, POST, etc.) | -| **Duration** | How long the transaction took | - ---- - -!!! question "Need more help?" - Contact support in the chat bubble and let us know how we can assist. diff --git a/mkdocs.yml b/mkdocs.yml index 1152f4aa..6374cfd4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -113,7 +113,11 @@ nav: - Info: Data-insights/Features/Servers/info.md - Crash Protection: Data-insights/Features/Servers/crash-protection.md - FAQ: Data-insights/Features/Servers/faq.md - - Applications: Data-insights/Features/applications.md + - Applications: + - Applications Overview: Data-insights/Features/Applications/overview.md + - Application Map: Data-insights/Features/Applications/application-map.md + - Application Details: Data-insights/Features/Applications/application-details.md + - Info: Data-insights/Features/Applications/info.md - Database: Data-insights/Features/database.md - Services: - Overview: Data-insights/Features/Services/overview.md @@ -335,6 +339,7 @@ plugins: 'release-notes.md': 'Latest-updates/release-notes.md' 'Getting-started/DVCloud.md' : 'index.md' 'OP-billing/licenses.md' : 'Admin-and-data/Billing/Cloud/overview.md' + 'Data-insights/Features/applications.md' : 'Data-insights/Features/Applications/overview.md' markdown_extensions: