Skip to content

Commit

Permalink
Merge branch 'main' into nim/fix-waf-link
Browse files Browse the repository at this point in the history
  • Loading branch information
ADubhlaoich authored Jan 10, 2025
2 parents 99a45cc + 876f2b9 commit 0808ae3
Show file tree
Hide file tree
Showing 14 changed files with 23 additions and 20 deletions.
12 changes: 6 additions & 6 deletions content/controller/analytics/data-explorer/how-to-use.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,29 +50,29 @@ If you don't see a resource in the list, but you expect it to be there, check th

To view data for a resource, select the resource's name from the resource list.

{{< img src="/controller/analytics/data-explorer/images/data-explorer_resource.png">}}
{{< img src="/ctlr/img/data-explorer_resource.png">}}

## Metrics

The [list of metrics]({{< relref "/controller/analytics/catalogs/metrics.md" >}}) is sorted alphabetically, and you can use the search feature to filter the list. As previously mentioned, the list of metrics depends on the context you've selected for the Data Explorer. For example, if you've chosen Instances for the context, then the list of metrics will be for instances.

{{< img src="/controller/analytics/data-explorer/images/data-explorer_metric.png">}}
{{< img src="/ctlr/img/data-explorer_metric.png">}}

When the selected metric changes, the **Aggregation** and **Group By** selectors are updated correspondingly (as well as the [list of resources](#select-a-resource) and the [Dimensions panel](#dimensions-panel)). Some metrics have different lists of **Aggregation** and **Group By** values. For example, the `http.response_code` dimension, which is a valid **Group By** value for the `http.request.count` metric, is not available for the `nginx.workers.cpu.user` metric because these items are from different contexts and aren't related to each other.

## Aggregation Mode

Use the Aggregation selector -- the &Sigma; symbol with possible values of `AVG`, `MAX`, `MIN`, `RATE`, and `SUM` -- to [aggregate the data]({{< relref "/controller/analytics/metrics/metrics-api.md#aggregations" >}}). The list of possible aggregation values depends on the metrics that's selected.

{{< img src="/controller/analytics/data-explorer/images/data-explorer_aggregation.png">}}
{{< img src="/ctlr/img/data-explorer_aggregation.png">}}

## Group by Dimension

Use the **Group By** selector to [group the data by a chosen dimension]({{< relref "/controller/analytics/metrics/metrics-api.md#groupby" >}}).

In the following example image, the data for the `bytes_rcvd` metric is grouped by the dimension `http.request_method`, which displays a data series for the HTTP methods `DELETE`, `GET`, `LINK`, and so on.

{{< img src="/controller/analytics/data-explorer/images/data-explorer_group-by.png">}}
{{< img src="/ctlr/img/data-explorer_group-by.png">}}

When a **Group By** selection is applied, the chart displays a top-10 data series. For example, let's say you want to check disk usage, so you select the metric `system.disk.total` and `file_path` as the dimension to group by. The chart would then display the top-10 mount points with the highest values. If you have more than 10 mount points, you'll see the top-10 mount points plus an 11th data series that's an aggregation of the rest of the data using the same selection criteria. In other words, you'll see a chart of the 10 most used mount points plus a chart of all the other mount points aggregated into one data series. When a **Group By** dimension is selected, and there are more than 10 dimensions, the 11th data series is named "Other."

Expand All @@ -92,7 +92,7 @@ When you change the time range, the [list of resources](#select-a-resource) is u

Next to the [time range](#time-range) selector, you'll find the `Compare To` list of options. This list allows you to compare data for the selected time frame with data from an earlier period. For example, you may want to view CPU usage for the last hour and compare the results to the same time from yesterday, last week, or even the previous year.

{{< img src="/controller/analytics/data-explorer/images/data-explorer_comparison.png">}}
{{< img src="/ctlr/img/data-explorer_comparison.png">}}

{{< note >}}

Expand All @@ -119,7 +119,7 @@ For instructions on how to understand the Metrics API response, refer to the top

On the right of the screen there is a panel with the list of dimensions available for the [selected metric](#metrics).

{{< img src="/controller/analytics/data-explorer/images/data-explorer_dimensions-drawer.png">}}
{{< img src="/ctlr/img/data-explorer_dimensions-drawer.png">}}

Each dimension is presented as a section in which you can expand and see the values for it. The values are aggregated with the [selected aggregation method](#aggregation-mode) for the [selected time range](#time-range). They depend on the following selected parameters:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,7 @@ docs:
}
```
{{<call-out "note" "Self-signed certificates" "" >}}
For details on using self-signed certificates, see [Configure SSL verification for usage reporting with self-signed certificates]({{< relref "nim/system-configuration/secure-traffic.md#configure-ssl-verify" >}}).
{{</call-out>}}
{{<call-out "note" "Extra steps for self-signed certificates">}}If you use self-signed certificates in your NGINX Instance Manager environment, follow the steps in [Configure SSL verification for usage reporting with self-signed certificates]({{< relref "nim/system-configuration/secure-traffic.md#configure-ssl-verify" >}}).{{</call-out>}}
3. Reload NGINX:
Expand Down
2 changes: 1 addition & 1 deletion content/nap-waf/v4/admin-guide/upgrade-nap-waf.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Upgrade NGINX App Protect by installing the new version of _nms-nap-compiler_ on

Ensure the **nms-integrations** service recognizes both the new and existing _nms-nap-compiler_ versions. Complete this step before upgrading NGINX App Protect on your data planes.

For details on matching NGINX App Protect WAF releases with their WAF compiler versions, refer to the the [WAF Compiler and Supported App Protect Versions](https://docs.nginx.com/nginx-instance-manager/app-protect/setup-waf-config-management/#install-the-waf-compiler) topic.
For details on matching NGINX App Protect WAF releases with their WAF compiler versions, refer to the the [WAF Compiler and Supported App Protect Versions]({{< ref "/nim/nginx-app-protect/setup-waf-config-management.md#install-the-waf-compiler" >}}) topic.

## Upgrade NGINX App Protect on the Data Plane

Expand Down
2 changes: 1 addition & 1 deletion content/nms/acm/getting-started/add-devportal.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ Because these settings are applied at the Infrastructure level, they are conside

Note that many fields in the example JSON payload -- including the logo image and Markdown documents -- are base64-encoded.

**Example JSON payload**: {{< fa "download" >}} {{< link "/nms/acm/getting-started/examples/customize-devportal.json" "customize-devportal.json" >}}
**Example JSON payload**: {{< fa "download" >}} {{< link "/acm/customize-devportal.json" "customize-devportal.json" >}}

Before you move on to the next guide, open the Dev Portal in your browser to view the changes.
You should see the default Dev Portal replaced by the custom settings.
21 changes: 14 additions & 7 deletions content/nms/nginx-agent/install-nginx-plus-advanced-metrics.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,32 @@
---
title: Install NGINX Plus Metrics Module
title: Install NGINX Plus Metrics Module for API Connectivity Manager
description: Follow the steps in this guide to install the F5 NGINX Plus dynamic metrics
module and configure NGINX Agent to push app-centric metrics to NGINX Management
Suite.
module and configure NGINX Agent to push app-centric metrics to API Connectivity Manager.
weight: 110
toc: true
type: how-to
docs: DOCS-1099
---

{{< eol-call-out "warning" "End of Sale Notice:" >}} F5 NGINX is announcing the End of Sale (EoS) for NGINX Instance Manager API Connectivity Manager Module, effective January 1, 2024.

F5 maintains generous lifecycle policies that allow customers to continue support and receive product updates. Existing API Connectivity Manager Module customers can continue to use the product past the EoS date. License renewals are not available after September 30, 2024.

See our End of Sale announcement for more details. {{< /eol-call-out >}}

## Overview

The F5 NGINX Plus metrics module is a dynamic module that you can install on your NGINX Plus data plane instances. The metrics module reports advanced, app-centric metrics and dimensions like “application name” or “gateway” to the NGINX Agent, which then aggregates and publishes the data to the NGINX Management Suite. Advanced, app-centric metrics are used by particular NGINX Management Suite modules for features associated with HTTP requests.
The F5 NGINX Plus metrics module is a dynamic module that you can install on your NGINX Plus data plane instances for use with API Connectivity Manager. The metrics module reports advanced, app-centric metrics and dimensions like “application name” or “gateway” to the NGINX Agent, which then aggregates and publishes the data to API Connectivity Manager. Advanced, app-centric metrics are used by particular API Connectivity Manager for features associated with HTTP requests.

This module is not required or necessary for NGINX Instance Manager.

---

## Before You Begin

Complete the following prerequisites before proceeding with the steps in this guide. This guide assumes that you have NGINX Management Suite installed and configured.
Complete the following prerequisites before proceeding with the steps in this guide. This guide assumes that you have NGINX Management Suite installed and configured with the API Connectivity Manager module.

- Check that your NGINX data plane instances are running **NGINX Plus R24 or later**.
- Check that your NGINX data plane instances are running **NGINX Plus R24** (last supported version of this module is NGINX Plus R33).

To see which version of NGINX Plus is running on your instance, run the following command:

Expand Down Expand Up @@ -92,7 +99,7 @@ Do not push configuration changes to the impacted instance, or any instance grou
sudo apt install nginx-plus-module-metrics
```
### Install from NGINX Management Suite
### Install from NGINX Management Suite (only supported in version 2.18 or earlier)
To install the NGINX Plus metrics module from NGINX Management Suite, use a command-line tool like `curl` or `wget`.
Expand Down
2 changes: 0 additions & 2 deletions content/solutions/about-subscription-licenses.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,6 @@ In environments where NGINX Plus instances cannot access the internet, you'll ne

#### Configure NGINX Plus to report usage to NGINX Instance Manager

{{<call-out "note" "Extra setup for self-signed certificates">}}If your NGINX Instance Manager environment uses self-signed certificates, see [Configure SSL verification for usage reporting with self-signed certificates]({{< relref "nim/system-configuration/secure-traffic.md#configure-ssl-verify" >}}).{{</call-out>}}

To configure NGINX Plus R33 or later to report usage data to NGINX Instance Manger:

{{< include "licensing-and-reporting/configure-nginx-plus-report-to-nim.md" >}}
Expand Down
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes

0 comments on commit 0808ae3

Please sign in to comment.