Skip to content

Commit 2d3b7c0

Browse files
committed
May 28 updates part 3
1 parent cd1116a commit 2d3b7c0

File tree

6 files changed

+107
-32
lines changed

6 files changed

+107
-32
lines changed
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
docs:
3+
files:
4+
- content/nginx-one/metrics/enable-metrics.md
5+
- content/nginx-one/getting-started.md
6+
---
7+
8+
Navigating the dashboard:
9+
10+
- **Drill down into specifics**: For in-depth information on a specific metric, like expiring certificates, click on the relevant link in the metric's card to go to a detailed overview page.
11+
- **Refine metric timeframe**: Metrics show the last hour's data by default. To view data from a different period, select the time interval you want from the drop-down menu.
12+
13+
<span style="display: inline-block; margin-top: 20px; margin-bottom: 50px;">
14+
{{< img src="nginx-one/images/nginx-one-dashboard.png">}}
15+
</span>
16+
17+
{{<bootstrap-table "table table-striped table-bordered">}}
18+
**NGINX One dashboard metrics**
19+
| Metric | Description | Details |
20+
|---|---|---|
21+
| <i class="fas fa-heartbeat"></i> **Instance availability** | Understand the operational status of your NGINX instances. | - **Online**: The NGINX instance is actively connected and functioning properly. <br> - **Offline**: NGINX Agent is connected but the NGINX instance isn't running, isn't installed, or can't communicate with NGINX Agent. <br> - **Unavailable**: The connection between NGINX Agent and NGINX One has been lost or the instance has been decommissioned. <br> - **Unknown**: The current state can't be determined at the moment. |
22+
| <i class="fas fa-code-branch"></i> **NGINX versions by instance** | See which NGINX versions are in use across your instances. | |
23+
| <i class="fas fa-desktop"></i> **Operating systems** | Find out which operating systems your instances are running on. | |
24+
| <i class="fas fa-certificate"></i> **Certificates** | Monitor the status of your SSL certificates to know which are expiring soon and which are still valid. | |
25+
| <i class="fas fa-cogs"></i> **Config recommendations** | Get configuration recommendations to optimize your instances' settings. | |
26+
| <i class="fas fa-shield-alt"></i> **CVEs (Common Vulnerabilities and Exposures)** | Evaluate the severity and number of potential security threats in your instances. | - **Major**: Indicates a high-severity threat that needs immediate attention. <br> - **Medium**: Implies a moderate threat level. <br> - **Minor** and **Low**: Represent less critical issues that still require monitoring. <br> - **Other**: Encompasses any threats that don't fit the standard categories. |
27+
| <i class="fas fa-microchip"></i> **CPU utilization** | Track CPU usage trends and pinpoint instances with high CPU demand. | |
28+
| <i class="fas fa-memory"></i> **Memory utilization** | Watch memory usage patterns to identify instances using significant memory. | |
29+
| <i class="fas fa-hdd"></i> **Disk space utilization** | Monitor how much disk space your instances are using and identify those nearing capacity. | |
30+
| <i class="fas fa-exclamation-triangle"></i> **Unsuccessful response codes** | Look for instances with a high number of HTTP server errors and investigate their error codes. | |
31+
| <i class="fas fa-tachometer-alt"></i> **Top network usage** | Review the network usage and bandwidth consumption of your instances. | |
32+
33+
{{</bootstrap-table>}}
34+
35+
36+
37+
38+
39+

content/nginx-one/getting-started.md

Lines changed: 13 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,10 @@ To get started using NGINX One, enable the service on F5 Distributed Cloud.
2424

2525
Next, add your NGINX instances to NGINX One. You'll need to create a data plane key and then install NGINX Agent on each instance you want to monitor.
2626

27-
### Add an instance
28-
29-
Depending on whether this is your first time using NGINX One Console or you've used it before, follow the appropriate steps to add an instance:
27+
The following instructions include minimal information, sufficient to "get started." See the following links for detailed instructions:
3028

31-
- **For first-time users:** On the welcome screen, select **Add Instance**.
32-
- **For returning users:** If you've added instances previously and want to add more, select **Instances** on the left menu, then select **Add Instance**.
29+
- [Create and manage data plane keys]({{< ref "nginx-one/connect-instances/data-plane-keys/create-manage-data-plane-keys.md" >}})
30+
- [Add an NGINX instance]({{< ref "nginx-one/nginx-configs/add-instance.md" >}})
3331

3432
### Generate a data plane key {#generate-data-plane-key}
3533

@@ -48,6 +46,13 @@ Data plane keys expire after one year. You can change this expiration date later
4846
[Revoking a data plane key]({{< ref "nginx-one/connect-instances/data-plane-keys/create-manage-data-plane-keys.md#revoke-data-plane-key" >}}) disconnects all instances that were registered with that key.
4947
{{</call-out>}}
5048

49+
### Add an instance
50+
51+
Depending on whether this is your first time using NGINX One Console or you've used it before, follow the appropriate steps to add an instance:
52+
53+
- **For first-time users:** On the welcome screen, select **Add Instance**.
54+
- **For returning users:** If you've added instances previously and want to add more, select **Instances** on the left menu, then select **Add Instance**.
55+
5156

5257
### Install NGINX Agent
5358

@@ -134,37 +139,11 @@ If you followed the [Installation and upgrade](https://docs.nginx.com/nginx-agen
134139
135140
---
136141
137-
## Enable NGINX metrics reporting
138-
139142
The NGINX One Console dashboard relies on APIs for NGINX Plus and NGINX Open Source Stub Status to report traffic and system metrics. The following sections show you how to enable those metrics.
140143
141144
### Enable NGINX Plus API
142145
143-
<!-- possible future include: "/use-cases/monitoring/enable-nginx-plus-api.md" -->
144-
To collect metrics for NGINX Plus, add the following to your NGINX Plus configuration file:
145-
146-
```nginx
147-
# Enable the /api/ location with appropriate access control
148-
# to use the NGINX Plus API.
149-
#
150-
location /api/ {
151-
api write=on;
152-
allow 127.0.0.1;
153-
deny all;
154-
}
155-
```
156-
157-
This configuration:
158-
159-
- Enables the NGINX Plus API.
160-
- Allows requests only from `127.0.0.1` (localhost).
161-
- Blocks all other requests for security.
162-
163-
After saving the changes, reload NGINX to apply the new configuration:
164-
165-
```shell
166-
nginx -s reload
167-
```
146+
{{< include "/use-cases/monitoring/enable-nginx-plus-api.md" >}}
168147
169148
### Enable NGINX Open Source Stub Status API
170149
@@ -183,6 +162,8 @@ After connecting your NGINX instances to NGINX One, you can monitor their perfor
183162
184163
### Overview of the NGINX One dashboard
185164
165+
{{< include "/use-cases/monitoring/n1c-dashboard-overview.md" >}}
166+
186167
Navigating the dashboard:
187168
188169
- **Drill down into specifics**: For in-depth information on a specific metric, like expiring certificates, click on the relevant link in the metric's card to go to a detailed overview page.

content/nginx-one/metrics/_index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
description:
3+
title: Set up metrics
4+
weight: 300
5+
url: /nginx-one/metrics/
6+
---
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
# We use sentence case and present imperative tone
3+
title: "Enable metrics"
4+
# Weights are assigned in increments of 100: determines sorting order
5+
weight: i00
6+
# Creates a table of contents and sidebar, useful for large documents
7+
toc: true
8+
# Types have a 1:1 relationship with Hugo archetypes, so you shouldn't need to change this
9+
nd-content-type: tutorial
10+
# Intended for internal catalogue and search, case sensitive:
11+
# Agent, N4Azure, NIC, NIM, NGF, NAP-DOS, NAP-WAF, NGINX One, NGINX+, Solutions, Unit
12+
nd-product: NGINX One
13+
---
14+
15+
The NGINX One Console dashboard relies on APIs for NGINX Plus and NGINX Open Source Stub Status to report traffic and system metrics. The following sections show you how to enable those metrics.
16+
17+
### Enable NGINX Plus API
18+
19+
{{< include "/use-cases/monitoring/enable-nginx-plus-api.md" >}}
20+
21+
### Enable NGINX Open Source Stub Status API
22+
23+
{{< include "/use-cases/monitoring/enable-nginx-oss-stub-status.md" >}}
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
# We use sentence case and present imperative tone
3+
title: "Review metrics on the NGINX One dashboard"
4+
# Weights are assigned in increments of 100: determines sorting order
5+
weight: i00
6+
# Creates a table of contents and sidebar, useful for large documents
7+
toc: true
8+
# Types have a 1:1 relationship with Hugo archetypes, so you shouldn't need to change this
9+
nd-content-type: how-to
10+
# Intended for internal catalogue and search, case sensitive:
11+
# Agent, N4Azure, NIC, NIM, NGF, NAP-DOS, NAP-WAF, NGINX One, NGINX+, Solutions, Unit
12+
nd-product: NGINX One
13+
---
14+
15+
After connecting your NGINX instances to NGINX One, you can monitor their performance and health. The NGINX One dashboard is designed for this purpose, offering an easy-to-use interface.
16+
17+
### Log in to NGINX One
18+
19+
1. Log in to [F5 Distributed Console](https://www.f5.com/cloud/products/distributed-cloud-console).
20+
1. Select **NGINX One > Visit Service**.
21+
22+
{{< include "/use-cases/monitoring/n1c-dashboard-overview.md" >}}
23+

layouts/partials/list-main.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,9 @@ <h3 class="card-title" style="display: flex; align-items: center; gap: 5px;">
5858
{{ if and (eq $PageTitle "F5 NGINX One Console") (eq .Title "Connect your instances to the console") }}
5959
<p style="padding-bottom: 10px;">Work with data plane keys, containers, and proxy servers </p>
6060
{{ end }}
61+
{{ if and (eq $PageTitle "F5 NGINX One Console") (eq .Title "Set up metrics") }}
62+
<p style="padding-bottom: 10px;">Review your deployments in a dashboard </p>
63+
{{ end }}
6164
{{ if and (eq $PageTitle "F5 NGINX One Console") (eq .Title "API")}}
6265
<p style="padding-bottom: 10px;">These are API docs</p> <!-- Added text here -->
6366
<ul style="padding-top: 10px;">

0 commit comments

Comments
 (0)