From 1234653200008fc99ea9402656d02dbdc0a039ba Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Tue, 20 Aug 2024 13:15:22 +0100 Subject: [PATCH 01/30] feat: Agent v3 documentation architectural changes This commit adds placeholder pages for new documentation related to Agent v3, and shifts the v2 pages into their own discrete section, alongside layout changes to nudge users to v3. It also addresses some low hanging fruit for design system adherence, renaming pages and updating titles. The majority of content work will be done in subsequent PRs. --- README.md | 2 + README_v2.md | 57 +++++++++++++++ site/content/_index.md | 4 +- site/content/{overview.md => about.md} | 19 +++-- site/content/configuration/_index.md | 4 +- site/content/installation-upgrade/_index.md | 5 +- .../container-environments/_index.md | 4 +- .../installation-upgrade/getting-started.md | 18 +++-- .../installation-github.md | 8 +-- .../installation-upgrade/installation-oss.md | 39 +++++------ .../installation-upgrade/installation-plus.md | 39 +++++------ .../installation-upgrade/migrate-v3.md | 5 ++ .../content/installation-upgrade/uninstall.md | 60 ++++++++-------- site/content/installation-upgrade/upgrade.md | 7 +- site/content/metrics.md | 5 ++ .../NGINX-agent-v2/contribute/_index.md | 7 -- .../NGINX-agent-v2/contribute/community.md | 24 ------- .../contribute/dev-environment-setup.md | 65 ----------------- .../NGINX-agent-v2/overview.md | 70 ------------------- site/content/previous-versions/_index.md | 6 -- site/content/technical-specifications.md | 8 +-- .../NGINX-agent-v2 => v2}/_index.md | 4 +- .../NGINX-agent-v2 => v2}/changelog.md | 0 .../configuration/_index.md | 0 .../configuration/configuration-overview.md | 0 .../configure-nginx-agent-group.md | 0 .../configuration/encrypt-communication.md | 0 .../installation-upgrade/_index.md | 0 .../container-environments/_index.md | 0 .../container-environments/docker-images.md | 0 .../container-environments/docker-support.md | 0 .../installation-upgrade/getting-started.md | 2 +- .../installation-github.md | 0 .../installation-upgrade/installation-oss.md | 0 .../installation-upgrade/installation-plus.md | 0 .../installation-upgrade/uninstall.md | 0 .../installation-upgrade/upgrade.md | 0 site/content/v2/metrics.md | 5 ++ .../technical-specifications.md | 19 +++-- site/layouts/agent-v2-migration/list.html | 10 +++ site/layouts/agent-v2-migration/single.html | 49 +++++++++++++ .../agent-v2-migration/list-main.html | 53 ++++++++++++++ 42 files changed, 295 insertions(+), 303 deletions(-) create mode 100644 README_v2.md rename site/content/{overview.md => about.md} (83%) create mode 100644 site/content/installation-upgrade/migrate-v3.md create mode 100644 site/content/metrics.md delete mode 100644 site/content/previous-versions/NGINX-agent-v2/contribute/_index.md delete mode 100644 site/content/previous-versions/NGINX-agent-v2/contribute/community.md delete mode 100644 site/content/previous-versions/NGINX-agent-v2/contribute/dev-environment-setup.md delete mode 100644 site/content/previous-versions/NGINX-agent-v2/overview.md delete mode 100644 site/content/previous-versions/_index.md rename site/content/{previous-versions/NGINX-agent-v2 => v2}/_index.md (77%) rename site/content/{previous-versions/NGINX-agent-v2 => v2}/changelog.md (100%) rename site/content/{previous-versions/NGINX-agent-v2 => v2}/configuration/_index.md (100%) rename site/content/{previous-versions/NGINX-agent-v2 => v2}/configuration/configuration-overview.md (100%) rename site/content/{previous-versions/NGINX-agent-v2 => v2}/configuration/configure-nginx-agent-group.md (100%) rename site/content/{previous-versions/NGINX-agent-v2 => v2}/configuration/encrypt-communication.md (100%) rename site/content/{previous-versions/NGINX-agent-v2 => v2}/installation-upgrade/_index.md (100%) rename site/content/{previous-versions/NGINX-agent-v2 => v2}/installation-upgrade/container-environments/_index.md (100%) rename site/content/{previous-versions/NGINX-agent-v2 => v2}/installation-upgrade/container-environments/docker-images.md (100%) rename site/content/{previous-versions/NGINX-agent-v2 => v2}/installation-upgrade/container-environments/docker-support.md (100%) rename site/content/{previous-versions/NGINX-agent-v2 => v2}/installation-upgrade/getting-started.md (97%) rename site/content/{previous-versions/NGINX-agent-v2 => v2}/installation-upgrade/installation-github.md (100%) rename site/content/{previous-versions/NGINX-agent-v2 => v2}/installation-upgrade/installation-oss.md (100%) rename site/content/{previous-versions/NGINX-agent-v2 => v2}/installation-upgrade/installation-plus.md (100%) rename site/content/{previous-versions/NGINX-agent-v2 => v2}/installation-upgrade/uninstall.md (100%) rename site/content/{previous-versions/NGINX-agent-v2 => v2}/installation-upgrade/upgrade.md (100%) create mode 100644 site/content/v2/metrics.md rename site/content/{previous-versions/NGINX-agent-v2 => v2}/technical-specifications.md (87%) create mode 100644 site/layouts/agent-v2-migration/list.html create mode 100644 site/layouts/agent-v2-migration/single.html create mode 100644 site/layouts/partials/agent-v2-migration/list-main.html diff --git a/README.md b/README.md index 2258ffaf5..a6b3f33d2 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,8 @@ NGINX Agent is a companion daemon for your NGINX Open Source or NGINX Plus insta - Collection and reporting of real-time NGINX performance and operating system metrics - Notifications of NGINX events +> **Note**: There is a separate [README for Agent version 2](README_v2.md) and earlier. + ## NGINX Agent Technical Specifications ## Supported Distributions diff --git a/README_v2.md b/README_v2.md new file mode 100644 index 000000000..f4a51832e --- /dev/null +++ b/README_v2.md @@ -0,0 +1,57 @@ +![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/nginx/agent) +![GitHub License](https://img.shields.io/github/license/nginx/agent) +![Contributions Welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat) +[![Slack](https://img.shields.io/badge/slack-join%20us-brightgreen.svg?logo=slack)](https://nginxcommunity.slack.com/channels/nginx-agent) +![coverage](https://raw.githubusercontent.com/nginx/agent/badges/.badges/v3/coverage.svg) + +# NGINX Agent + +NGINX Agent is a companion daemon for your NGINX Open Source or NGINX Plus instance. It enables: + +- Remote management of NGINX configurations +- Collection and reporting of real-time NGINX performance and operating system metrics +- Notifications of NGINX events + +> **Note**: There is a separate [README for Agent version 3](README.md) and later. + +## NGINX Agent Technical Specifications + +## Supported Distributions + +NGINX Agent can run in most environments. For a list of supported distributions, see the [NGINX Technical Specs](https://docs.nginx.com/nginx/technical-specs/#supported-distributions) guide. + +## Supported Deployment Environments + +NGINX Agent can be deployed in the following environments: + +- Bare Metal +- Container +- Public Cloud: AWS, Google Cloud Platform, and Microsoft Azure +- Virtual Machine + +## Supported NGINX Product Versions + +NGINX Agent works with all supported versions of NGINX Open Source and NGINX Plus. + +## Sizing Recommendations + +Minimum system sizing recommendations for NGINX Agent: +TBD + +## Community + +- Our [Slack channel #nginx-agent](https://nginxcommunity.slack.com/), is the go-to place to start asking questions and sharing your thoughts. + +- Our [GitHub issues page](https://github.com/nginx/agent/issues) offers space for a more technical discussion at your own pace. + +## Contributing + +Get involved with the project by contributing! Please see our [contributing guide](CONTRIBUTING.md) for details. + +## Change Log + +See our [release page](https://github.com/nginx/agent/releases) to keep track of updates. + +## License + +[Apache License, Version 2.0](LICENSE) diff --git a/site/content/_index.md b/site/content/_index.md index ac81454ba..be15d6b1b 100644 --- a/site/content/_index.md +++ b/site/content/_index.md @@ -1,6 +1,4 @@ --- -title: "Welcome to the NGINX Agent documentation" +title: "NGINX Agent Documentation" description: "NGINX Agent is a companion daemon for your NGINX Open Source or NGINX Plus instance." -linkTitle: "NGINX Agent" -menu: docs --- \ No newline at end of file diff --git a/site/content/overview.md b/site/content/about.md similarity index 83% rename from site/content/overview.md rename to site/content/about.md index 76e16c8e6..422f84537 100644 --- a/site/content/overview.md +++ b/site/content/about.md @@ -1,11 +1,8 @@ --- -title: "Overview" -draft: false +title: "About" weight: 100 toc: true -tags: [ "docs" ] -categories: ["configuration"] -doctypes: ["task"] +docs: DOCS-000 --- ## Overview @@ -17,20 +14,20 @@ NGINX Agent is a companion daemon for your NGINX Open Source or NGINX Plus insta - Notifications of NGINX events -{{< img src="grafana-dashboard-example.png" caption="Grafana dashboard showing metrics reported by NGINX Agent" alt="Grafana dashboard showing metrics reported by NGINX Agent" width="99%">}} +{{< img src="grafana-dashboard-example.png" caption="A Grafana dashboard displaying metrics reported by NGINX Agent." alt="A Grafana dashboard displaying metrics reported by NGINX Agent." width="99%">}} -## How it Works +## How it works NGINX Agent runs as a companion process on a system running NGINX. It provides gRPC and REST interfaces for configuration management and metrics collection from the NGINX process and operating system. NGINX Agent enables remote interaction with NGINX using common Linux tools and unlocks the ability to build sophisticated monitoring and control systems that can manage large collections of NGINX instances. {{< img src="agent-flow.png" caption="How Agent works" alt="How NGINX Agent works" width="99%">}} -## Configuration Management +## Configuration management NGINX Agent provides an API interface for submission of updated configuration files. Upon receipt of a new file, it checks the output of `nginx -V` to determine the location of existing configurations. It then validates the new configuration with `nginx -t` before applying it via a signal HUP to the NGINX master process. -## Collecting Metrics +## Collecting metrics NGINX Agent interfaces with NGINX process information and parses NGINX logs to calculate and report metrics. When interfacing with NGINX Plus, NGINX Agent pulls relevant information from the NGINX Plus API. Reported metrics may be aggregated by [Prometheus](https://prometheus.io/) and visualized with tools like [Grafana](https://grafana.com/). @@ -40,9 +37,9 @@ When running alongside an open source instance of NGINX, NGINX Agent requires th ### NGINX Plus -For NGINX Agent to work properly with an NGINX Plus instance, the API needs to be configured in that instance's nginx.conf. See [Instance Metrics Overview](https://docs.nginx.com/nginx-management-suite/nim/about/overview-metrics/) for more details. Once NGINX Plus is configured with the `/api/` endpoint, the Agent will automatically use it on startup. +For NGINX Agent to work properly with an NGINX Plus instance, the API needs to be configured in that instance's nginx.conf. View the [Instance Metrics Overview](https://docs.nginx.com/nginx-management-suite/nim/about/overview-metrics/) topic for more details. Once NGINX Plus is configured with the `/api/` endpoint, the Agent will automatically use it on startup. -## Event Notifications +## Event notifications NGINX Agent allows a gRPC connected control system to register a listener for a specific event. The control mechanism is then invoked when NGINX Agent sends an associated system signal. The source of a notification can be either the NGINX instance or NGINX Agent itself. Here's a list of currently supported events: diff --git a/site/content/configuration/_index.md b/site/content/configuration/_index.md index 3d1fdf4e3..a391ae3ea 100644 --- a/site/content/configuration/_index.md +++ b/site/content/configuration/_index.md @@ -1,7 +1,5 @@ --- title: "Configuration" description: "Learn how to configure NGINX Agent." -linkTitle: "Configuration" -weight: "400" -menu: docs +weight: 500 --- \ No newline at end of file diff --git a/site/content/installation-upgrade/_index.md b/site/content/installation-upgrade/_index.md index 4c3d49899..3b231d8eb 100644 --- a/site/content/installation-upgrade/_index.md +++ b/site/content/installation-upgrade/_index.md @@ -1,6 +1,5 @@ --- -title: "Installation and upgrade" +title: "Install and upgrade" description: "Learn how to install, upgrade, and uninstall NGINX Agent." -menu: docs -weight: 300 +weight: 400 --- \ No newline at end of file diff --git a/site/content/installation-upgrade/container-environments/_index.md b/site/content/installation-upgrade/container-environments/_index.md index e2de9f52c..6d0a3bf81 100644 --- a/site/content/installation-upgrade/container-environments/_index.md +++ b/site/content/installation-upgrade/container-environments/_index.md @@ -1,6 +1,6 @@ --- -title: "Container Environments" +title: "Container environments" description: "Learn how to build and run NGINX Agent docker images." menu: docs -weight: 800 +weight: 900 --- \ No newline at end of file diff --git a/site/content/installation-upgrade/getting-started.md b/site/content/installation-upgrade/getting-started.md index 17c30ba1e..0e453618b 100644 --- a/site/content/installation-upgrade/getting-started.md +++ b/site/content/installation-upgrade/getting-started.md @@ -1,11 +1,8 @@ --- title: "Getting started" -draft: false -weight: 100 toc: true -tags: [ "docs" ] -categories: ["configuration"] -doctypes: ["task"] +weight: 100 +docs: DOCS-000 --- ## Overview @@ -16,7 +13,7 @@ Follow these steps to configure and run NGINX Agent and a mock interface ("contr Follow the steps in the [Installation]({{< relref "/installation-upgrade/installation-github.md" >}}) section to download, install, and run NGINX. -## Clone the NGINX Agent Repository +## Clone the NGINX Agent repository Using your preferred method, clone the NGINX Agent repository into your development directory. See [Cloning a GitHub Repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) for additional help. @@ -24,7 +21,7 @@ Using your preferred method, clone the NGINX Agent repository into your developm NGINX Agent and the Mock Control Plane are written in Go. Go 1.22.2 or higher is required to build and run either application from the source code directory. You can [download Go from the official website](https://go.dev/dl/). -## Start the gRPC Mock Control Plane +## Start the gRPC mock control plane Start the mock control plane by running the following command from the `agent` source code root directory: @@ -36,7 +33,7 @@ INFO[0000] http listening at 54790 # mock control plane port INFO[0000] grpc listening at 54789 # grpc control plane port which NGINX Agent will report to ``` -## NGINX Agent Settings +## NGINX Agent settings If it doesn't already exist, create the `/etc/nginx-agent/` directory and copy the `nginx-agent.conf` file into it from the project root directory. @@ -121,8 +118,9 @@ Open another terminal window and start NGINX Agent. Issue the following command ```shell sudo make run +``` -# Command Output snippet +```text WARN[0000] Log level is info INFO[0000] setting displayName to XXX INFO[0000] NGINX Agent at with pid 12345, clientID=XXXXXX-XXXXXX-XXXXXX-XXXXXX-XXXXXX name=XXX @@ -155,7 +153,7 @@ Open a web browser to view the mock control plane at [http://localhost:54790](ht For more NGINX Agent use cases, refer to the [NGINX Agent SDK examples](https://github.com/nginx/agent/tree/main/sdk/examples). -## Start and Enable Start on Boot +## Start and enable start on boot To start NGINX Agent on `systemd` systems, run the following command: diff --git a/site/content/installation-upgrade/installation-github.md b/site/content/installation-upgrade/installation-github.md index 20c3568f2..cdc8bd55b 100644 --- a/site/content/installation-upgrade/installation-github.md +++ b/site/content/installation-upgrade/installation-github.md @@ -1,11 +1,7 @@ --- title: "Installation from GitHub release" -draft: false weight: 200 -toc: true -tags: [ "docs" ] -categories: ["configuration"] -doctypes: ["task"] +docs: DOC-000 --- ## Overview @@ -16,7 +12,7 @@ Learn how to install NGINX Agent from a GitHub Release. NGINX Agent interfaces directly with an NGINX server process installed on the same system. If you don't have it already, follow these steps to install [NGINX Open Source](https://www.nginx.com/resources/wiki/start/topics/tutorials/install/) or [NGINX Plus](https://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-plus/). Once installed, ensure the NGINX instance is running. -## Install NGINX Agent from Package Files +## Install NGINX Agent from package files To install NGINX Agent on your system, go to [GitHub Releases](https://github.com/nginx/agent/releases) and download the latest package supported by your OS distribution and CPU architecture. diff --git a/site/content/installation-upgrade/installation-oss.md b/site/content/installation-upgrade/installation-oss.md index d3c42ef31..68bba28b0 100644 --- a/site/content/installation-upgrade/installation-oss.md +++ b/site/content/installation-upgrade/installation-oss.md @@ -1,18 +1,17 @@ --- title: "Installation from NGINX repository" -draft: false -weight: 300 toc: true -tags: [ "docs" ] -categories: ["configuration"] -doctypes: ["task"] +weight: 300 +docs: DOCS-000 --- ## Overview Learn how to install NGINX Agent from the NGINX Open Source repository. -## Prerequisites +## Before you begin + +### Prerequisites - NGINX installed. Once installed, ensure it is running. If you don't have it installed already, follow these steps to install [NGINX](https://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-open-source/) - A [supported operating system and architecture](../technical-specifications/#supported-distributions) @@ -22,15 +21,15 @@ Learn how to install NGINX Agent from the NGINX Open Source repository. Before you install NGINX Agent for the first time on your system, you need to set up the `nginx-agent` packages repository. Afterward, you can install and update NGINX Agent from the repository. -- [Installing NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux](#installing-nginx-agent-on-rhel-centos-rocky-linux-almalinux-and-oracle-linux) -- [Installing NGINX Agent on Ubuntu](#installing-nginx-agent-on-ubuntu) -- [Installing NGINX Agent on Debian](#installing-nginx-agent-on-debian) -- [Installing NGINX Agent on SLES](#installing-nginx-agent-on-sles) -- [Installing NGINX Agent on Alpine Linux](#installing-nginx-agent-on-alpine-linux) -- [Installing NGINX Agent on Amazon Linux](#installing-nginx-agent-on-amazon-linux) -- [Installing NGINX Agent on FreeBSD](#installing-nginx-agent-on-freebsd) +- [Install NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux](#install-nginx-agent-on-rhel-centos-rocky-linux-almalinux-and-oracle-linux) +- [Install NGINX Agent on Ubuntu](#install-nginx-agent-on-ubuntu) +- [Install NGINX Agent on Debian](#install-nginx-agent-on-debian) +- [Install NGINX Agent on SLES](#install-nginx-agent-on-sles) +- [Install NGINX Agent on Alpine Linux](#install-nginx-agent-on-alpine-linux) +- [Install NGINX Agent on Amazon Linux](#install-nginx-agent-on-amazon-linux) +- [Install NGINX Agent on FreeBSD](#install-nginx-agent-on-freebsd) -### Installing NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux +### Install NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux 1. Install the prerequisites: @@ -58,7 +57,7 @@ Before you install NGINX Agent for the first time on your system, you need to se When prompted to accept the GPG key, verify that the fingerprint matches `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62`, and if so, accept it. -### Installing NGINX Agent on Ubuntu +### Install NGINX Agent on Ubuntu 1. Install the prerequisites: @@ -111,7 +110,7 @@ Before you install NGINX Agent for the first time on your system, you need to se ``` -### Installing NGINX Agent on Debian +### Install NGINX Agent on Debian 1. Install the prerequisites: @@ -164,7 +163,7 @@ Before you install NGINX Agent for the first time on your system, you need to se ``` -### Installing NGINX Agent on SLES +### Install NGINX Agent on SLES 1. Install the prerequisites: @@ -217,7 +216,7 @@ Before you install NGINX Agent for the first time on your system, you need to se sudo nginx-agent -v ``` -### Installing NGINX Agent on Alpine Linux +### Install NGINX Agent on Alpine Linux 1. Install the prerequisites: @@ -291,7 +290,7 @@ Before you install NGINX Agent for the first time on your system, you need to se sudo nginx-agent -v ``` -### Installing NGINX Agent on Amazon Linux +### Install NGINX Agent on Amazon Linux 1. Install the prerequisites: @@ -324,7 +323,7 @@ Before you install NGINX Agent for the first time on your system, you need to se sudo nginx-agent -v ``` -### Installing NGINX Agent on FreeBSD +### Install NGINX Agent on FreeBSD 1. To setup the pkg repository create the file named `/etc/pkg/nginx-agent.conf` with the following content: diff --git a/site/content/installation-upgrade/installation-plus.md b/site/content/installation-upgrade/installation-plus.md index 643d02169..4069dafc0 100644 --- a/site/content/installation-upgrade/installation-plus.md +++ b/site/content/installation-upgrade/installation-plus.md @@ -1,18 +1,17 @@ --- title: "Installation from NGINX Plus repository" -draft: false -weight: 400 toc: true -tags: [ "docs" ] -categories: ["configuration"] -doctypes: ["task"] +weight: 400 +docs: DOCS-000 --- ## Overview Learn how to install NGINX Agent from NGINX Plus repository -## Prerequisites +## Before you begin + +### Prerequisites - An NGINX Plus subscription (purchased or trial) - NGINX Plus installed. Once installed, ensure it is running. If you don't have it installed already, follow these steps to install [NGINX Plus](https://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-plus/) @@ -25,15 +24,15 @@ Learn how to install NGINX Agent from NGINX Plus repository Before you install NGINX Agent for the first time on your system, you need to set up the `nginx-agent` packages repository. Afterward, you can install and update NGINX Agent from the repository. -- [Installing NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux](#installing-nginx-agent-on-rhel-centos-rocky-linux-almalinux-and-oracle-linux) -- [Installing NGINX Agent on Ubuntu](#installing-nginx-agent-on-ubuntu) -- [Installing NGINX Agent on Debian](#installing-nginx-agent-on-debian) -- [Installing NGINX Agent on SLES](#installing-nginx-agent-on-sles) -- [Installing NGINX Agent on Alpine Linux](#installing-nginx-agent-on-alpine-linux) -- [Installing NGINX Agent on Amazon Linux](#installing-nginx-agent-on-amazon-linux) -- [Installing NGINX Agent on FreeBSD](#installing-nginx-agent-on-freebsd) +- [Install NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux](#install-nginx-agent-on-rhel-centos-rocky-linux-almalinux-and-oracle-linux) +- [Install NGINX Agent on Ubuntu](#install-nginx-agent-on-ubuntu) +- [Install NGINX Agent on Debian](#install-nginx-agent-on-debian) +- [Install NGINX Agent on SLES](#install-nginx-agent-on-sles) +- [Install NGINX Agent on Alpine Linux](#install-nginx-agent-on-alpine-linux) +- [Install NGINX Agent on Amazon Linux](#install-nginx-agent-on-amazon-linux) +- [Install NGINX Agent on FreeBSD](#install-nginx-agent-on-freebsd) -### Installing NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux +### Install NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux 1. Create the `/etc/ssl/nginx` directory: @@ -87,7 +86,7 @@ Before you install NGINX Agent for the first time on your system, you need to se sudo nginx-agent -v ``` -### Installing NGINX Agent on Ubuntu +### Install NGINX Agent on Ubuntu 1. Create the `/etc/ssl/nginx` directory: @@ -145,7 +144,7 @@ Before you install NGINX Agent for the first time on your system, you need to se ``` -### Installing NGINX Agent on Debian +### Install NGINX Agent on Debian 1. Create the `/etc/ssl/nginx` directory: @@ -196,7 +195,7 @@ Before you install NGINX Agent for the first time on your system, you need to se sudo nginx-agent -v ``` -### Installing NGINX Agent on SLES +### Install NGINX Agent on SLES 1. Create the `/etc/ssl/nginx` directory: @@ -269,7 +268,7 @@ Before you install NGINX Agent for the first time on your system, you need to se sudo nginx-agent -v ``` -### Installing NGINX Agent on Alpine Linux +### Install NGINX Agent on Alpine Linux 1. Log in to [MyF5 Customer Portal](https://account.f5.com/myf5/) and download your `nginx-repo.crt` and `nginx-repo.key` files. @@ -352,7 +351,7 @@ Before you install NGINX Agent for the first time on your system, you need to se sudo nginx-agent -v ``` -### Installing NGINX Agent on Amazon Linux +### Install NGINX Agent on Amazon Linux 1. Create the `/etc/ssl/nginx` directory: @@ -400,7 +399,7 @@ Before you install NGINX Agent for the first time on your system, you need to se sudo nginx-agent -v ``` -### Installing NGINX Agent on FreeBSD +### Install NGINX Agent on FreeBSD 1. Create the `/etc/ssl/nginx` directory: diff --git a/site/content/installation-upgrade/migrate-v3.md b/site/content/installation-upgrade/migrate-v3.md new file mode 100644 index 000000000..8cc115920 --- /dev/null +++ b/site/content/installation-upgrade/migrate-v3.md @@ -0,0 +1,5 @@ +--- +title: Migrate from NGINX Agent v2 to v3 +weight: 800 +docs: DOCS-000 +--- \ No newline at end of file diff --git a/site/content/installation-upgrade/uninstall.md b/site/content/installation-upgrade/uninstall.md index 0431f72bd..4e1112a8e 100644 --- a/site/content/installation-upgrade/uninstall.md +++ b/site/content/installation-upgrade/uninstall.md @@ -1,35 +1,35 @@ --- title: "Uninstall NGINX Agent package" -draft: false -weight: 700 toc: true -tags: [ "docs" ] -categories: ["configuration"] -doctypes: ["task"] +weight: 700 +docs: DOCS-000 --- ## Overview Learn how to uninstall NGINX Agent from your system. -## Prerequisites + +## Before you begin + +### Prerequisites - NGINX Agent installed [NGINX Agent installed](../installation-oss) - The user following these steps will need `root` privilege -## Uninstalling NGINX Agent +## Uninstall NGINX Agent Complete the following steps on each host where you’ve installed NGINX Agent -- [Uninstalling NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux](#uninstalling-nginx-agent-on-rhel-centos-rocky-linux-almalinux-and-oracle-linux) -- [Uninstalling NGINX Agent on Ubuntu](#uninstalling-nginx-agent-on-ubuntu) -- [Uninstalling NGINX Agent on Debian](#uninstalling-nginx-agent-on-debian) -- [Uninstalling NGINX Agent on SLES](#uninstalling-nginx-agent-on-sles) -- [Uninstalling NGINX Agent on Alpine Linux](#uninstalling-nginx-agent-on-alpine-linux) -- [Uninstalling NGINX Agent on Amazon Linux](#uninstalling-nginx-agent-on-amazon-linux) -- [Uninstalling NGINX Agent on FreeBSD](#uninstalling-nginx-agent-on-freebsd) +- [Uninstall NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux](#uninstall-nginx-agent-on-rhel-centos-rocky-linux-almalinux-and-oracle-linux) +- [Uninstall NGINX Agent on Ubuntu](#uninstall-nginx-agent-on-ubuntu) +- [Uninstall NGINX Agent on Debian](#uninstall-nginx-agent-on-debian) +- [Uninstall NGINX Agent on SLES](#uninstall-nginx-agent-on-sles) +- [Uninstall NGINX Agent on Alpine Linux](#uninstall-nginx-agent-on-alpine-linux) +- [Uninstall NGINX Agent on Amazon Linux](#uninstall-nginx-agent-on-amazon-linux) +- [Uninstall NGINX Agent on FreeBSD](#uninstall-nginx-agent-on-freebsd) -### Uninstalling NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux +### Uninstall NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux Complete the following steps on each host where you've installed NGINX Agent: @@ -39,13 +39,13 @@ Complete the following steps on each host where you've installed NGINX Agent: sudo systemctl stop nginx-agent ``` -2. To uninstall NGINX Agent, run the following command: +1. To uninstall NGINX Agent, run the following command: ```bash sudo yum remove nginx-agent ``` -### Uninstalling NGINX Agent on Ubuntu +### Uninstall NGINX Agent on Ubuntu Complete the following steps on each host where you've installed NGINX Agent: @@ -55,15 +55,15 @@ Complete the following steps on each host where you've installed NGINX Agent: sudo systemctl stop nginx-agent ``` -2. To uninstall NGINX Agent, run the following command: +1. To uninstall NGINX Agent, run the following command: ```bash sudo apt-get remove nginx-agent ``` - > **Note:** The `apt-get remove ` command will remove the package from your system, while keeping the associated configuration files for possible future use. If you want to completely remove the package and all of its configuration files, you should use `apt-get purge `. + {{< note >}} The `apt-get remove ` command will remove the package from your system, while keeping the associated configuration files for possible future use. If you want to completely remove the package and all of its configuration files, you should use `apt-get purge `. {{< /note >}} -### Uninstalling NGINX Agent on Debian +### Uninstall NGINX Agent on Debian Complete the following steps on each host where you've installed NGINX Agent: @@ -73,15 +73,15 @@ Complete the following steps on each host where you've installed NGINX Agent: sudo systemctl stop nginx-agent ``` -2. To uninstall NGINX Agent, run the following command: +1. To uninstall NGINX Agent, run the following command: ```bash sudo apt-get remove nginx-agent ``` - > **Note:** The `apt-get remove ` command will remove the package from your system, while keeping the associated configuration files for possible future use. If you want to completely remove the package and all of its configuration files, you should use `apt-get purge `. + {{< note >}} The `apt-get remove ` command will remove the package from your system, while keeping the associated configuration files for possible future use. If you want to completely remove the package and all of its configuration files, you should use `apt-get purge `. {{< /note >}} -### Uninstalling NGINX Agent on SLES +### Uninstall NGINX Agent on SLES Complete the following steps on each host where you've installed NGINX Agent: @@ -91,13 +91,13 @@ Complete the following steps on each host where you've installed NGINX Agent: sudo systemctl stop nginx-agent ``` -2. To uninstall NGINX agent, run the following command: +1. To uninstall NGINX agent, run the following command: ```bash sudo zypper remove nginx-agent ``` -### Uninstalling NGINX Agent on Alpine Linux +### Uninstall NGINX Agent on Alpine Linux Complete the following steps on each host where you've installed NGINX agent: @@ -107,13 +107,13 @@ Complete the following steps on each host where you've installed NGINX agent: sudo rc-service nginx-agent stop ``` -2. To uninstall NGINX agent, run the following command: +1. To uninstall NGINX agent, run the following command: ```bash sudo apk del nginx-agent ``` -### Uninstalling NGINX Agent on Amazon Linux +### Uninstall NGINX Agent on Amazon Linux Complete the following steps on each host where you've installed NGINX agent: @@ -123,13 +123,13 @@ Complete the following steps on each host where you've installed NGINX agent: sudo systemctl stop nginx-agent ``` -2. To uninstall NGINX agent, run the following command: +1. To uninstall NGINX agent, run the following command: ```bash sudo yum remove nginx-agent ``` -### Uninstalling NGINX Agent on FreeBSD +### Uninstall NGINX Agent on FreeBSD Complete the following steps on each host where you've installed NGINX agent: @@ -139,7 +139,7 @@ Complete the following steps on each host where you've installed NGINX agent: sudo service nginx-agent stop ``` -2. To uninstall NGINX agent, run the following command: +1. To uninstall NGINX agent, run the following command: ```bash sudo pkg delete nginx-agent diff --git a/site/content/installation-upgrade/upgrade.md b/site/content/installation-upgrade/upgrade.md index 4e0f44539..eccb4612e 100644 --- a/site/content/installation-upgrade/upgrade.md +++ b/site/content/installation-upgrade/upgrade.md @@ -1,11 +1,8 @@ --- title: "Upgrade NGINX Agent package" -draft: false -weight: 600 toc: true -tags: [ "docs" ] -categories: ["configuration"] -doctypes: ["task"] +weight: 600 +docs: DOCS-000 --- ## Overview diff --git a/site/content/metrics.md b/site/content/metrics.md new file mode 100644 index 000000000..e612adc3b --- /dev/null +++ b/site/content/metrics.md @@ -0,0 +1,5 @@ +--- +title: OpenTelemetry metrics +docs: DOCS-000 +weight: 300 +--- \ No newline at end of file diff --git a/site/content/previous-versions/NGINX-agent-v2/contribute/_index.md b/site/content/previous-versions/NGINX-agent-v2/contribute/_index.md deleted file mode 100644 index dc79b629a..000000000 --- a/site/content/previous-versions/NGINX-agent-v2/contribute/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: "Contribute" -description: "Learn about the NGINX Agent community and contribute to the project." -linkTitle: "Contribute" -menu: docs -weight: "500" ---- \ No newline at end of file diff --git a/site/content/previous-versions/NGINX-agent-v2/contribute/community.md b/site/content/previous-versions/NGINX-agent-v2/contribute/community.md deleted file mode 100644 index 16763795d..000000000 --- a/site/content/previous-versions/NGINX-agent-v2/contribute/community.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "Community and Contribution" -draft: false -weight: 100 -toc: true -tags: [ "docs" ] -docs: "DOCS-1087" -categories: ["configuration"] -doctypes: ["task"] ---- - -# Community - -- Our [Slack channel #nginx-agent](https://nginxcommunity.slack.com/), is the go-to place to start asking questions and sharing your thoughts. - -- Our [GitHub issues page](https://github.com/nginx/agent/issues) offers space for a more technical discussion at your own pace. - -# Contribute - -Get involved with the project by contributing! Please see our [contributing guide](https://github.com/nginx/agent/blob/main/CONTRIBUTING.md) for details. - -# License - -[Apache License, Version 2.0](https://github.com/nginx/agent/blob/main/LICENSE) diff --git a/site/content/previous-versions/NGINX-agent-v2/contribute/dev-environment-setup.md b/site/content/previous-versions/NGINX-agent-v2/contribute/dev-environment-setup.md deleted file mode 100644 index e9e3e9db0..000000000 --- a/site/content/previous-versions/NGINX-agent-v2/contribute/dev-environment-setup.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: "Development Environment Setup" -draft: false -weight: 200 -toc: true -tags: [ "docs" ] - -categories: ["development"] -doctypes: ["task"] ---- - -## Overview - -Learn how to setup a Development Environment for NGINX Agent. - -## Select an Operating System - -While most Linux or FreeBSD operating systems can be used to contribute to the NGINX Agent project, the following steps have been designed for Ubuntu. Ubuntu is packaged with most libraries required to build and run NGINX Agent, and is the recommended platform for NGINX Agent development. - -## Install NGINX - -Follow the steps in the [Installation]({{< relref "/previous-versions/NGINX-agent-v2/installation-upgrade/installation-github.md" >}}) section to download, install, and run NGINX and NGINX Agent. - -## Clone the NGINX Agent Repository - -Using your preferred method, clone the NGINX Agent repository into your development directory. See [Cloning a GitHub Repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) for additional help. - -## Installing Prerequisite Packages -Depending on the operating system distribution, it may be necessary to install the following packages in order to build NGINX Agent. - -Change to the NGINX Agent source directory: -```bash -cd /agent -``` - -Install Make: -```bash -sudo apt install make -``` - -NGINX Agent is written in Go. You may [download Go](https://go.dev/doc/install) and follow installation instructions on the same page or run: -```bash -sudo apt install golang-go -``` - -Install Protoc: -```bash -sudo apt install -y protobuf-compiler -``` - -Install NGINX Agent tools and dependencies: - -Before starting development on NGINX Agent, it is important to download and install the necessary tool and dependencies required by NGINX Agent. You can do this by running the following `make` command: -```bash -make install-tools deps -``` - -## Building NGINX Agent from Source Code - -Run the following commands to build and run NGINX Agent: - -```bash -make build -sudo make run -``` diff --git a/site/content/previous-versions/NGINX-agent-v2/overview.md b/site/content/previous-versions/NGINX-agent-v2/overview.md deleted file mode 100644 index a46f1b1de..000000000 --- a/site/content/previous-versions/NGINX-agent-v2/overview.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: "Overview" -draft: false -weight: 100 -toc: true -tags: [ "docs" ] -docs: "DOCS-1091" -categories: ["configuration"] -doctypes: ["task"] ---- - -## Overview - -NGINX Agent is a companion daemon for your NGINX Open Source or NGINX Plus instance. It enables: - -- Remote management of NGINX configurations -- Collection and reporting of real-time NGINX performance and operating system metrics -- Notifications of NGINX events - - -{{< img src="grafana-dashboard-example.png" caption="Grafana dashboard showing metrics reported by NGINX Agent" alt="Grafana dashboard showing metrics reported by NGINX Agent" width="99%">}} - -## How it Works - -NGINX Agent runs as a companion process on a system running NGINX. It provides gRPC and REST interfaces for configuration management and metrics collection from the NGINX process and operating system. NGINX Agent enables remote interaction with NGINX using common Linux tools and unlocks the ability to build sophisticated monitoring and control systems that can manage large collections of NGINX instances. - -{{< img src="agent-flow.png" caption="How Agent works" alt="How NGINX Agent works" width="99%">}} - - -## Configuration Management - -NGINX Agent provides an API interface for submission of updated configuration files. Upon receipt of a new file, it checks the output of `nginx -V` to determine the location of existing configurations. It then validates the new configuration with `nginx -t` before applying it via a signal HUP to the NGINX master process. - -## Collecting Metrics - -NGINX Agent interfaces with NGINX process information and parses NGINX logs to calculate and report metrics. When interfacing with NGINX Plus, NGINX Agent pulls relevant information from the NGINX Plus API. Reported metrics may be aggregated by [Prometheus](https://prometheus.io/) and visualized with tools like [Grafana](https://grafana.com/). - -### NGINX Open Source - -When running alongside an open source instance of NGINX, NGINX Agent requires that NGINX Access and Error logs are turned on and contain all default variables. - -### NGINX Plus - -For NGINX Agent to work properly with an NGINX Plus instance, the API needs to be configured in that instance's nginx.conf. See [Instance Metrics Overview](https://docs.nginx.com/nginx-management-suite/nim/about/overview-metrics/) for more details. Once NGINX Plus is configured with the `/api/` endpoint, the Agent will automatically use it on startup. - -## Event Notifications - -NGINX Agent allows a gRPC connected control system to register a listener for a specific event. The control mechanism is then invoked when NGINX Agent sends an associated system signal. The source of a notification can be either the NGINX instance or NGINX Agent itself. Here's a list of currently supported events: - - -{{< raw-html>}}
{{}} -{{}} -| Event | Description | -| -------------------------------- | -------------------------------------------- | -| AGENT_START_MESSAGE | Agent process started | -| AGENT_STOP_MESSAGE | Agent process stopped | -| NGINX_FOUND_MESSAGE | NGINX master process detected on system | -| NGINX_STOP_MESSAGE | NGINX master process stopped | -| NGINX_RELOAD_SUCCESS_MESSAGE | NGINX master process reloaded successfully | -| NGINX_RELOAD_FAILED_MESSAGE | NGINX master process failed to reload | -| NGINX_WORKER_START_MESSAGE | New NGINX worker process started | -| NGINX_WORKER_STOP_MESSAGE | NGINX worker process stopped | -| CONFIG_APPLY_SUCCESS_MESSAGE | Successfully applied new NGINX configuration | -| CONFIG_APPLY_FAILURE_MESSAGE | Failed to apply new NGINX configuration | -| CONFIG_ROLLBACK_SUCCESS_MESSAGE | Successfully rolled back NGINX configuration | -| CONFIG_ROLLBACK_FAILURE_MESSAGE | Failed to roll back NGINX configuration | -{{}} -{{< raw-html>}}
{{}} - - diff --git a/site/content/previous-versions/_index.md b/site/content/previous-versions/_index.md deleted file mode 100644 index 8e47a7385..000000000 --- a/site/content/previous-versions/_index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: "Previous Versions" -description: "Documentation for previous versions of NGINX Agent." -linkTitle: "Previous Versions" -weight: 10000 ---- \ No newline at end of file diff --git a/site/content/technical-specifications.md b/site/content/technical-specifications.md index 6f9a72b09..e5de80187 100644 --- a/site/content/technical-specifications.md +++ b/site/content/technical-specifications.md @@ -12,7 +12,7 @@ doctypes: ["task"] This document provides technical specifications for NGINX Agent. It includes information on supported distributions, deployment environments, NGINX versions, sizing recommendations, and logging. -## Supported Distributions +## Supported distributions NGINX Agent can run in most environments. We support the following distributions: @@ -31,7 +31,7 @@ NGINX Agent can run in most environments. We support the following distributions {{< /bootstrap-table >}} -## Supported Deployment Environments +## Supported deployment environments NGINX Agent can be deployed in the following environments: @@ -40,12 +40,12 @@ NGINX Agent can be deployed in the following environments: - Public Cloud: AWS, Google Cloud Platform, and Microsoft Azure - Virtual Machine -## Supported NGINX Versions +## Supported NGINX versions NGINX Agent works with all supported versions of NGINX Open Source and NGINX Plus. -## Sizing Recommendations +## Sizing recommendations Minimum system sizing recommendations for NGINX Agent: {{< bootstrap-table "table table-striped table-bordered" >}} diff --git a/site/content/previous-versions/NGINX-agent-v2/_index.md b/site/content/v2/_index.md similarity index 77% rename from site/content/previous-versions/NGINX-agent-v2/_index.md rename to site/content/v2/_index.md index 979f7a4c7..7b760953f 100644 --- a/site/content/previous-versions/NGINX-agent-v2/_index.md +++ b/site/content/v2/_index.md @@ -1,6 +1,6 @@ --- title: "NGINX Agent v2" description: "NGINX Agent is a companion daemon for your NGINX Open Source or NGINX Plus instance." -linkTitle: "NGINX Agent" -menu: docs +cascade: + type: agent-v2-migration --- \ No newline at end of file diff --git a/site/content/previous-versions/NGINX-agent-v2/changelog.md b/site/content/v2/changelog.md similarity index 100% rename from site/content/previous-versions/NGINX-agent-v2/changelog.md rename to site/content/v2/changelog.md diff --git a/site/content/previous-versions/NGINX-agent-v2/configuration/_index.md b/site/content/v2/configuration/_index.md similarity index 100% rename from site/content/previous-versions/NGINX-agent-v2/configuration/_index.md rename to site/content/v2/configuration/_index.md diff --git a/site/content/previous-versions/NGINX-agent-v2/configuration/configuration-overview.md b/site/content/v2/configuration/configuration-overview.md similarity index 100% rename from site/content/previous-versions/NGINX-agent-v2/configuration/configuration-overview.md rename to site/content/v2/configuration/configuration-overview.md diff --git a/site/content/previous-versions/NGINX-agent-v2/configuration/configure-nginx-agent-group.md b/site/content/v2/configuration/configure-nginx-agent-group.md similarity index 100% rename from site/content/previous-versions/NGINX-agent-v2/configuration/configure-nginx-agent-group.md rename to site/content/v2/configuration/configure-nginx-agent-group.md diff --git a/site/content/previous-versions/NGINX-agent-v2/configuration/encrypt-communication.md b/site/content/v2/configuration/encrypt-communication.md similarity index 100% rename from site/content/previous-versions/NGINX-agent-v2/configuration/encrypt-communication.md rename to site/content/v2/configuration/encrypt-communication.md diff --git a/site/content/previous-versions/NGINX-agent-v2/installation-upgrade/_index.md b/site/content/v2/installation-upgrade/_index.md similarity index 100% rename from site/content/previous-versions/NGINX-agent-v2/installation-upgrade/_index.md rename to site/content/v2/installation-upgrade/_index.md diff --git a/site/content/previous-versions/NGINX-agent-v2/installation-upgrade/container-environments/_index.md b/site/content/v2/installation-upgrade/container-environments/_index.md similarity index 100% rename from site/content/previous-versions/NGINX-agent-v2/installation-upgrade/container-environments/_index.md rename to site/content/v2/installation-upgrade/container-environments/_index.md diff --git a/site/content/previous-versions/NGINX-agent-v2/installation-upgrade/container-environments/docker-images.md b/site/content/v2/installation-upgrade/container-environments/docker-images.md similarity index 100% rename from site/content/previous-versions/NGINX-agent-v2/installation-upgrade/container-environments/docker-images.md rename to site/content/v2/installation-upgrade/container-environments/docker-images.md diff --git a/site/content/previous-versions/NGINX-agent-v2/installation-upgrade/container-environments/docker-support.md b/site/content/v2/installation-upgrade/container-environments/docker-support.md similarity index 100% rename from site/content/previous-versions/NGINX-agent-v2/installation-upgrade/container-environments/docker-support.md rename to site/content/v2/installation-upgrade/container-environments/docker-support.md diff --git a/site/content/previous-versions/NGINX-agent-v2/installation-upgrade/getting-started.md b/site/content/v2/installation-upgrade/getting-started.md similarity index 97% rename from site/content/previous-versions/NGINX-agent-v2/installation-upgrade/getting-started.md rename to site/content/v2/installation-upgrade/getting-started.md index c96aaa3d5..ebbacbdf3 100644 --- a/site/content/previous-versions/NGINX-agent-v2/installation-upgrade/getting-started.md +++ b/site/content/v2/installation-upgrade/getting-started.md @@ -15,7 +15,7 @@ Follow these steps to configure and run NGINX Agent and a mock interface ("contr ## Install NGINX -Follow the steps in the [Installation]({{< relref "/previous-versions/NGINX-agent-v2/installation-upgrade/installation-github.md" >}}) section to download, install, and run NGINX. +Follow the steps in the [Installation]({{< ref "/v2/installation-upgrade/installation-github.md" >}}) section to download, install, and run NGINX. ## Clone the NGINX Agent Repository diff --git a/site/content/previous-versions/NGINX-agent-v2/installation-upgrade/installation-github.md b/site/content/v2/installation-upgrade/installation-github.md similarity index 100% rename from site/content/previous-versions/NGINX-agent-v2/installation-upgrade/installation-github.md rename to site/content/v2/installation-upgrade/installation-github.md diff --git a/site/content/previous-versions/NGINX-agent-v2/installation-upgrade/installation-oss.md b/site/content/v2/installation-upgrade/installation-oss.md similarity index 100% rename from site/content/previous-versions/NGINX-agent-v2/installation-upgrade/installation-oss.md rename to site/content/v2/installation-upgrade/installation-oss.md diff --git a/site/content/previous-versions/NGINX-agent-v2/installation-upgrade/installation-plus.md b/site/content/v2/installation-upgrade/installation-plus.md similarity index 100% rename from site/content/previous-versions/NGINX-agent-v2/installation-upgrade/installation-plus.md rename to site/content/v2/installation-upgrade/installation-plus.md diff --git a/site/content/previous-versions/NGINX-agent-v2/installation-upgrade/uninstall.md b/site/content/v2/installation-upgrade/uninstall.md similarity index 100% rename from site/content/previous-versions/NGINX-agent-v2/installation-upgrade/uninstall.md rename to site/content/v2/installation-upgrade/uninstall.md diff --git a/site/content/previous-versions/NGINX-agent-v2/installation-upgrade/upgrade.md b/site/content/v2/installation-upgrade/upgrade.md similarity index 100% rename from site/content/previous-versions/NGINX-agent-v2/installation-upgrade/upgrade.md rename to site/content/v2/installation-upgrade/upgrade.md diff --git a/site/content/v2/metrics.md b/site/content/v2/metrics.md new file mode 100644 index 000000000..934fd8af7 --- /dev/null +++ b/site/content/v2/metrics.md @@ -0,0 +1,5 @@ +--- +title: NGINX Agent v2 Metrics +docs: DOCS-000 +weight: 200 +--- \ No newline at end of file diff --git a/site/content/previous-versions/NGINX-agent-v2/technical-specifications.md b/site/content/v2/technical-specifications.md similarity index 87% rename from site/content/previous-versions/NGINX-agent-v2/technical-specifications.md rename to site/content/v2/technical-specifications.md index 52864eaa4..efa731527 100644 --- a/site/content/previous-versions/NGINX-agent-v2/technical-specifications.md +++ b/site/content/v2/technical-specifications.md @@ -1,16 +1,13 @@ --- -title: "Technical Specifications" -draft: false -description: "This document describes the requirements for NGINX Agent." -weight: 200 +title: "Technical specifications" +weight: 100 toc: true -tags: [ "docs" ] docs: "DOCS-1092" -categories: ["development"] -doctypes: ["task"] --- -## Supported Distributions +This document describes the requirements for NGINX Agent v2. + +## Supported distributions NGINX Agent can run in most environments. We support the following distributions: @@ -29,7 +26,7 @@ NGINX Agent can run in most environments. We support the following distributions {{< /bootstrap-table >}} -## Supported Deployment Environments +## Supported deployment environments NGINX Agent can be deployed in the following environments: @@ -38,12 +35,12 @@ NGINX Agent can be deployed in the following environments: - Public Cloud: AWS, Google Cloud Platform, and Microsoft Azure - Virtual Machine -## Supported NGINX Versions +## Supported NGINX versions NGINX Agent works with all supported versions of NGINX Open Source and NGINX Plus. -## Sizing Recommendations +## Sizing recommendations Minimum system sizing recommendations for NGINX Agent: {{< bootstrap-table "table table-striped table-bordered" >}} diff --git a/site/layouts/agent-v2-migration/list.html b/site/layouts/agent-v2-migration/list.html new file mode 100644 index 000000000..54b0b0f66 --- /dev/null +++ b/site/layouts/agent-v2-migration/list.html @@ -0,0 +1,10 @@ +{{ define "main" }} +
+ +
+ {{ partial "agent-v2-migration/list-main" . }} +
+
+{{ end }} \ No newline at end of file diff --git a/site/layouts/agent-v2-migration/single.html b/site/layouts/agent-v2-migration/single.html new file mode 100644 index 000000000..63877b632 --- /dev/null +++ b/site/layouts/agent-v2-migration/single.html @@ -0,0 +1,49 @@ +{{ define "main" }} +
+ + + {{if (.Params.catalog) }} +
+ {{ else if and (gt .WordCount 200 ) (.Params.toc) }} +
+ {{ else }} +
+ {{ end }} + +
+
+ NGINX Agent v3 is available!

+ This documentation is for NGINX Agent v2. We suggest reading the Migrate from NGINX Agent v2 to v3 topic to learn the differences between the two versions, and learn how to upgrade your instances. +
+
+ +

{{ .Title }}

+ + {{ if eq .Page.Draft true }}{{ partial "draft-badge.html" . }}{{ end }} + {{ if .Description }}

{{ .Description | markdownify }}

{{ end}} + + {{ if in .Params.doctypes "beta" }}{{ partial "beta-badge" . }}{{ end }} + + {{ .Content }} + {{ partial "version-list" . }} +
+ {{ partial "previous-next-links-in-section-with-title.html" . }} + +
+ {{ if and (gt .WordCount 200 ) (.Params.toc) }} + {{ if (add (len (findRE " + {{ partial "toc.html" . }} +
+ {{ end }} + {{ end }} + + +{{if .Params.script}} + {{ $script := (delimit (slice "scripts" .Params.script) "/")}} + {{ partial (string $script) .}} +{{end }} + +{{ end }} \ No newline at end of file diff --git a/site/layouts/partials/agent-v2-migration/list-main.html b/site/layouts/partials/agent-v2-migration/list-main.html new file mode 100644 index 000000000..51c39a214 --- /dev/null +++ b/site/layouts/partials/agent-v2-migration/list-main.html @@ -0,0 +1,53 @@ +
+
+
+

+ {{ .Title }} +

+ {{ if .Description }} +

+ {{ .Description | markdownify }} +

+ {{ end}} +
+
+ NGINX Agent v3 is available!

+ This documentation is for NGINX Agent v2. We suggest reading the Migrate from NGINX Agent v2 to v3 topic to learn the differences between the two versions, and learn how to upgrade your instances. +
+
+ {{ if .Content }} +

+ {{ .Content | markdownify }} +

+ {{ end }} +
+
+ +
+
+
+ {{ range .Pages.GroupBy "Section" }} + + {{ range .Pages.ByWeight }} +
+
+

+ + {{ .Title }} +

+ {{/*}}

+ {{ if .Description }}{{ .Description | markdownify }}{{ end }} +

{{*/}} + +
+
+ + {{ end }} +
+
+ {{ end }} + + +
+ +
\ No newline at end of file From b677c93e8e9b83d9f17c16ffabf05f9794edc599 Mon Sep 17 00:00:00 2001 From: Jack Hickey <133868041+nginx-jack@users.noreply.github.com> Date: Tue, 6 Aug 2024 15:32:39 +0100 Subject: [PATCH 02/30] Add docs-build-push github workflow (#765) * Add docs-build-push github workflow * Remove slash from docs_source_path --- .github/workflows/docs-build-push.yml | 36 +++++++++++++++++++++++++ site/README.md | 2 +- site/netlify.toml | 39 --------------------------- 3 files changed, 37 insertions(+), 40 deletions(-) create mode 100644 .github/workflows/docs-build-push.yml delete mode 100644 site/netlify.toml diff --git a/.github/workflows/docs-build-push.yml b/.github/workflows/docs-build-push.yml new file mode 100644 index 000000000..c3039c724 --- /dev/null +++ b/.github/workflows/docs-build-push.yml @@ -0,0 +1,36 @@ +name: Build and deploy (docs) +on: + workflow_dispatch: + inputs: + environment: + description: 'Environment to deploy to' + required: false + default: 'preview' + type: choice + options: + - preview + - dev + - staging + - prod + pull_request: + branches: + - "*" + paths: + - site/** + +jobs: + call-docs-build-push: + uses: nginxinc/docs-actions/.github/workflows/docs-build-push.yml@03a9a3808fcb77cd0c19d7fa5d59b25565dd1d6d # v1.0.2 + permissions: + pull-requests: write # needed to write preview url comment to PR + contents: read + with: + production_url_path: "/nginx-agent" + preview_url_path: "/previews/nginx-agent" + docs_source_path: "public/nginx-agent" + docs_build_path: "./site" + doc_type: "hugo" + environment: ${{inputs.environment}} + secrets: + AZURE_CREDENTIALS: ${{secrets.AZURE_CREDENTIALS_DOCS}} + AZURE_KEY_VAULT: ${{secrets.AZURE_KEY_VAULT_DOCS}} \ No newline at end of file diff --git a/site/README.md b/site/README.md index 7bc4416de..4b313bd1a 100644 --- a/site/README.md +++ b/site/README.md @@ -2,7 +2,7 @@ This directory contains all of the user documentation for NGINX Agent, as well as the requirements for linting, building, and publishing the documentation. -Docs are written in Markdown. We build the docs using [Hugo](https://gohugo.io) and host them on [Netlify](https://www.netlify.com/). +Docs are written in Markdown. We build the docs using [Hugo](https://gohugo.io). Previews and deployments are handled by the [docs-actions](https://github.com/nginxinc/docs-actions?tab=readme-ov-file#docs-actions) workflow. ## Setup diff --git a/site/netlify.toml b/site/netlify.toml deleted file mode 100644 index 8357e7214..000000000 --- a/site/netlify.toml +++ /dev/null @@ -1,39 +0,0 @@ -[build] - command = "make deploy-preview" - -[context.production] - command = "make all" - -[context.docs-development] - command = "make all-dev" - -[context.docs-staging] - command = "make all-staging" - -[context.deploy-preview] - command = "make deploy-preview" - -[context.branch-deploy] - command = "make deploy-preview" - -[[headers]] - for = "/*" - [headers.values] - Access-Control-Allow-Origin = "https://docs.nginx.com" - -[[redirects]] - from = "/" - to = "/nginx-agent/" - status = 301 - force = true - -[[redirects]] - from = "/nginx-agent/*" - to = "/nginx-agent/404.html" - status = 404 - -[[redirects]] - from = "/nginx-agent/robots.txt" - to = "https://docs.nginx.com/robots.txt" - status = 301 - force = true From 0bce226512060110bf4fc72ee8d0a90d53484817 Mon Sep 17 00:00:00 2001 From: Jack Hickey <133868041+nginx-jack@users.noreply.github.com> Date: Wed, 7 Aug 2024 11:58:01 +0100 Subject: [PATCH 03/30] Define top level read permission for docs-build-push (#769) --- .github/workflows/docs-build-push.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/docs-build-push.yml b/.github/workflows/docs-build-push.yml index c3039c724..ec799ae8c 100644 --- a/.github/workflows/docs-build-push.yml +++ b/.github/workflows/docs-build-push.yml @@ -18,6 +18,9 @@ on: paths: - site/** +permissions: + contents: read + jobs: call-docs-build-push: uses: nginxinc/docs-actions/.github/workflows/docs-build-push.yml@03a9a3808fcb77cd0c19d7fa5d59b25565dd1d6d # v1.0.2 From 641bf95faca064ff18dcf7d996ca097578a37315 Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Thu, 22 Aug 2024 16:51:55 +0100 Subject: [PATCH 04/30] feat: Add Agent v2 metrics catalogue This commit adds the Agent v2 metrics catalogue to the new v2 subsection. It is achieved by copying the existing catalogue within the NGINX Management Suite documentation, since it covers the same content. --- site/content/v2/metrics.md | 10 ++- site/data/.gitkeep | 1 - site/data/layouts/.gitkeep | 1 - .../v2metrics/client.network.latency.max.yml | 65 ++++++++++++++++++ .../v2metrics/client.request.latency.max.yml | 65 ++++++++++++++++++ .../v2metrics/client.response.latency.max.yml | 65 ++++++++++++++++++ .../v2metrics/client.ttfb.latency.max.yml | 66 +++++++++++++++++++ .../v2metrics/http.request.bytes_rcvd.yml | 62 +++++++++++++++++ .../v2metrics/http.request.bytes_sent.yml | 62 +++++++++++++++++ site/data/v2metrics/http.request.count.yml | 62 +++++++++++++++++ .../v2metrics/nginx.config.generation.yml | 36 ++++++++++ .../v2metrics/nginx.http.conn.accepted.yml | 36 ++++++++++ .../data/v2metrics/nginx.http.conn.active.yml | 36 ++++++++++ .../v2metrics/nginx.http.conn.current.yml | 36 ++++++++++ .../v2metrics/nginx.http.conn.dropped.yml | 36 ++++++++++ .../v2metrics/nginx.http.conn.handled.yml | 36 ++++++++++ site/data/v2metrics/nginx.http.conn.idle.yml | 36 ++++++++++ .../v2metrics/nginx.http.conn.reading.yml | 36 ++++++++++ .../v2metrics/nginx.http.conn.writing.yml | 36 ++++++++++ site/data/v2metrics/nginx.http.gzip.ratio.yml | 35 ++++++++++ .../v2metrics/nginx.http.method.delete.yml | 35 ++++++++++ site/data/v2metrics/nginx.http.method.get.yml | 35 ++++++++++ .../data/v2metrics/nginx.http.method.head.yml | 35 ++++++++++ .../v2metrics/nginx.http.method.options.yml | 35 ++++++++++ .../v2metrics/nginx.http.method.others.yml | 35 ++++++++++ .../data/v2metrics/nginx.http.method.post.yml | 35 ++++++++++ site/data/v2metrics/nginx.http.method.put.yml | 35 ++++++++++ .../nginx.http.request.body_bytes_sent.yml | 37 +++++++++++ .../v2metrics/nginx.http.request.buffered.yml | 35 ++++++++++ .../nginx.http.request.bytes_sent.yml | 35 ++++++++++ .../v2metrics/nginx.http.request.count.yml | 36 ++++++++++ .../v2metrics/nginx.http.request.current.yml | 36 ++++++++++ .../v2metrics/nginx.http.request.length.yml | 35 ++++++++++ .../nginx.http.request.malformed.yml | 35 ++++++++++ .../v2metrics/nginx.http.request.time.max.yml | 35 ++++++++++ .../nginx.http.request.time.median.yml | 35 ++++++++++ .../nginx.http.request.time.pctl95.yml | 35 ++++++++++ .../v2metrics/nginx.http.request.time.yml | 35 ++++++++++ site/data/v2metrics/nginx.http.status.1xx.yml | 37 +++++++++++ site/data/v2metrics/nginx.http.status.2xx.yml | 37 +++++++++++ site/data/v2metrics/nginx.http.status.3xx.yml | 37 +++++++++++ site/data/v2metrics/nginx.http.status.403.yml | 35 ++++++++++ site/data/v2metrics/nginx.http.status.404.yml | 35 ++++++++++ site/data/v2metrics/nginx.http.status.4xx.yml | 37 +++++++++++ site/data/v2metrics/nginx.http.status.500.yml | 35 ++++++++++ site/data/v2metrics/nginx.http.status.502.yml | 35 ++++++++++ site/data/v2metrics/nginx.http.status.503.yml | 35 ++++++++++ site/data/v2metrics/nginx.http.status.504.yml | 35 ++++++++++ site/data/v2metrics/nginx.http.status.5xx.yml | 37 +++++++++++ .../v2metrics/nginx.http.status.discarded.yml | 35 ++++++++++ site/data/v2metrics/nginx.http.v0_9.yml | 35 ++++++++++ site/data/v2metrics/nginx.http.v1_0.yml | 35 ++++++++++ site/data/v2metrics/nginx.http.v1_1.yml | 35 ++++++++++ site/data/v2metrics/nginx.http.v2.yml | 35 ++++++++++ site/data/v2metrics/nginx.status.yml | 36 ++++++++++ .../nginx.upstream.request.failed.yml | 35 ++++++++++ .../nginx.upstream.response.buffered.yml | 35 ++++++++++ .../nginx.upstream.response.failed.yml | 35 ++++++++++ site/data/v2metrics/nginx.workers.count.yml | 37 +++++++++++ .../v2metrics/nginx.workers.cpu.system.yml | 37 +++++++++++ .../v2metrics/nginx.workers.cpu.total.yml | 37 +++++++++++ .../data/v2metrics/nginx.workers.cpu.user.yml | 37 +++++++++++ .../v2metrics/nginx.workers.fds_count.yml | 37 +++++++++++ .../data/v2metrics/nginx.workers.io.kbs_r.yml | 37 +++++++++++ .../data/v2metrics/nginx.workers.io.kbs_w.yml | 37 +++++++++++ site/data/v2metrics/nginx.workers.mem.rss.yml | 37 +++++++++++ .../v2metrics/nginx.workers.mem.rss_pct.yml | 38 +++++++++++ site/data/v2metrics/nginx.workers.mem.vms.yml | 37 +++++++++++ .../v2metrics/nginx.workers.rlimit_nofile.yml | 38 +++++++++++ .../v2metrics/plus.cache.bypass.bytes.yml | 45 +++++++++++++ .../v2metrics/plus.cache.bypass.responses.yml | 47 +++++++++++++ .../v2metrics/plus.cache.expired.bytes.yml | 45 +++++++++++++ .../plus.cache.expired.responses.yml | 46 +++++++++++++ site/data/v2metrics/plus.cache.hit.bytes.yml | 45 +++++++++++++ .../v2metrics/plus.cache.hit.responses.yml | 46 +++++++++++++ site/data/v2metrics/plus.cache.max_size.yml | 45 +++++++++++++ site/data/v2metrics/plus.cache.miss.bytes.yml | 45 +++++++++++++ .../v2metrics/plus.cache.miss.responses.yml | 46 +++++++++++++ .../plus.cache.revalidated.bytes.yml | 45 +++++++++++++ .../plus.cache.revalidated.responses.yml | 47 +++++++++++++ site/data/v2metrics/plus.cache.size.yml | 45 +++++++++++++ .../data/v2metrics/plus.cache.stale.bytes.yml | 45 +++++++++++++ .../v2metrics/plus.cache.stale.responses.yml | 47 +++++++++++++ .../v2metrics/plus.cache.updating.bytes.yml | 45 +++++++++++++ .../plus.cache.updating.responses.yml | 47 +++++++++++++ .../plus.http.limit_conns.passed.yml | 36 ++++++++++ .../plus.http.limit_conns.rejected.yml | 36 ++++++++++ ...plus.http.limit_conns.rejected_dry_run.yml | 36 ++++++++++ .../plus.http.limit_reqs.delayed.yml | 36 ++++++++++ .../plus.http.limit_reqs.delayed_dry_run.yml | 36 ++++++++++ .../v2metrics/plus.http.limit_reqs.passed.yml | 36 ++++++++++ .../plus.http.limit_reqs.rejected.yml | 36 ++++++++++ .../plus.http.limit_reqs.rejected_dry_run.yml | 36 ++++++++++ .../plus.http.request.bytes_rcvd.yml | 38 +++++++++++ .../plus.http.request.bytes_sent.yml | 38 +++++++++++ .../v2metrics/plus.http.request.count.yml | 38 +++++++++++ .../v2metrics/plus.http.response.count.yml | 38 +++++++++++ site/data/v2metrics/plus.http.status.1xx.yml | 38 +++++++++++ site/data/v2metrics/plus.http.status.2xx.yml | 38 +++++++++++ site/data/v2metrics/plus.http.status.3xx.yml | 38 +++++++++++ site/data/v2metrics/plus.http.status.4xx.yml | 38 +++++++++++ site/data/v2metrics/plus.http.status.5xx.yml | 38 +++++++++++ .../v2metrics/plus.http.status.discarded.yml | 38 +++++++++++ .../v2metrics/plus.http.status.processing.yml | 37 +++++++++++ .../plus.http.upstream.keepalives.yml | 47 +++++++++++++ .../plus.http.upstream.peers.bytes_rcvd.yml | 49 ++++++++++++++ .../plus.http.upstream.peers.bytes_sent.yml | 49 ++++++++++++++ .../plus.http.upstream.peers.conn.active.yml | 49 ++++++++++++++ .../plus.http.upstream.peers.fails.yml | 49 ++++++++++++++ .../plus.http.upstream.peers.header_time.yml | 49 ++++++++++++++ ...tp.upstream.peers.health_checks.checks.yml | 49 ++++++++++++++ ...ttp.upstream.peers.health_checks.fails.yml | 49 ++++++++++++++ ...upstream.peers.health_checks.unhealthy.yml | 49 ++++++++++++++ ...plus.http.upstream.peers.request.count.yml | 49 ++++++++++++++ ...lus.http.upstream.peers.response.count.yml | 49 ++++++++++++++ ...plus.http.upstream.peers.response.time.yml | 49 ++++++++++++++ ...lus.http.upstream.peers.state.checking.yml | 51 ++++++++++++++ .../plus.http.upstream.peers.state.down.yml | 51 ++++++++++++++ ...lus.http.upstream.peers.state.draining.yml | 51 ++++++++++++++ ...plus.http.upstream.peers.state.unavail.yml | 51 ++++++++++++++ ...us.http.upstream.peers.state.unhealthy.yml | 51 ++++++++++++++ .../plus.http.upstream.peers.state.up.yml | 51 ++++++++++++++ .../plus.http.upstream.peers.status.1xx.yml | 49 ++++++++++++++ .../plus.http.upstream.peers.status.2xx.yml | 49 ++++++++++++++ .../plus.http.upstream.peers.status.3xx.yml | 50 ++++++++++++++ .../plus.http.upstream.peers.status.4xx.yml | 49 ++++++++++++++ .../plus.http.upstream.peers.status.5xx.yml | 49 ++++++++++++++ ...lus.http.upstream.peers.total.checking.yml | 47 +++++++++++++ .../plus.http.upstream.peers.total.down.yml | 47 +++++++++++++ ...lus.http.upstream.peers.total.draining.yml | 47 +++++++++++++ ...plus.http.upstream.peers.total.unavail.yml | 47 +++++++++++++ ...us.http.upstream.peers.total.unhealthy.yml | 47 +++++++++++++ .../plus.http.upstream.peers.total.up.yml | 47 +++++++++++++ .../plus.http.upstream.peers.unavail.yml | 50 ++++++++++++++ .../plus.http.upstream.queue.maxsize.yml | 46 +++++++++++++ .../plus.http.upstream.queue.overflows.yml | 47 +++++++++++++ .../plus.http.upstream.queue.size.yml | 46 +++++++++++++ .../v2metrics/plus.http.upstream.zombies.yml | 48 ++++++++++++++ site/data/v2metrics/plus.instance.count.yml | 34 ++++++++++ site/data/v2metrics/plus.slab.pages.free.yml | 40 +++++++++++ .../v2metrics/plus.slab.pages.pct_used.yml | 40 +++++++++++ site/data/v2metrics/plus.slab.pages.total.yml | 40 +++++++++++ site/data/v2metrics/plus.slab.pages.used.yml | 40 +++++++++++ site/data/v2metrics/plus.ssl.failed.yml | 36 ++++++++++ site/data/v2metrics/plus.ssl.handshakes.yml | 36 ++++++++++ site/data/v2metrics/plus.ssl.reuses.yml | 36 ++++++++++ .../data/v2metrics/plus.stream.bytes_rcvd.yml | 37 +++++++++++ .../data/v2metrics/plus.stream.bytes_sent.yml | 37 +++++++++++ .../v2metrics/plus.stream.connections.yml | 37 +++++++++++ site/data/v2metrics/plus.stream.discarded.yml | 38 +++++++++++ .../data/v2metrics/plus.stream.processing.yml | 37 +++++++++++ .../data/v2metrics/plus.stream.status.2xx.yml | 37 +++++++++++ .../data/v2metrics/plus.stream.status.4xx.yml | 37 +++++++++++ .../data/v2metrics/plus.stream.status.5xx.yml | 37 +++++++++++ .../v2metrics/plus.stream.status.total.yml | 37 +++++++++++ .../plus.stream.upstream.peers.bytes_rcvd.yml | 49 ++++++++++++++ .../plus.stream.upstream.peers.bytes_sent.yml | 49 ++++++++++++++ ...plus.stream.upstream.peers.conn.active.yml | 49 ++++++++++++++ .../plus.stream.upstream.peers.conn.count.yml | 49 ++++++++++++++ ...lus.stream.upstream.peers.connect_time.yml | 49 ++++++++++++++ .../plus.stream.upstream.peers.fails.yml | 49 ++++++++++++++ ...am.upstream.peers.health_checks.checks.yml | 49 ++++++++++++++ ...eam.upstream.peers.health_checks.fails.yml | 49 ++++++++++++++ ...upstream.peers.health_checks.unhealthy.yml | 49 ++++++++++++++ ...us.stream.upstream.peers.response.time.yml | 49 ++++++++++++++ ...s.stream.upstream.peers.state.checking.yml | 51 ++++++++++++++ .../plus.stream.upstream.peers.state.down.yml | 51 ++++++++++++++ ...s.stream.upstream.peers.state.draining.yml | 51 ++++++++++++++ ...us.stream.upstream.peers.state.unavail.yml | 51 ++++++++++++++ ....stream.upstream.peers.state.unhealthy.yml | 51 ++++++++++++++ .../plus.stream.upstream.peers.state.up.yml | 51 ++++++++++++++ ...s.stream.upstream.peers.total.checking.yml | 47 +++++++++++++ .../plus.stream.upstream.peers.total.down.yml | 47 +++++++++++++ ...s.stream.upstream.peers.total.draining.yml | 47 +++++++++++++ ...us.stream.upstream.peers.total.unavail.yml | 48 ++++++++++++++ ....stream.upstream.peers.total.unhealthy.yml | 47 +++++++++++++ .../plus.stream.upstream.peers.total.up.yml | 47 +++++++++++++ .../plus.stream.upstream.peers.ttfb.yml | 49 ++++++++++++++ .../plus.stream.upstream.peers.unavail.yml | 50 ++++++++++++++ .../plus.stream.upstream.zombies.yml | 48 ++++++++++++++ site/data/v2metrics/stream.bytes_rcvd.yml | 57 ++++++++++++++++ site/data/v2metrics/stream.bytes_sent.yml | 57 ++++++++++++++++ .../v2metrics/stream.connection_duration.yml | 57 ++++++++++++++++ site/data/v2metrics/stream.connections.yml | 57 ++++++++++++++++ site/data/v2metrics/system.cpu.idle.yml | 36 ++++++++++ site/data/v2metrics/system.cpu.iowait.yml | 36 ++++++++++ site/data/v2metrics/system.cpu.stolen.yml | 37 +++++++++++ site/data/v2metrics/system.cpu.system.yml | 36 ++++++++++ site/data/v2metrics/system.cpu.user.yml | 36 ++++++++++ site/data/v2metrics/system.disk.free.yml | 37 +++++++++++ site/data/v2metrics/system.disk.in_use.yml | 37 +++++++++++ site/data/v2metrics/system.disk.total.yml | 37 +++++++++++ site/data/v2metrics/system.disk.used.yml | 37 +++++++++++ site/data/v2metrics/system.io.iops_r.yml | 38 +++++++++++ site/data/v2metrics/system.io.iops_w.yml | 38 +++++++++++ site/data/v2metrics/system.io.kbs_r.yml | 38 +++++++++++ site/data/v2metrics/system.io.kbs_w.yml | 38 +++++++++++ site/data/v2metrics/system.io.wait_r.yml | 37 +++++++++++ site/data/v2metrics/system.io.wait_w.yml | 37 +++++++++++ site/data/v2metrics/system.load.1.yml | 37 +++++++++++ site/data/v2metrics/system.load.15.yml | 37 +++++++++++ site/data/v2metrics/system.load.5.yml | 37 +++++++++++ site/data/v2metrics/system.mem.available.yml | 36 ++++++++++ site/data/v2metrics/system.mem.buffered.yml | 36 ++++++++++ site/data/v2metrics/system.mem.cached.yml | 36 ++++++++++ site/data/v2metrics/system.mem.free.yml | 36 ++++++++++ site/data/v2metrics/system.mem.pct_used.yml | 36 ++++++++++ site/data/v2metrics/system.mem.shared.yml | 35 ++++++++++ site/data/v2metrics/system.mem.total.yml | 36 ++++++++++ site/data/v2metrics/system.mem.used.all.yml | 36 ++++++++++ site/data/v2metrics/system.mem.used.yml | 36 ++++++++++ site/data/v2metrics/system.net.bytes_rcvd.yml | 38 +++++++++++ site/data/v2metrics/system.net.bytes_sent.yml | 38 +++++++++++ .../v2metrics/system.net.drops_in.count.yml | 39 +++++++++++ .../v2metrics/system.net.drops_out.count.yml | 39 +++++++++++ .../v2metrics/system.net.listen_overflows.yml | 37 +++++++++++ .../v2metrics/system.net.packets_in.count.yml | 38 +++++++++++ .../v2metrics/system.net.packets_in.error.yml | 39 +++++++++++ .../system.net.packets_out.count.yml | 38 +++++++++++ .../system.net.packets_out.error.yml | 39 +++++++++++ site/data/v2metrics/system.swap.free.yml | 36 ++++++++++ site/data/v2metrics/system.swap.pct_free.yml | 36 ++++++++++ site/data/v2metrics/system.swap.total.yml | 36 ++++++++++ site/data/v2metrics/system.swap.used.yml | 36 ++++++++++ .../v2metrics/upstream.header.latency.max.yml | 65 ++++++++++++++++++ .../upstream.network.latency.max.yml | 65 ++++++++++++++++++ .../upstream.response.latency.max.yml | 65 ++++++++++++++++++ site/layouts/catalogs/single.html | 14 ++++ site/layouts/shortcodes/v2-metrics.html | 56 ++++++++++++++++ 229 files changed, 9493 insertions(+), 5 deletions(-) delete mode 100644 site/data/.gitkeep delete mode 100644 site/data/layouts/.gitkeep create mode 100644 site/data/v2metrics/client.network.latency.max.yml create mode 100644 site/data/v2metrics/client.request.latency.max.yml create mode 100644 site/data/v2metrics/client.response.latency.max.yml create mode 100644 site/data/v2metrics/client.ttfb.latency.max.yml create mode 100644 site/data/v2metrics/http.request.bytes_rcvd.yml create mode 100644 site/data/v2metrics/http.request.bytes_sent.yml create mode 100644 site/data/v2metrics/http.request.count.yml create mode 100644 site/data/v2metrics/nginx.config.generation.yml create mode 100644 site/data/v2metrics/nginx.http.conn.accepted.yml create mode 100644 site/data/v2metrics/nginx.http.conn.active.yml create mode 100644 site/data/v2metrics/nginx.http.conn.current.yml create mode 100644 site/data/v2metrics/nginx.http.conn.dropped.yml create mode 100644 site/data/v2metrics/nginx.http.conn.handled.yml create mode 100644 site/data/v2metrics/nginx.http.conn.idle.yml create mode 100644 site/data/v2metrics/nginx.http.conn.reading.yml create mode 100644 site/data/v2metrics/nginx.http.conn.writing.yml create mode 100644 site/data/v2metrics/nginx.http.gzip.ratio.yml create mode 100644 site/data/v2metrics/nginx.http.method.delete.yml create mode 100644 site/data/v2metrics/nginx.http.method.get.yml create mode 100644 site/data/v2metrics/nginx.http.method.head.yml create mode 100644 site/data/v2metrics/nginx.http.method.options.yml create mode 100644 site/data/v2metrics/nginx.http.method.others.yml create mode 100644 site/data/v2metrics/nginx.http.method.post.yml create mode 100644 site/data/v2metrics/nginx.http.method.put.yml create mode 100644 site/data/v2metrics/nginx.http.request.body_bytes_sent.yml create mode 100644 site/data/v2metrics/nginx.http.request.buffered.yml create mode 100644 site/data/v2metrics/nginx.http.request.bytes_sent.yml create mode 100644 site/data/v2metrics/nginx.http.request.count.yml create mode 100644 site/data/v2metrics/nginx.http.request.current.yml create mode 100644 site/data/v2metrics/nginx.http.request.length.yml create mode 100644 site/data/v2metrics/nginx.http.request.malformed.yml create mode 100644 site/data/v2metrics/nginx.http.request.time.max.yml create mode 100644 site/data/v2metrics/nginx.http.request.time.median.yml create mode 100644 site/data/v2metrics/nginx.http.request.time.pctl95.yml create mode 100644 site/data/v2metrics/nginx.http.request.time.yml create mode 100644 site/data/v2metrics/nginx.http.status.1xx.yml create mode 100644 site/data/v2metrics/nginx.http.status.2xx.yml create mode 100644 site/data/v2metrics/nginx.http.status.3xx.yml create mode 100644 site/data/v2metrics/nginx.http.status.403.yml create mode 100644 site/data/v2metrics/nginx.http.status.404.yml create mode 100644 site/data/v2metrics/nginx.http.status.4xx.yml create mode 100644 site/data/v2metrics/nginx.http.status.500.yml create mode 100644 site/data/v2metrics/nginx.http.status.502.yml create mode 100644 site/data/v2metrics/nginx.http.status.503.yml create mode 100644 site/data/v2metrics/nginx.http.status.504.yml create mode 100644 site/data/v2metrics/nginx.http.status.5xx.yml create mode 100644 site/data/v2metrics/nginx.http.status.discarded.yml create mode 100644 site/data/v2metrics/nginx.http.v0_9.yml create mode 100644 site/data/v2metrics/nginx.http.v1_0.yml create mode 100644 site/data/v2metrics/nginx.http.v1_1.yml create mode 100644 site/data/v2metrics/nginx.http.v2.yml create mode 100644 site/data/v2metrics/nginx.status.yml create mode 100644 site/data/v2metrics/nginx.upstream.request.failed.yml create mode 100644 site/data/v2metrics/nginx.upstream.response.buffered.yml create mode 100644 site/data/v2metrics/nginx.upstream.response.failed.yml create mode 100644 site/data/v2metrics/nginx.workers.count.yml create mode 100644 site/data/v2metrics/nginx.workers.cpu.system.yml create mode 100644 site/data/v2metrics/nginx.workers.cpu.total.yml create mode 100644 site/data/v2metrics/nginx.workers.cpu.user.yml create mode 100644 site/data/v2metrics/nginx.workers.fds_count.yml create mode 100644 site/data/v2metrics/nginx.workers.io.kbs_r.yml create mode 100644 site/data/v2metrics/nginx.workers.io.kbs_w.yml create mode 100644 site/data/v2metrics/nginx.workers.mem.rss.yml create mode 100644 site/data/v2metrics/nginx.workers.mem.rss_pct.yml create mode 100644 site/data/v2metrics/nginx.workers.mem.vms.yml create mode 100644 site/data/v2metrics/nginx.workers.rlimit_nofile.yml create mode 100644 site/data/v2metrics/plus.cache.bypass.bytes.yml create mode 100644 site/data/v2metrics/plus.cache.bypass.responses.yml create mode 100644 site/data/v2metrics/plus.cache.expired.bytes.yml create mode 100644 site/data/v2metrics/plus.cache.expired.responses.yml create mode 100644 site/data/v2metrics/plus.cache.hit.bytes.yml create mode 100644 site/data/v2metrics/plus.cache.hit.responses.yml create mode 100644 site/data/v2metrics/plus.cache.max_size.yml create mode 100644 site/data/v2metrics/plus.cache.miss.bytes.yml create mode 100644 site/data/v2metrics/plus.cache.miss.responses.yml create mode 100644 site/data/v2metrics/plus.cache.revalidated.bytes.yml create mode 100644 site/data/v2metrics/plus.cache.revalidated.responses.yml create mode 100644 site/data/v2metrics/plus.cache.size.yml create mode 100644 site/data/v2metrics/plus.cache.stale.bytes.yml create mode 100644 site/data/v2metrics/plus.cache.stale.responses.yml create mode 100644 site/data/v2metrics/plus.cache.updating.bytes.yml create mode 100644 site/data/v2metrics/plus.cache.updating.responses.yml create mode 100644 site/data/v2metrics/plus.http.limit_conns.passed.yml create mode 100644 site/data/v2metrics/plus.http.limit_conns.rejected.yml create mode 100644 site/data/v2metrics/plus.http.limit_conns.rejected_dry_run.yml create mode 100644 site/data/v2metrics/plus.http.limit_reqs.delayed.yml create mode 100644 site/data/v2metrics/plus.http.limit_reqs.delayed_dry_run.yml create mode 100644 site/data/v2metrics/plus.http.limit_reqs.passed.yml create mode 100644 site/data/v2metrics/plus.http.limit_reqs.rejected.yml create mode 100644 site/data/v2metrics/plus.http.limit_reqs.rejected_dry_run.yml create mode 100644 site/data/v2metrics/plus.http.request.bytes_rcvd.yml create mode 100644 site/data/v2metrics/plus.http.request.bytes_sent.yml create mode 100644 site/data/v2metrics/plus.http.request.count.yml create mode 100644 site/data/v2metrics/plus.http.response.count.yml create mode 100644 site/data/v2metrics/plus.http.status.1xx.yml create mode 100644 site/data/v2metrics/plus.http.status.2xx.yml create mode 100644 site/data/v2metrics/plus.http.status.3xx.yml create mode 100644 site/data/v2metrics/plus.http.status.4xx.yml create mode 100644 site/data/v2metrics/plus.http.status.5xx.yml create mode 100644 site/data/v2metrics/plus.http.status.discarded.yml create mode 100644 site/data/v2metrics/plus.http.status.processing.yml create mode 100644 site/data/v2metrics/plus.http.upstream.keepalives.yml create mode 100644 site/data/v2metrics/plus.http.upstream.peers.bytes_rcvd.yml create mode 100644 site/data/v2metrics/plus.http.upstream.peers.bytes_sent.yml create mode 100644 site/data/v2metrics/plus.http.upstream.peers.conn.active.yml create mode 100644 site/data/v2metrics/plus.http.upstream.peers.fails.yml create mode 100644 site/data/v2metrics/plus.http.upstream.peers.header_time.yml create mode 100644 site/data/v2metrics/plus.http.upstream.peers.health_checks.checks.yml create mode 100644 site/data/v2metrics/plus.http.upstream.peers.health_checks.fails.yml create mode 100644 site/data/v2metrics/plus.http.upstream.peers.health_checks.unhealthy.yml create mode 100644 site/data/v2metrics/plus.http.upstream.peers.request.count.yml create mode 100644 site/data/v2metrics/plus.http.upstream.peers.response.count.yml create mode 100644 site/data/v2metrics/plus.http.upstream.peers.response.time.yml create mode 100644 site/data/v2metrics/plus.http.upstream.peers.state.checking.yml create mode 100644 site/data/v2metrics/plus.http.upstream.peers.state.down.yml create mode 100644 site/data/v2metrics/plus.http.upstream.peers.state.draining.yml create mode 100644 site/data/v2metrics/plus.http.upstream.peers.state.unavail.yml create mode 100644 site/data/v2metrics/plus.http.upstream.peers.state.unhealthy.yml create mode 100644 site/data/v2metrics/plus.http.upstream.peers.state.up.yml create mode 100644 site/data/v2metrics/plus.http.upstream.peers.status.1xx.yml create mode 100644 site/data/v2metrics/plus.http.upstream.peers.status.2xx.yml create mode 100644 site/data/v2metrics/plus.http.upstream.peers.status.3xx.yml create mode 100644 site/data/v2metrics/plus.http.upstream.peers.status.4xx.yml create mode 100644 site/data/v2metrics/plus.http.upstream.peers.status.5xx.yml create mode 100644 site/data/v2metrics/plus.http.upstream.peers.total.checking.yml create mode 100644 site/data/v2metrics/plus.http.upstream.peers.total.down.yml create mode 100644 site/data/v2metrics/plus.http.upstream.peers.total.draining.yml create mode 100644 site/data/v2metrics/plus.http.upstream.peers.total.unavail.yml create mode 100644 site/data/v2metrics/plus.http.upstream.peers.total.unhealthy.yml create mode 100644 site/data/v2metrics/plus.http.upstream.peers.total.up.yml create mode 100644 site/data/v2metrics/plus.http.upstream.peers.unavail.yml create mode 100644 site/data/v2metrics/plus.http.upstream.queue.maxsize.yml create mode 100644 site/data/v2metrics/plus.http.upstream.queue.overflows.yml create mode 100644 site/data/v2metrics/plus.http.upstream.queue.size.yml create mode 100644 site/data/v2metrics/plus.http.upstream.zombies.yml create mode 100644 site/data/v2metrics/plus.instance.count.yml create mode 100644 site/data/v2metrics/plus.slab.pages.free.yml create mode 100644 site/data/v2metrics/plus.slab.pages.pct_used.yml create mode 100644 site/data/v2metrics/plus.slab.pages.total.yml create mode 100644 site/data/v2metrics/plus.slab.pages.used.yml create mode 100644 site/data/v2metrics/plus.ssl.failed.yml create mode 100644 site/data/v2metrics/plus.ssl.handshakes.yml create mode 100644 site/data/v2metrics/plus.ssl.reuses.yml create mode 100644 site/data/v2metrics/plus.stream.bytes_rcvd.yml create mode 100644 site/data/v2metrics/plus.stream.bytes_sent.yml create mode 100644 site/data/v2metrics/plus.stream.connections.yml create mode 100644 site/data/v2metrics/plus.stream.discarded.yml create mode 100644 site/data/v2metrics/plus.stream.processing.yml create mode 100644 site/data/v2metrics/plus.stream.status.2xx.yml create mode 100644 site/data/v2metrics/plus.stream.status.4xx.yml create mode 100644 site/data/v2metrics/plus.stream.status.5xx.yml create mode 100644 site/data/v2metrics/plus.stream.status.total.yml create mode 100644 site/data/v2metrics/plus.stream.upstream.peers.bytes_rcvd.yml create mode 100644 site/data/v2metrics/plus.stream.upstream.peers.bytes_sent.yml create mode 100644 site/data/v2metrics/plus.stream.upstream.peers.conn.active.yml create mode 100644 site/data/v2metrics/plus.stream.upstream.peers.conn.count.yml create mode 100644 site/data/v2metrics/plus.stream.upstream.peers.connect_time.yml create mode 100644 site/data/v2metrics/plus.stream.upstream.peers.fails.yml create mode 100644 site/data/v2metrics/plus.stream.upstream.peers.health_checks.checks.yml create mode 100644 site/data/v2metrics/plus.stream.upstream.peers.health_checks.fails.yml create mode 100644 site/data/v2metrics/plus.stream.upstream.peers.health_checks.unhealthy.yml create mode 100644 site/data/v2metrics/plus.stream.upstream.peers.response.time.yml create mode 100644 site/data/v2metrics/plus.stream.upstream.peers.state.checking.yml create mode 100644 site/data/v2metrics/plus.stream.upstream.peers.state.down.yml create mode 100644 site/data/v2metrics/plus.stream.upstream.peers.state.draining.yml create mode 100644 site/data/v2metrics/plus.stream.upstream.peers.state.unavail.yml create mode 100644 site/data/v2metrics/plus.stream.upstream.peers.state.unhealthy.yml create mode 100644 site/data/v2metrics/plus.stream.upstream.peers.state.up.yml create mode 100644 site/data/v2metrics/plus.stream.upstream.peers.total.checking.yml create mode 100644 site/data/v2metrics/plus.stream.upstream.peers.total.down.yml create mode 100644 site/data/v2metrics/plus.stream.upstream.peers.total.draining.yml create mode 100644 site/data/v2metrics/plus.stream.upstream.peers.total.unavail.yml create mode 100644 site/data/v2metrics/plus.stream.upstream.peers.total.unhealthy.yml create mode 100644 site/data/v2metrics/plus.stream.upstream.peers.total.up.yml create mode 100644 site/data/v2metrics/plus.stream.upstream.peers.ttfb.yml create mode 100644 site/data/v2metrics/plus.stream.upstream.peers.unavail.yml create mode 100644 site/data/v2metrics/plus.stream.upstream.zombies.yml create mode 100644 site/data/v2metrics/stream.bytes_rcvd.yml create mode 100644 site/data/v2metrics/stream.bytes_sent.yml create mode 100644 site/data/v2metrics/stream.connection_duration.yml create mode 100644 site/data/v2metrics/stream.connections.yml create mode 100644 site/data/v2metrics/system.cpu.idle.yml create mode 100644 site/data/v2metrics/system.cpu.iowait.yml create mode 100644 site/data/v2metrics/system.cpu.stolen.yml create mode 100644 site/data/v2metrics/system.cpu.system.yml create mode 100644 site/data/v2metrics/system.cpu.user.yml create mode 100644 site/data/v2metrics/system.disk.free.yml create mode 100644 site/data/v2metrics/system.disk.in_use.yml create mode 100644 site/data/v2metrics/system.disk.total.yml create mode 100644 site/data/v2metrics/system.disk.used.yml create mode 100644 site/data/v2metrics/system.io.iops_r.yml create mode 100644 site/data/v2metrics/system.io.iops_w.yml create mode 100644 site/data/v2metrics/system.io.kbs_r.yml create mode 100644 site/data/v2metrics/system.io.kbs_w.yml create mode 100644 site/data/v2metrics/system.io.wait_r.yml create mode 100644 site/data/v2metrics/system.io.wait_w.yml create mode 100644 site/data/v2metrics/system.load.1.yml create mode 100644 site/data/v2metrics/system.load.15.yml create mode 100644 site/data/v2metrics/system.load.5.yml create mode 100644 site/data/v2metrics/system.mem.available.yml create mode 100644 site/data/v2metrics/system.mem.buffered.yml create mode 100644 site/data/v2metrics/system.mem.cached.yml create mode 100644 site/data/v2metrics/system.mem.free.yml create mode 100644 site/data/v2metrics/system.mem.pct_used.yml create mode 100644 site/data/v2metrics/system.mem.shared.yml create mode 100644 site/data/v2metrics/system.mem.total.yml create mode 100644 site/data/v2metrics/system.mem.used.all.yml create mode 100644 site/data/v2metrics/system.mem.used.yml create mode 100644 site/data/v2metrics/system.net.bytes_rcvd.yml create mode 100644 site/data/v2metrics/system.net.bytes_sent.yml create mode 100644 site/data/v2metrics/system.net.drops_in.count.yml create mode 100644 site/data/v2metrics/system.net.drops_out.count.yml create mode 100644 site/data/v2metrics/system.net.listen_overflows.yml create mode 100644 site/data/v2metrics/system.net.packets_in.count.yml create mode 100644 site/data/v2metrics/system.net.packets_in.error.yml create mode 100644 site/data/v2metrics/system.net.packets_out.count.yml create mode 100644 site/data/v2metrics/system.net.packets_out.error.yml create mode 100644 site/data/v2metrics/system.swap.free.yml create mode 100644 site/data/v2metrics/system.swap.pct_free.yml create mode 100644 site/data/v2metrics/system.swap.total.yml create mode 100644 site/data/v2metrics/system.swap.used.yml create mode 100644 site/data/v2metrics/upstream.header.latency.max.yml create mode 100644 site/data/v2metrics/upstream.network.latency.max.yml create mode 100644 site/data/v2metrics/upstream.response.latency.max.yml create mode 100644 site/layouts/catalogs/single.html create mode 100644 site/layouts/shortcodes/v2-metrics.html diff --git a/site/content/v2/metrics.md b/site/content/v2/metrics.md index 934fd8af7..2de0cb9a5 100644 --- a/site/content/v2/metrics.md +++ b/site/content/v2/metrics.md @@ -1,5 +1,9 @@ --- -title: NGINX Agent v2 Metrics -docs: DOCS-000 +title: Metrics +catalog: true +catalogType: v2metrics weight: 200 ---- \ No newline at end of file +docs: DOCS-000 +--- + +{{< v2-metrics >}} \ No newline at end of file diff --git a/site/data/.gitkeep b/site/data/.gitkeep deleted file mode 100644 index c3bb2f98b..000000000 --- a/site/data/.gitkeep +++ /dev/null @@ -1 +0,0 @@ -Add or mount data sources here \ No newline at end of file diff --git a/site/data/layouts/.gitkeep b/site/data/layouts/.gitkeep deleted file mode 100644 index 02dbb3db1..000000000 --- a/site/data/layouts/.gitkeep +++ /dev/null @@ -1 +0,0 @@ -Add or mount custom layouts here \ No newline at end of file diff --git a/site/data/v2metrics/client.network.latency.max.yml b/site/data/v2metrics/client.network.latency.max.yml new file mode 100644 index 000000000..ef331b7f8 --- /dev/null +++ b/site/data/v2metrics/client.network.latency.max.yml @@ -0,0 +1,65 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: client.network.latency.max +categories: + - advanced-metrics +description: + Maximal network latency on the client-side derived from TCP connection handshake. + If `family` dimension is set to `web`, the request was `http` type + and if the `family` is set to `tcp-udp`, the request was `stream` type. +type: gauge +source: advanced-metrics-module +unit: milliseconds +rate: "" +visible: true +compound_payload: "false" +modules: + - adm + - acm +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - app + - environment + - component + - gateway + - http.hostname + - http.request_method + - http.response_code + - http.upstream_addr + - http.uri + - http.version_schema + - system_id + - hostname + - display_name + - nginx_id + - instance_group + - system.tags + - acm_api_proxy_hostname + - acm_api_proxy_name + - acm_api_proxy_version + - acm_environments_name + - acm_environments_type + - acm_infra_workspaces_name + - acm_service_workspaces_name + - family + - proxied_protocol + - site + - environment_name + - gateway_name + - component_name + - app_name + - site_name diff --git a/site/data/v2metrics/client.request.latency.max.yml b/site/data/v2metrics/client.request.latency.max.yml new file mode 100644 index 000000000..ac18ee097 --- /dev/null +++ b/site/data/v2metrics/client.request.latency.max.yml @@ -0,0 +1,65 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: client.request.latency.max +categories: + - advanced-metrics +description: + Maximal request latency on the client-side derived from HTTP(S) requests. + If `family` dimension is set to `web`, the request was `http` type + and if the `family` is set to `tcp-udp`, the request was `stream` type. +type: gauge +source: advanced-metrics-module +unit: milliseconds +rate: "" +visible: true +compound_payload: "false" +modules: + - adm + - acm +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - app + - environment + - component + - gateway + - http.hostname + - http.request_method + - http.response_code + - http.upstream_addr + - http.uri + - http.version_schema + - system_id + - hostname + - display_name + - nginx_id + - instance_group + - system.tags + - acm_api_proxy_hostname + - acm_api_proxy_name + - acm_api_proxy_version + - acm_environments_name + - acm_environments_type + - acm_infra_workspaces_name + - acm_service_workspaces_name + - family + - proxied_protocol + - site + - environment_name + - gateway_name + - component_name + - app_name + - site_name diff --git a/site/data/v2metrics/client.response.latency.max.yml b/site/data/v2metrics/client.response.latency.max.yml new file mode 100644 index 000000000..090089518 --- /dev/null +++ b/site/data/v2metrics/client.response.latency.max.yml @@ -0,0 +1,65 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: client.response.latency.max +categories: + - advanced-metrics +description: + Maximal response latency on the client-side derived from HTTP(S) requests. + If `family` dimension is set to `web`, the request was `http` type + and if the `family` is set to `tcp-udp`, the request was `stream` type. +type: gauge +source: advanced-metrics-module +unit: milliseconds +rate: "" +visible: true +compound_payload: "false" +modules: + - adm + - acm +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - app + - environment + - component + - gateway + - http.hostname + - http.request_method + - http.response_code + - http.upstream_addr + - http.uri + - http.version_schema + - system_id + - hostname + - display_name + - nginx_id + - instance_group + - system.tags + - acm_api_proxy_hostname + - acm_api_proxy_name + - acm_api_proxy_version + - acm_environments_name + - acm_environments_type + - acm_infra_workspaces_name + - acm_service_workspaces_name + - family + - proxied_protocol + - site + - environment_name + - gateway_name + - component_name + - app_name + - site_name diff --git a/site/data/v2metrics/client.ttfb.latency.max.yml b/site/data/v2metrics/client.ttfb.latency.max.yml new file mode 100644 index 000000000..06ceeca77 --- /dev/null +++ b/site/data/v2metrics/client.ttfb.latency.max.yml @@ -0,0 +1,66 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: client.ttfb.latency.max +categories: + - advanced-metrics +description: + Maximal time measured on the client-side from sending the first byte + of the request until receiving the first byte of the response. + If `family` dimension is set to `web`, the request was `http` type + and if the `family` is set to `tcp-udp`, the request was `stream` type. +type: gauge +source: advanced-metrics-module +unit: milliseconds +rate: "" +visible: true +compound_payload: "false" +modules: + - adm + - acm +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - app + - environment + - component + - gateway + - http.hostname + - http.request_method + - http.response_code + - http.upstream_addr + - http.uri + - http.version_schema + - system_id + - hostname + - display_name + - nginx_id + - instance_group + - system.tags + - acm_api_proxy_hostname + - acm_api_proxy_name + - acm_api_proxy_version + - acm_environments_name + - acm_environments_type + - acm_infra_workspaces_name + - acm_service_workspaces_name + - family + - proxied_protocol + - site + - environment_name + - gateway_name + - component_name + - app_name + - site_name diff --git a/site/data/v2metrics/http.request.bytes_rcvd.yml b/site/data/v2metrics/http.request.bytes_rcvd.yml new file mode 100644 index 000000000..0aea4ae26 --- /dev/null +++ b/site/data/v2metrics/http.request.bytes_rcvd.yml @@ -0,0 +1,62 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: http.request.bytes_rcvd +categories: + - advanced-metrics +description: The total number of bytes received from clients. +type: counter +source: advanced-metrics-module +unit: bytes +rate: net_io_rate +visible: true +compound_payload: "false" +modules: + - adm + - acm +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - app + - environment + - component + - gateway + - http.hostname + - http.request_method + - http.response_code + - http.upstream_addr + - http.uri + - http.version_schema + - system_id + - hostname + - display_name + - nginx_id + - instance_group + - system.tags + - acm_api_proxy_hostname + - acm_api_proxy_name + - acm_api_proxy_version + - acm_environments_name + - acm_environments_type + - acm_infra_workspaces_name + - acm_service_workspaces_name + - family + - proxied_protocol + - site + - environment_name + - gateway_name + - component_name + - app_name + - site_name diff --git a/site/data/v2metrics/http.request.bytes_sent.yml b/site/data/v2metrics/http.request.bytes_sent.yml new file mode 100644 index 000000000..2460c35bc --- /dev/null +++ b/site/data/v2metrics/http.request.bytes_sent.yml @@ -0,0 +1,62 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: http.request.bytes_sent +categories: + - advanced-metrics +description: The total number of bytes sent from clients. +type: counter +source: advanced-metrics-module +unit: bytes +rate: net_io_rate +visible: true +compound_payload: "false" +modules: + - adm + - acm +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - app + - environment + - component + - gateway + - http.hostname + - http.request_method + - http.response_code + - http.upstream_addr + - http.uri + - http.version_schema + - system_id + - hostname + - display_name + - nginx_id + - instance_group + - system.tags + - acm_api_proxy_hostname + - acm_api_proxy_name + - acm_api_proxy_version + - acm_environments_name + - acm_environments_type + - acm_infra_workspaces_name + - acm_service_workspaces_name + - family + - proxied_protocol + - site + - environment_name + - gateway_name + - component_name + - app_name + - site_name diff --git a/site/data/v2metrics/http.request.count.yml b/site/data/v2metrics/http.request.count.yml new file mode 100644 index 000000000..12b585696 --- /dev/null +++ b/site/data/v2metrics/http.request.count.yml @@ -0,0 +1,62 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: http.request.count +categories: + - advanced-metrics +description: The total number of client requests received from clients. +type: counter +source: advanced-metrics-module +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: + - adm + - acm +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - app + - environment + - component + - gateway + - http.hostname + - http.request_method + - http.response_code + - http.upstream_addr + - http.uri + - http.version_schema + - system_id + - hostname + - display_name + - nginx_id + - instance_group + - system.tags + - acm_api_proxy_hostname + - acm_api_proxy_name + - acm_api_proxy_version + - acm_environments_name + - acm_environments_type + - acm_infra_workspaces_name + - acm_service_workspaces_name + - family + - proxied_protocol + - site + - environment_name + - gateway_name + - component_name + - app_name + - site_name diff --git a/site/data/v2metrics/nginx.config.generation.yml b/site/data/v2metrics/nginx.config.generation.yml new file mode 100644 index 000000000..cdee83001 --- /dev/null +++ b/site/data/v2metrics/nginx.config.generation.yml @@ -0,0 +1,36 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.config.generation +categories: +- nginx +description: The total number of configuration reloads. +type: counter +counted: true +source: self +unit: integer +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/nginx.http.conn.accepted.yml b/site/data/v2metrics/nginx.http.conn.accepted.yml new file mode 100644 index 000000000..de3857f77 --- /dev/null +++ b/site/data/v2metrics/nginx.http.conn.accepted.yml @@ -0,0 +1,36 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.conn.accepted +categories: +- nginx +description: NGINX-wide statistics describing HTTP connections. +type: counter +source: stub_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/nginx.http.conn.active.yml b/site/data/v2metrics/nginx.http.conn.active.yml new file mode 100644 index 000000000..5a3709ba9 --- /dev/null +++ b/site/data/v2metrics/nginx.http.conn.active.yml @@ -0,0 +1,36 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.conn.active +categories: +- nginx +description: NGINX-wide statistics describing HTTP connections. +type: gauge +source: stub_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/nginx.http.conn.current.yml b/site/data/v2metrics/nginx.http.conn.current.yml new file mode 100644 index 000000000..f8ebb8a6e --- /dev/null +++ b/site/data/v2metrics/nginx.http.conn.current.yml @@ -0,0 +1,36 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.conn.current +categories: +- nginx +description: NGINX-wide statistics describing HTTP connections. +type: gauge +source: stub_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/nginx.http.conn.dropped.yml b/site/data/v2metrics/nginx.http.conn.dropped.yml new file mode 100644 index 000000000..566a32340 --- /dev/null +++ b/site/data/v2metrics/nginx.http.conn.dropped.yml @@ -0,0 +1,36 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.conn.dropped +categories: +- nginx +description: NGINX-wide statistics describing HTTP connections. +type: counter +source: stub_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/nginx.http.conn.handled.yml b/site/data/v2metrics/nginx.http.conn.handled.yml new file mode 100644 index 000000000..ace364c3a --- /dev/null +++ b/site/data/v2metrics/nginx.http.conn.handled.yml @@ -0,0 +1,36 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.conn.handled +categories: +- nginx +description: NGINX-wide statistics describing HTTP connections. +type: counter +source: stub_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/nginx.http.conn.idle.yml b/site/data/v2metrics/nginx.http.conn.idle.yml new file mode 100644 index 000000000..1002f6bc1 --- /dev/null +++ b/site/data/v2metrics/nginx.http.conn.idle.yml @@ -0,0 +1,36 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.conn.idle +categories: +- nginx +description: NGINX-wide statistics describing HTTP connections. +type: gauge +source: stub_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/nginx.http.conn.reading.yml b/site/data/v2metrics/nginx.http.conn.reading.yml new file mode 100644 index 000000000..6cf02091c --- /dev/null +++ b/site/data/v2metrics/nginx.http.conn.reading.yml @@ -0,0 +1,36 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.conn.reading +categories: +- nginx +description: NGINX-wide statistics describing HTTP connections. +type: gauge +source: stub_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/nginx.http.conn.writing.yml b/site/data/v2metrics/nginx.http.conn.writing.yml new file mode 100644 index 000000000..c918d8fb8 --- /dev/null +++ b/site/data/v2metrics/nginx.http.conn.writing.yml @@ -0,0 +1,36 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.conn.writing +categories: +- nginx +description: NGINX-wide statistics describing HTTP connections. +type: gauge +source: stub_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/nginx.http.gzip.ratio.yml b/site/data/v2metrics/nginx.http.gzip.ratio.yml new file mode 100644 index 000000000..450409ae7 --- /dev/null +++ b/site/data/v2metrics/nginx.http.gzip.ratio.yml @@ -0,0 +1,35 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.gzip.ratio +categories: + - nginx +description: "The compression ratio achieved on responses using `gzip,` computed as the ratio between the original and compressed response sizes." +type: gauge +source: access_log +unit: integer +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - system.tags + - instance_group diff --git a/site/data/v2metrics/nginx.http.method.delete.yml b/site/data/v2metrics/nginx.http.method.delete.yml new file mode 100644 index 000000000..f8043428f --- /dev/null +++ b/site/data/v2metrics/nginx.http.method.delete.yml @@ -0,0 +1,35 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.method.delete +categories: + - nginx +description: "The total number of requests with the method - DELETE." +type: counter +source: access_log +unit: integer +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - system.tags + - instance_group diff --git a/site/data/v2metrics/nginx.http.method.get.yml b/site/data/v2metrics/nginx.http.method.get.yml new file mode 100644 index 000000000..1cb18bb1d --- /dev/null +++ b/site/data/v2metrics/nginx.http.method.get.yml @@ -0,0 +1,35 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.method.get +categories: + - nginx +description: "The total number of requests with the method - GET." +type: counter +source: access_log +unit: integer +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - system.tags + - instance_group diff --git a/site/data/v2metrics/nginx.http.method.head.yml b/site/data/v2metrics/nginx.http.method.head.yml new file mode 100644 index 000000000..28fbd605e --- /dev/null +++ b/site/data/v2metrics/nginx.http.method.head.yml @@ -0,0 +1,35 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.method.head +categories: + - nginx +description: "The total number of requests with the method - HEAD." +type: counter +source: access_log +unit: integer +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - system.tags + - instance_group diff --git a/site/data/v2metrics/nginx.http.method.options.yml b/site/data/v2metrics/nginx.http.method.options.yml new file mode 100644 index 000000000..6fdc005e2 --- /dev/null +++ b/site/data/v2metrics/nginx.http.method.options.yml @@ -0,0 +1,35 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.method.options +categories: + - nginx +description: "The total number of requests with the method - OPTIONS." +type: counter +source: access_log +unit: integer +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - system.tags + - instance_group diff --git a/site/data/v2metrics/nginx.http.method.others.yml b/site/data/v2metrics/nginx.http.method.others.yml new file mode 100644 index 000000000..ac161dbd7 --- /dev/null +++ b/site/data/v2metrics/nginx.http.method.others.yml @@ -0,0 +1,35 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.method.others +categories: + - nginx +description: "The total number of requests with the method - OTHERS." +type: counter +source: access_log +unit: integer +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - system.tags + - instance_group diff --git a/site/data/v2metrics/nginx.http.method.post.yml b/site/data/v2metrics/nginx.http.method.post.yml new file mode 100644 index 000000000..17abefe61 --- /dev/null +++ b/site/data/v2metrics/nginx.http.method.post.yml @@ -0,0 +1,35 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.method.post +categories: + - nginx +description: "The total number of requests with the method - POST." +type: counter +source: access_log +unit: integer +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - system.tags + - instance_group diff --git a/site/data/v2metrics/nginx.http.method.put.yml b/site/data/v2metrics/nginx.http.method.put.yml new file mode 100644 index 000000000..28389e07f --- /dev/null +++ b/site/data/v2metrics/nginx.http.method.put.yml @@ -0,0 +1,35 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.method.put +categories: + - nginx +description: "The total number of requests with the method - PUT." +type: counter +source: access_log +unit: integer +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - system.tags + - instance_group diff --git a/site/data/v2metrics/nginx.http.request.body_bytes_sent.yml b/site/data/v2metrics/nginx.http.request.body_bytes_sent.yml new file mode 100644 index 000000000..d8d1aac2b --- /dev/null +++ b/site/data/v2metrics/nginx.http.request.body_bytes_sent.yml @@ -0,0 +1,37 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.request.body_bytes_sent +categories: +- nginx +description: Number of bytes sent to clients, not counting response headers. +type: counter +counted: true +source: access_combined +unit: bytes +rate: net_io_rate +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/nginx.http.request.buffered.yml b/site/data/v2metrics/nginx.http.request.buffered.yml new file mode 100644 index 000000000..ffe0fcbab --- /dev/null +++ b/site/data/v2metrics/nginx.http.request.buffered.yml @@ -0,0 +1,35 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.request.buffered +categories: + - nginx +description: "The total number of HTTP requests with request body buffered." +type: counter +source: error_log +unit: integer +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - system.tags + - instance_group diff --git a/site/data/v2metrics/nginx.http.request.bytes_sent.yml b/site/data/v2metrics/nginx.http.request.bytes_sent.yml new file mode 100644 index 000000000..9c0c422e9 --- /dev/null +++ b/site/data/v2metrics/nginx.http.request.bytes_sent.yml @@ -0,0 +1,35 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.request.bytes_sent +categories: + - nginx +description: "The number of bytes sent to a client." +type: gauge +source: access_log +unit: integer +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - system.tags + - instance_group diff --git a/site/data/v2metrics/nginx.http.request.count.yml b/site/data/v2metrics/nginx.http.request.count.yml new file mode 100644 index 000000000..91a4fa86a --- /dev/null +++ b/site/data/v2metrics/nginx.http.request.count.yml @@ -0,0 +1,36 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.request.count +categories: +- nginx +description: Total number of client requests. +type: counter +source: stub_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/nginx.http.request.current.yml b/site/data/v2metrics/nginx.http.request.current.yml new file mode 100644 index 000000000..d51fac058 --- /dev/null +++ b/site/data/v2metrics/nginx.http.request.current.yml @@ -0,0 +1,36 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.request.current +categories: +- nginx +description: Number of currently active requests (reading and writing). +type: counter +source: stub_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/nginx.http.request.length.yml b/site/data/v2metrics/nginx.http.request.length.yml new file mode 100644 index 000000000..2884d39e5 --- /dev/null +++ b/site/data/v2metrics/nginx.http.request.length.yml @@ -0,0 +1,35 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.request.length +categories: + - nginx +description: "The request length (including request line, header, and request body)." +type: gauge +source: access_log +unit: integer +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - system.tags + - instance_group diff --git a/site/data/v2metrics/nginx.http.request.malformed.yml b/site/data/v2metrics/nginx.http.request.malformed.yml new file mode 100644 index 000000000..80f5e7338 --- /dev/null +++ b/site/data/v2metrics/nginx.http.request.malformed.yml @@ -0,0 +1,35 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.request.malformed +categories: + - nginx +description: "The total number of malformed requests (i.e., HTTP Status 400)." +type: counter +source: access_log +unit: integer +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - system.tags + - instance_group diff --git a/site/data/v2metrics/nginx.http.request.time.max.yml b/site/data/v2metrics/nginx.http.request.time.max.yml new file mode 100644 index 000000000..7b574cb33 --- /dev/null +++ b/site/data/v2metrics/nginx.http.request.time.max.yml @@ -0,0 +1,35 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.request.time.max +categories: + - nginx +description: "The maximum request time, a request time is the full request processing time by NGINX." +type: gauge +source: access_log +unit: integer +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - system.tags + - instance_group diff --git a/site/data/v2metrics/nginx.http.request.time.median.yml b/site/data/v2metrics/nginx.http.request.time.median.yml new file mode 100644 index 000000000..64b01db46 --- /dev/null +++ b/site/data/v2metrics/nginx.http.request.time.median.yml @@ -0,0 +1,35 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.request.time.median +categories: + - nginx +description: "The median request time, a request time is the full request processing time by NGINX." +type: gauge +source: access_log +unit: integer +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - system.tags + - instance_group diff --git a/site/data/v2metrics/nginx.http.request.time.pctl95.yml b/site/data/v2metrics/nginx.http.request.time.pctl95.yml new file mode 100644 index 000000000..5d8ce546c --- /dev/null +++ b/site/data/v2metrics/nginx.http.request.time.pctl95.yml @@ -0,0 +1,35 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.request.time.pctl95 +categories: + - nginx +description: "The 95th percentile of request times, a request time is the full request processing time by NGINX." +type: gauge +source: access_log +unit: integer +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - system.tags + - instance_group diff --git a/site/data/v2metrics/nginx.http.request.time.yml b/site/data/v2metrics/nginx.http.request.time.yml new file mode 100644 index 000000000..1486f9074 --- /dev/null +++ b/site/data/v2metrics/nginx.http.request.time.yml @@ -0,0 +1,35 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.request.time +categories: + - nginx +description: "The full request processing time by NGINX, starting when NGINX reads the first byte from the client and ending when NGINX sends the last byte of the response body." +type: gauge +source: access_log +unit: integer +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - system.tags + - instance_group diff --git a/site/data/v2metrics/nginx.http.status.1xx.yml b/site/data/v2metrics/nginx.http.status.1xx.yml new file mode 100644 index 000000000..e766c7251 --- /dev/null +++ b/site/data/v2metrics/nginx.http.status.1xx.yml @@ -0,0 +1,37 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.status.1xx +categories: +- nginx +description: Number of requests with HTTP status codes 1xx. +type: counter +counted: true +source: access_combined +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- instance_group +- system.tags +- nginx_id diff --git a/site/data/v2metrics/nginx.http.status.2xx.yml b/site/data/v2metrics/nginx.http.status.2xx.yml new file mode 100644 index 000000000..e7889ee20 --- /dev/null +++ b/site/data/v2metrics/nginx.http.status.2xx.yml @@ -0,0 +1,37 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.status.2xx +categories: +- nginx +description: Number of requests with HTTP status codes 2xx. +type: counter +counted: true +source: access_combined +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/nginx.http.status.3xx.yml b/site/data/v2metrics/nginx.http.status.3xx.yml new file mode 100644 index 000000000..e5cf8b3a1 --- /dev/null +++ b/site/data/v2metrics/nginx.http.status.3xx.yml @@ -0,0 +1,37 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.status.3xx +categories: +- nginx +description: Number of requests with HTTP status codes 3xx. +type: counter +counted: true +source: access_combined +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/nginx.http.status.403.yml b/site/data/v2metrics/nginx.http.status.403.yml new file mode 100644 index 000000000..9f4522bfe --- /dev/null +++ b/site/data/v2metrics/nginx.http.status.403.yml @@ -0,0 +1,35 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.status.403 +categories: + - nginx +description: "The total number of HTTP requests with a status code 403." +type: counter +source: access_log +unit: integer +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - system.tags + - instance_group diff --git a/site/data/v2metrics/nginx.http.status.404.yml b/site/data/v2metrics/nginx.http.status.404.yml new file mode 100644 index 000000000..a6a88d508 --- /dev/null +++ b/site/data/v2metrics/nginx.http.status.404.yml @@ -0,0 +1,35 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.status.404 +categories: + - nginx +description: "The total number of HTTP requests with a status code 404." +type: counter +source: access_log +unit: integer +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - system.tags + - instance_group diff --git a/site/data/v2metrics/nginx.http.status.4xx.yml b/site/data/v2metrics/nginx.http.status.4xx.yml new file mode 100644 index 000000000..e2284c4d8 --- /dev/null +++ b/site/data/v2metrics/nginx.http.status.4xx.yml @@ -0,0 +1,37 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.status.4xx +categories: +- nginx +description: Number of requests with HTTP status codes 4xx. +type: counter +counted: true +source: access_combined +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- instance_group +- system.tags +- nginx_id diff --git a/site/data/v2metrics/nginx.http.status.500.yml b/site/data/v2metrics/nginx.http.status.500.yml new file mode 100644 index 000000000..f50de3b8b --- /dev/null +++ b/site/data/v2metrics/nginx.http.status.500.yml @@ -0,0 +1,35 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.status.500 +categories: + - nginx +description: "The total number of HTTP requests with a status code 500." +type: counter +source: access_log +unit: integer +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - system.tags + - instance_group diff --git a/site/data/v2metrics/nginx.http.status.502.yml b/site/data/v2metrics/nginx.http.status.502.yml new file mode 100644 index 000000000..a9dca7361 --- /dev/null +++ b/site/data/v2metrics/nginx.http.status.502.yml @@ -0,0 +1,35 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.status.502 +categories: + - nginx +description: "The total number of HTTP requests with a status code 502." +type: counter +source: access_log +unit: integer +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - system.tags + - instance_group diff --git a/site/data/v2metrics/nginx.http.status.503.yml b/site/data/v2metrics/nginx.http.status.503.yml new file mode 100644 index 000000000..a63856ed3 --- /dev/null +++ b/site/data/v2metrics/nginx.http.status.503.yml @@ -0,0 +1,35 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.status.503 +categories: + - nginx +description: "The total number of HTTP requests with a status code 503." +type: counter +source: access_log +unit: integer +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - system.tags + - instance_group diff --git a/site/data/v2metrics/nginx.http.status.504.yml b/site/data/v2metrics/nginx.http.status.504.yml new file mode 100644 index 000000000..4a4462588 --- /dev/null +++ b/site/data/v2metrics/nginx.http.status.504.yml @@ -0,0 +1,35 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.status.504 +categories: + - nginx +description: "The total number of HTTP requests with a status code 504." +type: counter +source: access_log +unit: integer +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - system.tags + - instance_group diff --git a/site/data/v2metrics/nginx.http.status.5xx.yml b/site/data/v2metrics/nginx.http.status.5xx.yml new file mode 100644 index 000000000..f745c216b --- /dev/null +++ b/site/data/v2metrics/nginx.http.status.5xx.yml @@ -0,0 +1,37 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.status.5xx +categories: +- nginx +description: Number of requests with HTTP status codes 5xx. +type: counter +counted: true +source: access_combined +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/nginx.http.status.discarded.yml b/site/data/v2metrics/nginx.http.status.discarded.yml new file mode 100644 index 000000000..4227a0903 --- /dev/null +++ b/site/data/v2metrics/nginx.http.status.discarded.yml @@ -0,0 +1,35 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.status.discarded +categories: + - nginx +description: "The total number of discarded requests (i.e., HTTP Status 499)." +type: counter +source: access_log +unit: integer +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - system.tags + - instance_group diff --git a/site/data/v2metrics/nginx.http.v0_9.yml b/site/data/v2metrics/nginx.http.v0_9.yml new file mode 100644 index 000000000..ae4c71365 --- /dev/null +++ b/site/data/v2metrics/nginx.http.v0_9.yml @@ -0,0 +1,35 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.v0_9 +categories: + - nginx +description: "The total number of HTTP Requests using HTTP/0.9." +type: counter +source: access_log +unit: integer +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - system.tags + - instance_group diff --git a/site/data/v2metrics/nginx.http.v1_0.yml b/site/data/v2metrics/nginx.http.v1_0.yml new file mode 100644 index 000000000..f8c3310b7 --- /dev/null +++ b/site/data/v2metrics/nginx.http.v1_0.yml @@ -0,0 +1,35 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.v1_0 +categories: + - nginx +description: "The total number of HTTP Requests using HTTP/1.0." +type: counter +source: access_log +unit: integer +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - system.tags + - instance_group diff --git a/site/data/v2metrics/nginx.http.v1_1.yml b/site/data/v2metrics/nginx.http.v1_1.yml new file mode 100644 index 000000000..acd2999b6 --- /dev/null +++ b/site/data/v2metrics/nginx.http.v1_1.yml @@ -0,0 +1,35 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.v1_1 +categories: + - nginx +description: "The total number of HTTP Requests using HTTP/1.1." +type: counter +source: access_log +unit: integer +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - system.tags + - instance_group diff --git a/site/data/v2metrics/nginx.http.v2.yml b/site/data/v2metrics/nginx.http.v2.yml new file mode 100644 index 000000000..49b3a567e --- /dev/null +++ b/site/data/v2metrics/nginx.http.v2.yml @@ -0,0 +1,35 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.http.v2 +categories: + - nginx +description: "The total number of HTTP Requests using HTTP/2." +type: counter +source: access_log +unit: integer +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - system.tags + - instance_group diff --git a/site/data/v2metrics/nginx.status.yml b/site/data/v2metrics/nginx.status.yml new file mode 100644 index 000000000..be0db4c79 --- /dev/null +++ b/site/data/v2metrics/nginx.status.yml @@ -0,0 +1,36 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.status +categories: +- nginx +description: 'Status of nginx: 1 - nginx is up, 0 - nginx is down.' +type: gauge +counted: true +source: self +unit: integer +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/nginx.upstream.request.failed.yml b/site/data/v2metrics/nginx.upstream.request.failed.yml new file mode 100644 index 000000000..7ea71b3ae --- /dev/null +++ b/site/data/v2metrics/nginx.upstream.request.failed.yml @@ -0,0 +1,35 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.upstream.request.failed +categories: + - nginx +description: "The total number of HTTP requests where upstream requests failed." +type: counter +source: error_log +unit: integer +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - system.tags + - instance_group \ No newline at end of file diff --git a/site/data/v2metrics/nginx.upstream.response.buffered.yml b/site/data/v2metrics/nginx.upstream.response.buffered.yml new file mode 100644 index 000000000..f1475d4d9 --- /dev/null +++ b/site/data/v2metrics/nginx.upstream.response.buffered.yml @@ -0,0 +1,35 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.upstream.response.buffered +categories: + - nginx +description: "The total number of HTTP requests with responses buffered." +type: counter +source: error_log +unit: integer +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - system.tags + - instance_group \ No newline at end of file diff --git a/site/data/v2metrics/nginx.upstream.response.failed.yml b/site/data/v2metrics/nginx.upstream.response.failed.yml new file mode 100644 index 000000000..9e9b7a4ee --- /dev/null +++ b/site/data/v2metrics/nginx.upstream.response.failed.yml @@ -0,0 +1,35 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.upstream.response.failed +categories: + - nginx +description: "The total number of HTTP requests where upstream responses failed." +type: counter +source: error_log +unit: integer +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - system.tags + - instance_group \ No newline at end of file diff --git a/site/data/v2metrics/nginx.workers.count.yml b/site/data/v2metrics/nginx.workers.count.yml new file mode 100644 index 000000000..45e6833cc --- /dev/null +++ b/site/data/v2metrics/nginx.workers.count.yml @@ -0,0 +1,37 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.workers.count +categories: +- nginx +description: Number of NGINX worker processes observed. +type: gauge +counted: true +source: psutil +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/nginx.workers.cpu.system.yml b/site/data/v2metrics/nginx.workers.cpu.system.yml new file mode 100644 index 000000000..cda540e07 --- /dev/null +++ b/site/data/v2metrics/nginx.workers.cpu.system.yml @@ -0,0 +1,37 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.workers.cpu.system +categories: +- nginx +description: CPU utilization percentage observed for NGINX worker processes (system). +type: counter +counted: true +source: psutil +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/nginx.workers.cpu.total.yml b/site/data/v2metrics/nginx.workers.cpu.total.yml new file mode 100644 index 000000000..8791515c6 --- /dev/null +++ b/site/data/v2metrics/nginx.workers.cpu.total.yml @@ -0,0 +1,37 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.workers.cpu.total +categories: +- nginx +description: CPU utilization percentage observed for NGINX worker processes (total). +type: counter +counted: true +source: psutil +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/nginx.workers.cpu.user.yml b/site/data/v2metrics/nginx.workers.cpu.user.yml new file mode 100644 index 000000000..56e71593b --- /dev/null +++ b/site/data/v2metrics/nginx.workers.cpu.user.yml @@ -0,0 +1,37 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.workers.cpu.user +categories: +- nginx +description: CPU utilization percentage observed for NGINX worker processes (user). +type: counter +counted: true +source: psutil +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/nginx.workers.fds_count.yml b/site/data/v2metrics/nginx.workers.fds_count.yml new file mode 100644 index 000000000..4fd2e2916 --- /dev/null +++ b/site/data/v2metrics/nginx.workers.fds_count.yml @@ -0,0 +1,37 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.workers.fds_count +categories: +- nginx +description: Number of file descriptors utilized by NGINX worker processes. +type: gauge +counted: true +source: psutil +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/nginx.workers.io.kbs_r.yml b/site/data/v2metrics/nginx.workers.io.kbs_r.yml new file mode 100644 index 000000000..400d4847e --- /dev/null +++ b/site/data/v2metrics/nginx.workers.io.kbs_r.yml @@ -0,0 +1,37 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.workers.io.kbs_r +categories: +- nginx +description: Number of kilobytes read from NGINX worker processes. +type: counter +counted: true +source: psutil +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/nginx.workers.io.kbs_w.yml b/site/data/v2metrics/nginx.workers.io.kbs_w.yml new file mode 100644 index 000000000..52a2d0fa1 --- /dev/null +++ b/site/data/v2metrics/nginx.workers.io.kbs_w.yml @@ -0,0 +1,37 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.workers.io.kbs_w +categories: +- nginx +description: Number of kilobytes written to disk by NGINX worker processes. +type: counter +counted: true +source: psutil +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/nginx.workers.mem.rss.yml b/site/data/v2metrics/nginx.workers.mem.rss.yml new file mode 100644 index 000000000..79cdf3171 --- /dev/null +++ b/site/data/v2metrics/nginx.workers.mem.rss.yml @@ -0,0 +1,37 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.workers.mem.rss +categories: +- nginx +description: Memory utilized by NGINX worker processes (Resident Set Size). +type: counter +counted: true +source: psutil +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/nginx.workers.mem.rss_pct.yml b/site/data/v2metrics/nginx.workers.mem.rss_pct.yml new file mode 100644 index 000000000..464b7e974 --- /dev/null +++ b/site/data/v2metrics/nginx.workers.mem.rss_pct.yml @@ -0,0 +1,38 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.workers.mem.rss_pct +categories: +- nginx +description: Memory utilized by NGINX worker processes in percentage (Resident Set + Size). +type: gauge +counted: true +source: psutil +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/nginx.workers.mem.vms.yml b/site/data/v2metrics/nginx.workers.mem.vms.yml new file mode 100644 index 000000000..15da43854 --- /dev/null +++ b/site/data/v2metrics/nginx.workers.mem.vms.yml @@ -0,0 +1,37 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.workers.mem.vms +categories: +- nginx +description: Memory utilized by NGINX worker processes (Virtual Memory Size). +type: counter +counted: true +source: psutil +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/nginx.workers.rlimit_nofile.yml b/site/data/v2metrics/nginx.workers.rlimit_nofile.yml new file mode 100644 index 000000000..3e2861123 --- /dev/null +++ b/site/data/v2metrics/nginx.workers.rlimit_nofile.yml @@ -0,0 +1,38 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: nginx.workers.rlimit_nofile +categories: +- nginx +description: Hard limit on the number of file descriptors as seen by NGINX worker + processes. +type: gauge +counted: true +source: psutil +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/plus.cache.bypass.bytes.yml b/site/data/v2metrics/plus.cache.bypass.bytes.yml new file mode 100644 index 000000000..d9fa7fcab --- /dev/null +++ b/site/data/v2metrics/plus.cache.bypass.bytes.yml @@ -0,0 +1,45 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.cache.bypass.bytes +categories: +- nginx +description: The total number of bytes read from the proxied server. +type: counter +source: plus_status +unit: bytes +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- cache_zone +- app +- environment +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.cache.bypass.responses.yml b/site/data/v2metrics/plus.cache.bypass.responses.yml new file mode 100644 index 000000000..860c6998c --- /dev/null +++ b/site/data/v2metrics/plus.cache.bypass.responses.yml @@ -0,0 +1,47 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.cache.bypass.responses +categories: +- nginx +description: The total number of responses not looked up in the cache due to the proxy_cache_bypass + and other β€œ*_cache_bypass” directives. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- cache_zone +- app +- environment +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.cache.expired.bytes.yml b/site/data/v2metrics/plus.cache.expired.bytes.yml new file mode 100644 index 000000000..7c67836a4 --- /dev/null +++ b/site/data/v2metrics/plus.cache.expired.bytes.yml @@ -0,0 +1,45 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.cache.expired.bytes +categories: +- nginx +description: The total number of bytes read from the proxied server. +type: counter +source: plus_status +unit: bytes +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- cache_zone +- app +- environment +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.cache.expired.responses.yml b/site/data/v2metrics/plus.cache.expired.responses.yml new file mode 100644 index 000000000..ba65c2042 --- /dev/null +++ b/site/data/v2metrics/plus.cache.expired.responses.yml @@ -0,0 +1,46 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.cache.expired.responses +categories: +- nginx +description: The total number of expired responses not taken from the cache. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- cache_zone +- app +- environment +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.cache.hit.bytes.yml b/site/data/v2metrics/plus.cache.hit.bytes.yml new file mode 100644 index 000000000..f298136ae --- /dev/null +++ b/site/data/v2metrics/plus.cache.hit.bytes.yml @@ -0,0 +1,45 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.cache.hit.bytes +categories: +- nginx +description: The total number of bytes read from the cache. +type: counter +source: plus_status +unit: bytes +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- cache_zone +- app +- environment +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.cache.hit.responses.yml b/site/data/v2metrics/plus.cache.hit.responses.yml new file mode 100644 index 000000000..6d3a337ba --- /dev/null +++ b/site/data/v2metrics/plus.cache.hit.responses.yml @@ -0,0 +1,46 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.cache.hit.responses +categories: +- nginx +description: The total number of valid responses read from the cache. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- cache_zone +- app +- environment +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.cache.max_size.yml b/site/data/v2metrics/plus.cache.max_size.yml new file mode 100644 index 000000000..7c5e57f4b --- /dev/null +++ b/site/data/v2metrics/plus.cache.max_size.yml @@ -0,0 +1,45 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.cache.max_size +categories: +- nginx +description: The limit on the maximum size of the cache specified in the configuration. +type: gauge +source: plus_status +unit: bytes +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- cache_zone +- app +- environment +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.cache.miss.bytes.yml b/site/data/v2metrics/plus.cache.miss.bytes.yml new file mode 100644 index 000000000..12fc487d6 --- /dev/null +++ b/site/data/v2metrics/plus.cache.miss.bytes.yml @@ -0,0 +1,45 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.cache.miss.bytes +categories: +- nginx +description: The total number of bytes read from the proxied server. +type: counter +source: plus_status +unit: bytes +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- cache_zone +- app +- environment +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.cache.miss.responses.yml b/site/data/v2metrics/plus.cache.miss.responses.yml new file mode 100644 index 000000000..5bd128b37 --- /dev/null +++ b/site/data/v2metrics/plus.cache.miss.responses.yml @@ -0,0 +1,46 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.cache.miss.responses +categories: +- nginx +description: The total number of responses not found in the cache. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- cache_zone +- app +- environment +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.cache.revalidated.bytes.yml b/site/data/v2metrics/plus.cache.revalidated.bytes.yml new file mode 100644 index 000000000..bd50b4430 --- /dev/null +++ b/site/data/v2metrics/plus.cache.revalidated.bytes.yml @@ -0,0 +1,45 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.cache.revalidated.bytes +categories: +- nginx +description: The total number of bytes read from the cache. +type: counter +source: plus_status +unit: bytes +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- cache_zone +- app +- environment +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.cache.revalidated.responses.yml b/site/data/v2metrics/plus.cache.revalidated.responses.yml new file mode 100644 index 000000000..30d7fa872 --- /dev/null +++ b/site/data/v2metrics/plus.cache.revalidated.responses.yml @@ -0,0 +1,47 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.cache.revalidated.responses +categories: +- nginx +description: The total number of expired and revalidated responses read from the cache + (see proxy_cache_revalidate and other β€œ*_cache_revalidate” directives. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- cache_zone +- app +- environment +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.cache.size.yml b/site/data/v2metrics/plus.cache.size.yml new file mode 100644 index 000000000..0baace24d --- /dev/null +++ b/site/data/v2metrics/plus.cache.size.yml @@ -0,0 +1,45 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.cache.size +categories: +- nginx +description: The current size of the cache. +type: gauge +source: plus_status +unit: bytes +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- cache_zone +- app +- environment +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.cache.stale.bytes.yml b/site/data/v2metrics/plus.cache.stale.bytes.yml new file mode 100644 index 000000000..65ad39404 --- /dev/null +++ b/site/data/v2metrics/plus.cache.stale.bytes.yml @@ -0,0 +1,45 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.cache.stale.bytes +categories: +- nginx +description: The total number of bytes read from the cache. +type: counter +source: plus_status +unit: bytes +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- cache_zone +- app +- environment +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.cache.stale.responses.yml b/site/data/v2metrics/plus.cache.stale.responses.yml new file mode 100644 index 000000000..ec02fa896 --- /dev/null +++ b/site/data/v2metrics/plus.cache.stale.responses.yml @@ -0,0 +1,47 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.cache.stale.responses +categories: +- nginx +description: The total number of expired responses read from the cache (see proxy_cache_use_stale + and other β€œ*_cache_use_stale” directives). +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- cache_zone +- app +- environment +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.cache.updating.bytes.yml b/site/data/v2metrics/plus.cache.updating.bytes.yml new file mode 100644 index 000000000..46e9c8acb --- /dev/null +++ b/site/data/v2metrics/plus.cache.updating.bytes.yml @@ -0,0 +1,45 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.cache.updating.bytes +categories: +- nginx +description: The total number of bytes read from the cache. +type: counter +source: plus_status +unit: bytes +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- cache_zone +- app +- environment +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.cache.updating.responses.yml b/site/data/v2metrics/plus.cache.updating.responses.yml new file mode 100644 index 000000000..ff45b5a34 --- /dev/null +++ b/site/data/v2metrics/plus.cache.updating.responses.yml @@ -0,0 +1,47 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.cache.updating.responses +categories: +- nginx +description: The total number of expired responses read from the cache while responses + were being updated (see proxy_cache_use_stale and other β€œ*_cache_use_stale” directives). +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- cache_zone +- app +- environment +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.http.limit_conns.passed.yml b/site/data/v2metrics/plus.http.limit_conns.passed.yml new file mode 100644 index 000000000..d8eb6be88 --- /dev/null +++ b/site/data/v2metrics/plus.http.limit_conns.passed.yml @@ -0,0 +1,36 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.limit_conns.passed +categories: + - nginx +description: "The total number of connections that were neither limited nor accounted as limited." +type: counter +source: plus_status +unit: integer +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - system.tags + - instance_group + - limit_conn_zone diff --git a/site/data/v2metrics/plus.http.limit_conns.rejected.yml b/site/data/v2metrics/plus.http.limit_conns.rejected.yml new file mode 100644 index 000000000..fb7ce4d54 --- /dev/null +++ b/site/data/v2metrics/plus.http.limit_conns.rejected.yml @@ -0,0 +1,36 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.limit_conns.rejected +categories: + - nginx +description: "The total number of connections that were rejected." +type: counter +source: plus_status +unit: integer +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - system.tags + - instance_group + - limit_conn_zone \ No newline at end of file diff --git a/site/data/v2metrics/plus.http.limit_conns.rejected_dry_run.yml b/site/data/v2metrics/plus.http.limit_conns.rejected_dry_run.yml new file mode 100644 index 000000000..d952945b5 --- /dev/null +++ b/site/data/v2metrics/plus.http.limit_conns.rejected_dry_run.yml @@ -0,0 +1,36 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.limit_conns.rejected_dry_run +categories: + - nginx +description: "The total number of connections accounted as rejected in the dry run mode." +type: counter +source: plus_status +unit: integer +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - system.tags + - instance_group + - limit_conn_zone \ No newline at end of file diff --git a/site/data/v2metrics/plus.http.limit_reqs.delayed.yml b/site/data/v2metrics/plus.http.limit_reqs.delayed.yml new file mode 100644 index 000000000..6f33f7bcd --- /dev/null +++ b/site/data/v2metrics/plus.http.limit_reqs.delayed.yml @@ -0,0 +1,36 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.limit_reqs.delayed +categories: + - nginx +description: "The total number of requests that were delayed." +type: counter +source: plus_status +unit: integer +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - system.tags + - instance_group + - limit_req_zone \ No newline at end of file diff --git a/site/data/v2metrics/plus.http.limit_reqs.delayed_dry_run.yml b/site/data/v2metrics/plus.http.limit_reqs.delayed_dry_run.yml new file mode 100644 index 000000000..4b08a670c --- /dev/null +++ b/site/data/v2metrics/plus.http.limit_reqs.delayed_dry_run.yml @@ -0,0 +1,36 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.limit_reqs.delayed_dry_run +categories: + - nginx +description: "The total number of requests accounted as delayed in the dry run mode." +type: counter +source: plus_status +unit: integer +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - system.tags + - instance_group + - limit_req_zone \ No newline at end of file diff --git a/site/data/v2metrics/plus.http.limit_reqs.passed.yml b/site/data/v2metrics/plus.http.limit_reqs.passed.yml new file mode 100644 index 000000000..64b277bbb --- /dev/null +++ b/site/data/v2metrics/plus.http.limit_reqs.passed.yml @@ -0,0 +1,36 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.limit_reqs.passed +categories: + - nginx +description: "The total number of requests that were neither limited nor accounted as limited." +type: counter +source: plus_status +unit: integer +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - system.tags + - instance_group + - limit_req_zone \ No newline at end of file diff --git a/site/data/v2metrics/plus.http.limit_reqs.rejected.yml b/site/data/v2metrics/plus.http.limit_reqs.rejected.yml new file mode 100644 index 000000000..44adb29b8 --- /dev/null +++ b/site/data/v2metrics/plus.http.limit_reqs.rejected.yml @@ -0,0 +1,36 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.limit_reqs.rejected +categories: + - nginx +description: "The total number of requests that were rejected." +type: counter +source: plus_status +unit: integer +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - system.tags + - instance_group + - limit_req_zone \ No newline at end of file diff --git a/site/data/v2metrics/plus.http.limit_reqs.rejected_dry_run.yml b/site/data/v2metrics/plus.http.limit_reqs.rejected_dry_run.yml new file mode 100644 index 000000000..ddc92f861 --- /dev/null +++ b/site/data/v2metrics/plus.http.limit_reqs.rejected_dry_run.yml @@ -0,0 +1,36 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.limit_reqs.rejected_dry_run +categories: + - nginx +description: "The total number of requests accounted as rejected in the dry run mode." +type: counter +source: plus_status +unit: integer +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - system.tags + - instance_group + - limit_req_zone \ No newline at end of file diff --git a/site/data/v2metrics/plus.http.request.bytes_rcvd.yml b/site/data/v2metrics/plus.http.request.bytes_rcvd.yml new file mode 100644 index 000000000..cb0571df8 --- /dev/null +++ b/site/data/v2metrics/plus.http.request.bytes_rcvd.yml @@ -0,0 +1,38 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.request.bytes_rcvd +categories: +- nginx +description: The total number of bytes received from clients. +type: counter +source: plus_status +unit: bytes +rate: net_io_rate +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- server_zone +- location_zone diff --git a/site/data/v2metrics/plus.http.request.bytes_sent.yml b/site/data/v2metrics/plus.http.request.bytes_sent.yml new file mode 100644 index 000000000..fcaa5c6d9 --- /dev/null +++ b/site/data/v2metrics/plus.http.request.bytes_sent.yml @@ -0,0 +1,38 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.request.bytes_sent +categories: +- nginx +description: The total number of bytes sent to clients. +type: counter +source: plus_status +unit: bytes +rate: net_io_rate +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- server_zone +- location_zone diff --git a/site/data/v2metrics/plus.http.request.count.yml b/site/data/v2metrics/plus.http.request.count.yml new file mode 100644 index 000000000..d30b1da23 --- /dev/null +++ b/site/data/v2metrics/plus.http.request.count.yml @@ -0,0 +1,38 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.request.count +categories: +- nginx +description: The total number of client requests received from clients. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- server_zone +- location_zone diff --git a/site/data/v2metrics/plus.http.response.count.yml b/site/data/v2metrics/plus.http.response.count.yml new file mode 100644 index 000000000..71df6e7d8 --- /dev/null +++ b/site/data/v2metrics/plus.http.response.count.yml @@ -0,0 +1,38 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.response.count +categories: +- nginx +description: The total number of responses sent to clients. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- server_zone +- location_zone diff --git a/site/data/v2metrics/plus.http.status.1xx.yml b/site/data/v2metrics/plus.http.status.1xx.yml new file mode 100644 index 000000000..bd8dd88c5 --- /dev/null +++ b/site/data/v2metrics/plus.http.status.1xx.yml @@ -0,0 +1,38 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.status.1xx +categories: +- nginx +description: The number of responses with β€œ1xx” status codes. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- server_zone +- location_zone diff --git a/site/data/v2metrics/plus.http.status.2xx.yml b/site/data/v2metrics/plus.http.status.2xx.yml new file mode 100644 index 000000000..05269a472 --- /dev/null +++ b/site/data/v2metrics/plus.http.status.2xx.yml @@ -0,0 +1,38 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.status.2xx +categories: +- nginx +description: The number of responses with β€œ2xx” status codes. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- server_zone +- location_zone diff --git a/site/data/v2metrics/plus.http.status.3xx.yml b/site/data/v2metrics/plus.http.status.3xx.yml new file mode 100644 index 000000000..5634f3585 --- /dev/null +++ b/site/data/v2metrics/plus.http.status.3xx.yml @@ -0,0 +1,38 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.status.3xx +categories: +- nginx +description: The number of responses with β€œ3xx” status codes. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- server_zone +- location_zone diff --git a/site/data/v2metrics/plus.http.status.4xx.yml b/site/data/v2metrics/plus.http.status.4xx.yml new file mode 100644 index 000000000..d7c24b73c --- /dev/null +++ b/site/data/v2metrics/plus.http.status.4xx.yml @@ -0,0 +1,38 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.status.4xx +categories: +- nginx +description: The number of responses with β€œ4xx” status codes. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- server_zone +- location_zone diff --git a/site/data/v2metrics/plus.http.status.5xx.yml b/site/data/v2metrics/plus.http.status.5xx.yml new file mode 100644 index 000000000..3e55c6f03 --- /dev/null +++ b/site/data/v2metrics/plus.http.status.5xx.yml @@ -0,0 +1,38 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.status.5xx +categories: +- nginx +description: The number of responses with β€œ5xx” status codes. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- server_zone +- location_zone diff --git a/site/data/v2metrics/plus.http.status.discarded.yml b/site/data/v2metrics/plus.http.status.discarded.yml new file mode 100644 index 000000000..ba02662e8 --- /dev/null +++ b/site/data/v2metrics/plus.http.status.discarded.yml @@ -0,0 +1,38 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.status.discarded +categories: +- nginx +description: The total number of requests completed without sending a response. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- server_zone +- location_zone diff --git a/site/data/v2metrics/plus.http.status.processing.yml b/site/data/v2metrics/plus.http.status.processing.yml new file mode 100644 index 000000000..fd0d56919 --- /dev/null +++ b/site/data/v2metrics/plus.http.status.processing.yml @@ -0,0 +1,37 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.status.processing +categories: +- nginx +description: The number of client requests that are currently being processed. +type: gauge +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- server_zone diff --git a/site/data/v2metrics/plus.http.upstream.keepalives.yml b/site/data/v2metrics/plus.http.upstream.keepalives.yml new file mode 100644 index 000000000..aac0fab87 --- /dev/null +++ b/site/data/v2metrics/plus.http.upstream.keepalives.yml @@ -0,0 +1,47 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.upstream.keepalives +categories: +- nginx +description: The current number of idle keepalive connections. +type: gauge +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- site +- environment +- app +- component +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.http.upstream.peers.bytes_rcvd.yml b/site/data/v2metrics/plus.http.upstream.peers.bytes_rcvd.yml new file mode 100644 index 000000000..31e94c977 --- /dev/null +++ b/site/data/v2metrics/plus.http.upstream.peers.bytes_rcvd.yml @@ -0,0 +1,49 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.upstream.peers.bytes_rcvd +categories: +- nginx +description: The total number of bytes recieved from clients. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- site +- environment +- app +- component +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.http.upstream.peers.bytes_sent.yml b/site/data/v2metrics/plus.http.upstream.peers.bytes_sent.yml new file mode 100644 index 000000000..48fb3d910 --- /dev/null +++ b/site/data/v2metrics/plus.http.upstream.peers.bytes_sent.yml @@ -0,0 +1,49 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.upstream.peers.bytes_sent +categories: +- nginx +description: The total number of bytes sent to clients. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- site +- environment +- app +- component +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.http.upstream.peers.conn.active.yml b/site/data/v2metrics/plus.http.upstream.peers.conn.active.yml new file mode 100644 index 000000000..9a8ba6b4c --- /dev/null +++ b/site/data/v2metrics/plus.http.upstream.peers.conn.active.yml @@ -0,0 +1,49 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.upstream.peers.conn.active +categories: +- nginx +description: The average number of active connections. +type: gauge +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- site +- environment +- app +- component +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.http.upstream.peers.fails.yml b/site/data/v2metrics/plus.http.upstream.peers.fails.yml new file mode 100644 index 000000000..7199b27a6 --- /dev/null +++ b/site/data/v2metrics/plus.http.upstream.peers.fails.yml @@ -0,0 +1,49 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.upstream.peers.fails +categories: +- nginx +description: The total number of unsuccessful attempts to communicate with the server. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- site +- environment +- app +- component +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.http.upstream.peers.header_time.yml b/site/data/v2metrics/plus.http.upstream.peers.header_time.yml new file mode 100644 index 000000000..aa719784c --- /dev/null +++ b/site/data/v2metrics/plus.http.upstream.peers.header_time.yml @@ -0,0 +1,49 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.upstream.peers.header_time +categories: +- nginx +description: The average time to get the response header from the server. +type: gauge +source: plus_status +unit: milliseconds +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- site +- environment +- app +- component +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.http.upstream.peers.health_checks.checks.yml b/site/data/v2metrics/plus.http.upstream.peers.health_checks.checks.yml new file mode 100644 index 000000000..531a95d92 --- /dev/null +++ b/site/data/v2metrics/plus.http.upstream.peers.health_checks.checks.yml @@ -0,0 +1,49 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.upstream.peers.health_checks.checks +categories: +- nginx +description: The total number of health check requests made. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- site +- environment +- app +- component +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.http.upstream.peers.health_checks.fails.yml b/site/data/v2metrics/plus.http.upstream.peers.health_checks.fails.yml new file mode 100644 index 000000000..3c9950d15 --- /dev/null +++ b/site/data/v2metrics/plus.http.upstream.peers.health_checks.fails.yml @@ -0,0 +1,49 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.upstream.peers.health_checks.fails +categories: +- nginx +description: The number of failed health checks. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- site +- environment +- app +- component +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.http.upstream.peers.health_checks.unhealthy.yml b/site/data/v2metrics/plus.http.upstream.peers.health_checks.unhealthy.yml new file mode 100644 index 000000000..f18cb9903 --- /dev/null +++ b/site/data/v2metrics/plus.http.upstream.peers.health_checks.unhealthy.yml @@ -0,0 +1,49 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.upstream.peers.health_checks.unhealthy +categories: +- nginx +description: How many times the server became unhealthy (state β€œunhealthy”). +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- site +- environment +- app +- component +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.http.upstream.peers.request.count.yml b/site/data/v2metrics/plus.http.upstream.peers.request.count.yml new file mode 100644 index 000000000..02b98b948 --- /dev/null +++ b/site/data/v2metrics/plus.http.upstream.peers.request.count.yml @@ -0,0 +1,49 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.upstream.peers.request.count +categories: +- nginx +description: The total number of client requests forwarded to this server. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- site +- environment +- app +- component +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.http.upstream.peers.response.count.yml b/site/data/v2metrics/plus.http.upstream.peers.response.count.yml new file mode 100644 index 000000000..5b3c63b13 --- /dev/null +++ b/site/data/v2metrics/plus.http.upstream.peers.response.count.yml @@ -0,0 +1,49 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.upstream.peers.response.count +categories: +- nginx +description: The total number of responses obtained from this server. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- site +- environment +- app +- component +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.http.upstream.peers.response.time.yml b/site/data/v2metrics/plus.http.upstream.peers.response.time.yml new file mode 100644 index 000000000..7b224f0ec --- /dev/null +++ b/site/data/v2metrics/plus.http.upstream.peers.response.time.yml @@ -0,0 +1,49 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.upstream.peers.response.time +categories: +- nginx +description: The average time to get the full response from the server. +type: gauge +source: plus_status +unit: milliseconds +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- site +- environment +- app +- component +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.http.upstream.peers.state.checking.yml b/site/data/v2metrics/plus.http.upstream.peers.state.checking.yml new file mode 100644 index 000000000..5fd413552 --- /dev/null +++ b/site/data/v2metrics/plus.http.upstream.peers.state.checking.yml @@ -0,0 +1,51 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.upstream.peers.state.checking +categories: +- nginx +description: Current state of upstream servers in deployment. If any of the upstream + servers in the deployment are checking then the value will be 1. If no upstream + server is checking then the value will be 0. +type: gauge +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- site +- environment +- app +- component +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.http.upstream.peers.state.down.yml b/site/data/v2metrics/plus.http.upstream.peers.state.down.yml new file mode 100644 index 000000000..ca7225619 --- /dev/null +++ b/site/data/v2metrics/plus.http.upstream.peers.state.down.yml @@ -0,0 +1,51 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.upstream.peers.state.down +categories: +- nginx +description: Current state of upstream servers in deployment. If any of the upstream + servers in the deployment are down then the value will be 1. If no upstream server + is down then the value will be 0. +type: gauge +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- site +- environment +- app +- component +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.http.upstream.peers.state.draining.yml b/site/data/v2metrics/plus.http.upstream.peers.state.draining.yml new file mode 100644 index 000000000..b82c55103 --- /dev/null +++ b/site/data/v2metrics/plus.http.upstream.peers.state.draining.yml @@ -0,0 +1,51 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.upstream.peers.state.draining +categories: +- nginx +description: Current state of upstream servers in deployment. If any of the upstream + servers in the deployment are draining then the value will be 1. If no upstream + server is draining then the value will be 0. +type: gauge +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- site +- environment +- app +- component +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.http.upstream.peers.state.unavail.yml b/site/data/v2metrics/plus.http.upstream.peers.state.unavail.yml new file mode 100644 index 000000000..6498d08cd --- /dev/null +++ b/site/data/v2metrics/plus.http.upstream.peers.state.unavail.yml @@ -0,0 +1,51 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.upstream.peers.state.unavail +categories: +- nginx +description: Current state of upstream servers in deployment. If any of the upstream + servers in the deployment are unavail then the value will be 1. If no upstream server + is unavail then the value will be 0. +type: gauge +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- site +- environment +- app +- component +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.http.upstream.peers.state.unhealthy.yml b/site/data/v2metrics/plus.http.upstream.peers.state.unhealthy.yml new file mode 100644 index 000000000..4adba3d51 --- /dev/null +++ b/site/data/v2metrics/plus.http.upstream.peers.state.unhealthy.yml @@ -0,0 +1,51 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.upstream.peers.state.unhealthy +categories: +- nginx +description: Current state of upstream servers in deployment. If any of the upstream + servers in the deployment are unhealthy then the value will be 1. If no upstream + server is unhealthy then the value will be 0. +type: gauge +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- site +- environment +- app +- component +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.http.upstream.peers.state.up.yml b/site/data/v2metrics/plus.http.upstream.peers.state.up.yml new file mode 100644 index 000000000..e71a63e84 --- /dev/null +++ b/site/data/v2metrics/plus.http.upstream.peers.state.up.yml @@ -0,0 +1,51 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.upstream.peers.state.up +categories: +- nginx +description: Current state of upstream servers in deployment. If any of the upstream + servers in the deployment are up then the value will be 1. If no upstream server + is up then the value will be 0. +type: gauge +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- site +- environment +- app +- component +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.http.upstream.peers.status.1xx.yml b/site/data/v2metrics/plus.http.upstream.peers.status.1xx.yml new file mode 100644 index 000000000..263b55e18 --- /dev/null +++ b/site/data/v2metrics/plus.http.upstream.peers.status.1xx.yml @@ -0,0 +1,49 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.upstream.peers.status.1xx +categories: +- nginx +description: The number of responses with β€œ1xx” status codes. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- site +- environment +- app +- component +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.http.upstream.peers.status.2xx.yml b/site/data/v2metrics/plus.http.upstream.peers.status.2xx.yml new file mode 100644 index 000000000..536997311 --- /dev/null +++ b/site/data/v2metrics/plus.http.upstream.peers.status.2xx.yml @@ -0,0 +1,49 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.upstream.peers.status.2xx +categories: +- nginx +description: The number of responses with β€œ2xx” status codes. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- site +- environment +- app +- component +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.http.upstream.peers.status.3xx.yml b/site/data/v2metrics/plus.http.upstream.peers.status.3xx.yml new file mode 100644 index 000000000..233806b1f --- /dev/null +++ b/site/data/v2metrics/plus.http.upstream.peers.status.3xx.yml @@ -0,0 +1,50 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.upstream.peers.status.3xx +categories: +- nginx +description: The number of responses with β€œ3xx” status codes. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- site +- environment +- app +- component +- environment_name +- component_name +- app_name +- site_name + diff --git a/site/data/v2metrics/plus.http.upstream.peers.status.4xx.yml b/site/data/v2metrics/plus.http.upstream.peers.status.4xx.yml new file mode 100644 index 000000000..7a676eeaa --- /dev/null +++ b/site/data/v2metrics/plus.http.upstream.peers.status.4xx.yml @@ -0,0 +1,49 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.upstream.peers.status.4xx +categories: +- nginx +description: The number of responses with β€œ4xx” status codes. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- site +- environment +- app +- component +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.http.upstream.peers.status.5xx.yml b/site/data/v2metrics/plus.http.upstream.peers.status.5xx.yml new file mode 100644 index 000000000..0c5adec79 --- /dev/null +++ b/site/data/v2metrics/plus.http.upstream.peers.status.5xx.yml @@ -0,0 +1,49 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.upstream.peers.status.5xx +categories: +- nginx +description: The number of responses with β€œ5xx” status codes. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- site +- environment +- app +- component +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.http.upstream.peers.total.checking.yml b/site/data/v2metrics/plus.http.upstream.peers.total.checking.yml new file mode 100644 index 000000000..07db8ad39 --- /dev/null +++ b/site/data/v2metrics/plus.http.upstream.peers.total.checking.yml @@ -0,0 +1,47 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.upstream.peers.total.checking +categories: +- nginx +description: The total number of peers with a state of "checking". +type: gauge +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- site +- environment +- app +- component +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.http.upstream.peers.total.down.yml b/site/data/v2metrics/plus.http.upstream.peers.total.down.yml new file mode 100644 index 000000000..865f5c784 --- /dev/null +++ b/site/data/v2metrics/plus.http.upstream.peers.total.down.yml @@ -0,0 +1,47 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.upstream.peers.total.down +categories: +- nginx +description: The total number of peers with a state of "down". +type: gauge +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- site +- environment +- app +- component +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.http.upstream.peers.total.draining.yml b/site/data/v2metrics/plus.http.upstream.peers.total.draining.yml new file mode 100644 index 000000000..e7817345f --- /dev/null +++ b/site/data/v2metrics/plus.http.upstream.peers.total.draining.yml @@ -0,0 +1,47 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.upstream.peers.total.draining +categories: +- nginx +description: The total number of peers with a state of "draining". +type: gauge +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- site +- environment +- app +- component +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.http.upstream.peers.total.unavail.yml b/site/data/v2metrics/plus.http.upstream.peers.total.unavail.yml new file mode 100644 index 000000000..318c19527 --- /dev/null +++ b/site/data/v2metrics/plus.http.upstream.peers.total.unavail.yml @@ -0,0 +1,47 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.upstream.peers.total.unavail +categories: +- nginx +description: The total number of peers with a state of "unavail". +type: gauge +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- site +- environment +- app +- component +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.http.upstream.peers.total.unhealthy.yml b/site/data/v2metrics/plus.http.upstream.peers.total.unhealthy.yml new file mode 100644 index 000000000..7fc3c516f --- /dev/null +++ b/site/data/v2metrics/plus.http.upstream.peers.total.unhealthy.yml @@ -0,0 +1,47 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.upstream.peers.total.unhealthy +categories: +- nginx +description: The total number of peers with a state of "unhealthy". +type: gauge +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- site +- environment +- app +- component +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.http.upstream.peers.total.up.yml b/site/data/v2metrics/plus.http.upstream.peers.total.up.yml new file mode 100644 index 000000000..a6d5daa45 --- /dev/null +++ b/site/data/v2metrics/plus.http.upstream.peers.total.up.yml @@ -0,0 +1,47 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.upstream.peers.total.up +categories: +- nginx +description: The total number of peers with a state of "up". +type: gauge +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- site +- environment +- app +- component +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.http.upstream.peers.unavail.yml b/site/data/v2metrics/plus.http.upstream.peers.unavail.yml new file mode 100644 index 000000000..db12ac002 --- /dev/null +++ b/site/data/v2metrics/plus.http.upstream.peers.unavail.yml @@ -0,0 +1,50 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.upstream.peers.unavail +categories: +- nginx +description: How many times the server became unavailable for client requests (state + β€œunavail”) due to the number of unsuccessful attempts reaching the max_fails threshold. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- site +- environment +- app +- component +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.http.upstream.queue.maxsize.yml b/site/data/v2metrics/plus.http.upstream.queue.maxsize.yml new file mode 100644 index 000000000..c67dd5219 --- /dev/null +++ b/site/data/v2metrics/plus.http.upstream.queue.maxsize.yml @@ -0,0 +1,46 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.upstream.queue.maxsize +categories: +- nginx +description: The maximum number of requests that can be in the queue at the same time. +type: gauge +source: plus_status +unit: integer +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- site +- environment +- app +- component +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.http.upstream.queue.overflows.yml b/site/data/v2metrics/plus.http.upstream.queue.overflows.yml new file mode 100644 index 000000000..dabb43824 --- /dev/null +++ b/site/data/v2metrics/plus.http.upstream.queue.overflows.yml @@ -0,0 +1,47 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.upstream.queue.overflows +categories: +- nginx +description: The total number of requests rejected due to the queue overflow. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- site +- environment +- app +- component +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.http.upstream.queue.size.yml b/site/data/v2metrics/plus.http.upstream.queue.size.yml new file mode 100644 index 000000000..d984cc411 --- /dev/null +++ b/site/data/v2metrics/plus.http.upstream.queue.size.yml @@ -0,0 +1,46 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.upstream.queue.size +categories: +- nginx +description: The current number of requests in the queue. +type: gauge +source: plus_status +unit: integer +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- site +- environment +- app +- component +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.http.upstream.zombies.yml b/site/data/v2metrics/plus.http.upstream.zombies.yml new file mode 100644 index 000000000..f347de438 --- /dev/null +++ b/site/data/v2metrics/plus.http.upstream.zombies.yml @@ -0,0 +1,48 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.http.upstream.zombies +categories: +- nginx +description: The current number of servers removed from the group but still processing + active client requests. +type: gauge +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- site +- environment +- app +- component +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.instance.count.yml b/site/data/v2metrics/plus.instance.count.yml new file mode 100644 index 000000000..1c778d692 --- /dev/null +++ b/site/data/v2metrics/plus.instance.count.yml @@ -0,0 +1,34 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.instance.count +categories: + - nginx +description: "Total number of NGINX PLUS." +type: gauge +source: psutil +unit: integer +visible: true +counted: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id diff --git a/site/data/v2metrics/plus.slab.pages.free.yml b/site/data/v2metrics/plus.slab.pages.free.yml new file mode 100644 index 000000000..387adccb6 --- /dev/null +++ b/site/data/v2metrics/plus.slab.pages.free.yml @@ -0,0 +1,40 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.slab.pages.free +categories: +- nginx +description: The current number of free memory pages. +type: gauge +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address diff --git a/site/data/v2metrics/plus.slab.pages.pct_used.yml b/site/data/v2metrics/plus.slab.pages.pct_used.yml new file mode 100644 index 000000000..860f03946 --- /dev/null +++ b/site/data/v2metrics/plus.slab.pages.pct_used.yml @@ -0,0 +1,40 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.slab.pages.pct_used +categories: +- nginx +description: The current percentage of used memory pages. +type: gauge +source: plus_status +unit: percent +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address diff --git a/site/data/v2metrics/plus.slab.pages.total.yml b/site/data/v2metrics/plus.slab.pages.total.yml new file mode 100644 index 000000000..c88f89229 --- /dev/null +++ b/site/data/v2metrics/plus.slab.pages.total.yml @@ -0,0 +1,40 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.slab.pages.total +categories: +- nginx +description: The total number of memory pages (free and used). +type: gauge +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address diff --git a/site/data/v2metrics/plus.slab.pages.used.yml b/site/data/v2metrics/plus.slab.pages.used.yml new file mode 100644 index 000000000..6e71cd921 --- /dev/null +++ b/site/data/v2metrics/plus.slab.pages.used.yml @@ -0,0 +1,40 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.slab.pages.used +categories: +- nginx +description: The current number of used memory pages. +type: gauge +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address diff --git a/site/data/v2metrics/plus.ssl.failed.yml b/site/data/v2metrics/plus.ssl.failed.yml new file mode 100644 index 000000000..ca97ede9f --- /dev/null +++ b/site/data/v2metrics/plus.ssl.failed.yml @@ -0,0 +1,36 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.ssl.failed +categories: +- nginx +description: The total number of failed SSL handshakes. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/plus.ssl.handshakes.yml b/site/data/v2metrics/plus.ssl.handshakes.yml new file mode 100644 index 000000000..26ce28bc8 --- /dev/null +++ b/site/data/v2metrics/plus.ssl.handshakes.yml @@ -0,0 +1,36 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.ssl.handshakes +categories: +- nginx +description: The total number of successful SSL handshakes. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/plus.ssl.reuses.yml b/site/data/v2metrics/plus.ssl.reuses.yml new file mode 100644 index 000000000..c48e0550f --- /dev/null +++ b/site/data/v2metrics/plus.ssl.reuses.yml @@ -0,0 +1,36 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.ssl.reuses +categories: +- nginx +description: The total number of session reuses during SSL handshake. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/plus.stream.bytes_rcvd.yml b/site/data/v2metrics/plus.stream.bytes_rcvd.yml new file mode 100644 index 000000000..8890c273f --- /dev/null +++ b/site/data/v2metrics/plus.stream.bytes_rcvd.yml @@ -0,0 +1,37 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.stream.bytes_rcvd +categories: +- nginx +description: The total number of bytes received from clients. +type: counter +source: plus_status +unit: bytes +rate: net_io_rate +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- server_zone diff --git a/site/data/v2metrics/plus.stream.bytes_sent.yml b/site/data/v2metrics/plus.stream.bytes_sent.yml new file mode 100644 index 000000000..8e9712d0a --- /dev/null +++ b/site/data/v2metrics/plus.stream.bytes_sent.yml @@ -0,0 +1,37 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.stream.bytes_sent +categories: +- nginx +description: The total number of bytes sent to clients. +type: counter +source: plus_status +unit: bytes +rate: net_io_rate +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- server_zone diff --git a/site/data/v2metrics/plus.stream.connections.yml b/site/data/v2metrics/plus.stream.connections.yml new file mode 100644 index 000000000..b1260b986 --- /dev/null +++ b/site/data/v2metrics/plus.stream.connections.yml @@ -0,0 +1,37 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.stream.connections +categories: +- nginx +description: The total number of connections accepted from clients. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- server_zone diff --git a/site/data/v2metrics/plus.stream.discarded.yml b/site/data/v2metrics/plus.stream.discarded.yml new file mode 100644 index 000000000..f47758e4f --- /dev/null +++ b/site/data/v2metrics/plus.stream.discarded.yml @@ -0,0 +1,38 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.stream.discarded +categories: +- nginx +- stream +description: Total number of connections completed without creating a session. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- server_zone diff --git a/site/data/v2metrics/plus.stream.processing.yml b/site/data/v2metrics/plus.stream.processing.yml new file mode 100644 index 000000000..79006fd92 --- /dev/null +++ b/site/data/v2metrics/plus.stream.processing.yml @@ -0,0 +1,37 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.stream.processing +categories: +- nginx +description: The number of client connections that are currently being processed. +type: gauge +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- server_zone diff --git a/site/data/v2metrics/plus.stream.status.2xx.yml b/site/data/v2metrics/plus.stream.status.2xx.yml new file mode 100644 index 000000000..c24548ee7 --- /dev/null +++ b/site/data/v2metrics/plus.stream.status.2xx.yml @@ -0,0 +1,37 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.stream.status.2xx +categories: +- nginx +description: The total number of sessions completed with status codes β€œ2xx”. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- server_zone diff --git a/site/data/v2metrics/plus.stream.status.4xx.yml b/site/data/v2metrics/plus.stream.status.4xx.yml new file mode 100644 index 000000000..1cb99bc29 --- /dev/null +++ b/site/data/v2metrics/plus.stream.status.4xx.yml @@ -0,0 +1,37 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.stream.status.4xx +categories: +- nginx +description: The total number of sessions completed with status codes β€œ4xx”. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- server_zone diff --git a/site/data/v2metrics/plus.stream.status.5xx.yml b/site/data/v2metrics/plus.stream.status.5xx.yml new file mode 100644 index 000000000..1ed6c1811 --- /dev/null +++ b/site/data/v2metrics/plus.stream.status.5xx.yml @@ -0,0 +1,37 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.stream.status.5xx +categories: +- nginx +description: The total number of sessions completed with status codes β€œ2xx”. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- server_zone diff --git a/site/data/v2metrics/plus.stream.status.total.yml b/site/data/v2metrics/plus.stream.status.total.yml new file mode 100644 index 000000000..f216ab9b4 --- /dev/null +++ b/site/data/v2metrics/plus.stream.status.total.yml @@ -0,0 +1,37 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.stream.status.total +categories: +- nginx +description: The total number of completed client sessions. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- server_zone diff --git a/site/data/v2metrics/plus.stream.upstream.peers.bytes_rcvd.yml b/site/data/v2metrics/plus.stream.upstream.peers.bytes_rcvd.yml new file mode 100644 index 000000000..e9dec85e6 --- /dev/null +++ b/site/data/v2metrics/plus.stream.upstream.peers.bytes_rcvd.yml @@ -0,0 +1,49 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.stream.upstream.peers.bytes_rcvd +categories: +- nginx +description: The total number of bytes received from this server. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- environment +- app +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.stream.upstream.peers.bytes_sent.yml b/site/data/v2metrics/plus.stream.upstream.peers.bytes_sent.yml new file mode 100644 index 000000000..f33eec38b --- /dev/null +++ b/site/data/v2metrics/plus.stream.upstream.peers.bytes_sent.yml @@ -0,0 +1,49 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.stream.upstream.peers.bytes_sent +categories: +- nginx +description: The total number of bytes sent to this server. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- environment +- app +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.stream.upstream.peers.conn.active.yml b/site/data/v2metrics/plus.stream.upstream.peers.conn.active.yml new file mode 100644 index 000000000..3e36f3726 --- /dev/null +++ b/site/data/v2metrics/plus.stream.upstream.peers.conn.active.yml @@ -0,0 +1,49 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.stream.upstream.peers.conn.active +categories: +- nginx +description: The current number of connections. +type: gauge +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- environment +- app +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.stream.upstream.peers.conn.count.yml b/site/data/v2metrics/plus.stream.upstream.peers.conn.count.yml new file mode 100644 index 000000000..9de3b74f5 --- /dev/null +++ b/site/data/v2metrics/plus.stream.upstream.peers.conn.count.yml @@ -0,0 +1,49 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.stream.upstream.peers.conn.count +categories: +- nginx +description: The total number of client connections forwarded to this server. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- environment +- app +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.stream.upstream.peers.connect_time.yml b/site/data/v2metrics/plus.stream.upstream.peers.connect_time.yml new file mode 100644 index 000000000..8dfc72ba8 --- /dev/null +++ b/site/data/v2metrics/plus.stream.upstream.peers.connect_time.yml @@ -0,0 +1,49 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.stream.upstream.peers.connect_time +categories: +- nginx +description: The average time to connect to the upstream server. +type: gauge +source: plus_status +unit: milliseconds +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- environment +- app +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.stream.upstream.peers.fails.yml b/site/data/v2metrics/plus.stream.upstream.peers.fails.yml new file mode 100644 index 000000000..efbffbf6f --- /dev/null +++ b/site/data/v2metrics/plus.stream.upstream.peers.fails.yml @@ -0,0 +1,49 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.stream.upstream.peers.fails +categories: +- nginx +description: The total number of peers with a state of "fails". +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- environment +- app +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.stream.upstream.peers.health_checks.checks.yml b/site/data/v2metrics/plus.stream.upstream.peers.health_checks.checks.yml new file mode 100644 index 000000000..4150d33c8 --- /dev/null +++ b/site/data/v2metrics/plus.stream.upstream.peers.health_checks.checks.yml @@ -0,0 +1,49 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.stream.upstream.peers.health_checks.checks +categories: +- nginx +description: The total number of health check requests made. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- environment +- app +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.stream.upstream.peers.health_checks.fails.yml b/site/data/v2metrics/plus.stream.upstream.peers.health_checks.fails.yml new file mode 100644 index 000000000..2833c5f18 --- /dev/null +++ b/site/data/v2metrics/plus.stream.upstream.peers.health_checks.fails.yml @@ -0,0 +1,49 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.stream.upstream.peers.health_checks.fails +categories: +- nginx +description: The number of failed health checks. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- environment +- app +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.stream.upstream.peers.health_checks.unhealthy.yml b/site/data/v2metrics/plus.stream.upstream.peers.health_checks.unhealthy.yml new file mode 100644 index 000000000..0a8d726b2 --- /dev/null +++ b/site/data/v2metrics/plus.stream.upstream.peers.health_checks.unhealthy.yml @@ -0,0 +1,49 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.stream.upstream.peers.health_checks.unhealthy +categories: +- nginx +description: How many times the server became unhealthy (state β€œunhealthy”). +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- environment +- app +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.stream.upstream.peers.response.time.yml b/site/data/v2metrics/plus.stream.upstream.peers.response.time.yml new file mode 100644 index 000000000..3def60320 --- /dev/null +++ b/site/data/v2metrics/plus.stream.upstream.peers.response.time.yml @@ -0,0 +1,49 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.stream.upstream.peers.response.time +categories: +- nginx +description: The average time to receive the last byte of data. +type: gauge +source: plus_status +unit: milliseconds +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- environment +- app +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.stream.upstream.peers.state.checking.yml b/site/data/v2metrics/plus.stream.upstream.peers.state.checking.yml new file mode 100644 index 000000000..bb43ca137 --- /dev/null +++ b/site/data/v2metrics/plus.stream.upstream.peers.state.checking.yml @@ -0,0 +1,51 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.stream.upstream.peers.state.checking +categories: +- nginx +description: Current state of upstream servers in deployment. If any of the upstream + servers in the deployment are checking then the value will be 1. If no upstream + server is checking then the value will be 0. +type: gauge +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- environment +- app +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.stream.upstream.peers.state.down.yml b/site/data/v2metrics/plus.stream.upstream.peers.state.down.yml new file mode 100644 index 000000000..b215ed5fe --- /dev/null +++ b/site/data/v2metrics/plus.stream.upstream.peers.state.down.yml @@ -0,0 +1,51 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.stream.upstream.peers.state.down +categories: +- nginx +description: Current state of upstream servers in deployment. If any of the upstream + servers in the deployment are down then the value will be 1. If no upstream server + is down then the value will be 0. +type: gauge +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- environment +- app +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.stream.upstream.peers.state.draining.yml b/site/data/v2metrics/plus.stream.upstream.peers.state.draining.yml new file mode 100644 index 000000000..c863a4f78 --- /dev/null +++ b/site/data/v2metrics/plus.stream.upstream.peers.state.draining.yml @@ -0,0 +1,51 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.stream.upstream.peers.state.draining +categories: +- nginx +description: Current state of upstream servers in deployment. If any of the upstream + servers in the deployment are draining then the value will be 1. If no upstream + server is draining then the value will be 0. +type: gauge +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- environment +- app +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.stream.upstream.peers.state.unavail.yml b/site/data/v2metrics/plus.stream.upstream.peers.state.unavail.yml new file mode 100644 index 000000000..0bb68d5cb --- /dev/null +++ b/site/data/v2metrics/plus.stream.upstream.peers.state.unavail.yml @@ -0,0 +1,51 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.stream.upstream.peers.state.unavail +categories: +- nginx +description: Current state of upstream servers in deployment. If any of the upstream + servers in the deployment are unavail then the value will be 1. If no upstream server + is unavail then the value will be 0. +type: gauge +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- environment +- app +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.stream.upstream.peers.state.unhealthy.yml b/site/data/v2metrics/plus.stream.upstream.peers.state.unhealthy.yml new file mode 100644 index 000000000..9488acfd3 --- /dev/null +++ b/site/data/v2metrics/plus.stream.upstream.peers.state.unhealthy.yml @@ -0,0 +1,51 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.stream.upstream.peers.state.unhealthy +categories: +- nginx +description: Current state of upstream servers in deployment. If any of the upstream + servers in the deployment are unhealthy then the value will be 1. If no upstream + server is unhealthy then the value will be 0. +type: gauge +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- environment +- app +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.stream.upstream.peers.state.up.yml b/site/data/v2metrics/plus.stream.upstream.peers.state.up.yml new file mode 100644 index 000000000..2b02f63dd --- /dev/null +++ b/site/data/v2metrics/plus.stream.upstream.peers.state.up.yml @@ -0,0 +1,51 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.stream.upstream.peers.state.up +categories: +- nginx +description: Current state of upstream servers in deployment. If any of the upstream + servers in the deployment are up then the value will be 1. If no upstream server + is up then the value will be 0. +type: gauge +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- environment +- app +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.stream.upstream.peers.total.checking.yml b/site/data/v2metrics/plus.stream.upstream.peers.total.checking.yml new file mode 100644 index 000000000..c3de6bd03 --- /dev/null +++ b/site/data/v2metrics/plus.stream.upstream.peers.total.checking.yml @@ -0,0 +1,47 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.stream.upstream.peers.total.checking +categories: +- nginx +description: The total number of peers with a state of "checking". +type: gauge +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- environment +- app +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.stream.upstream.peers.total.down.yml b/site/data/v2metrics/plus.stream.upstream.peers.total.down.yml new file mode 100644 index 000000000..2ff602ff8 --- /dev/null +++ b/site/data/v2metrics/plus.stream.upstream.peers.total.down.yml @@ -0,0 +1,47 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.stream.upstream.peers.total.down +categories: +- nginx +description: The total number of peers with a state of "down". +type: gauge +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- environment +- app +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.stream.upstream.peers.total.draining.yml b/site/data/v2metrics/plus.stream.upstream.peers.total.draining.yml new file mode 100644 index 000000000..65d415fa2 --- /dev/null +++ b/site/data/v2metrics/plus.stream.upstream.peers.total.draining.yml @@ -0,0 +1,47 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.stream.upstream.peers.total.draining +categories: +- nginx +description: The total number of peers with a state of "draining". +type: gauge +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- environment +- app +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.stream.upstream.peers.total.unavail.yml b/site/data/v2metrics/plus.stream.upstream.peers.total.unavail.yml new file mode 100644 index 000000000..e94621270 --- /dev/null +++ b/site/data/v2metrics/plus.stream.upstream.peers.total.unavail.yml @@ -0,0 +1,48 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.stream.upstream.peers.total.unavail +categories: +- nginx +description: How many times the server became unavailable for client connections (state + β€œunavail”) due to the number of unsuccessful attempts reaching the max_fails threshold. +type: gauge +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- environment +- app +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.stream.upstream.peers.total.unhealthy.yml b/site/data/v2metrics/plus.stream.upstream.peers.total.unhealthy.yml new file mode 100644 index 000000000..1f7bf8c3f --- /dev/null +++ b/site/data/v2metrics/plus.stream.upstream.peers.total.unhealthy.yml @@ -0,0 +1,47 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.stream.upstream.peers.total.unhealthy +categories: +- nginx +description: The total number of peers with a state of "unhealthy". +type: gauge +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- environment +- app +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.stream.upstream.peers.total.up.yml b/site/data/v2metrics/plus.stream.upstream.peers.total.up.yml new file mode 100644 index 000000000..aadce70fc --- /dev/null +++ b/site/data/v2metrics/plus.stream.upstream.peers.total.up.yml @@ -0,0 +1,47 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.stream.upstream.peers.total.up +categories: +- nginx +description: The total number of peers with a state of "up". +type: gauge +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- environment +- app +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.stream.upstream.peers.ttfb.yml b/site/data/v2metrics/plus.stream.upstream.peers.ttfb.yml new file mode 100644 index 000000000..549c56429 --- /dev/null +++ b/site/data/v2metrics/plus.stream.upstream.peers.ttfb.yml @@ -0,0 +1,49 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.stream.upstream.peers.ttfb +categories: +- nginx +description: The average time to receive the first byte of data. +type: gauge +source: plus_status +unit: milliseconds +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- environment +- app +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.stream.upstream.peers.unavail.yml b/site/data/v2metrics/plus.stream.upstream.peers.unavail.yml new file mode 100644 index 000000000..e690f5cef --- /dev/null +++ b/site/data/v2metrics/plus.stream.upstream.peers.unavail.yml @@ -0,0 +1,50 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.stream.upstream.peers.unavail +categories: +- nginx +description: How many times the server became unavailable for client connections (state + β€œunavail”) due to the number of unsuccessful attempts reaching the max_fails threshold. +type: counter +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- peer.name +- peer.address +- environment +- app +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/plus.stream.upstream.zombies.yml b/site/data/v2metrics/plus.stream.upstream.zombies.yml new file mode 100644 index 000000000..9b9a3f35a --- /dev/null +++ b/site/data/v2metrics/plus.stream.upstream.zombies.yml @@ -0,0 +1,48 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: plus.stream.upstream.zombies +categories: +- nginx +description: The current number of servers removed from the group but still processing + active client connections. +type: gauge +source: plus_status +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +- adm +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags +- upstream +- upstream_zone +- environment +- app +- component +- site +- environment_name +- component_name +- app_name +- site_name diff --git a/site/data/v2metrics/stream.bytes_rcvd.yml b/site/data/v2metrics/stream.bytes_rcvd.yml new file mode 100644 index 000000000..32b5bfd41 --- /dev/null +++ b/site/data/v2metrics/stream.bytes_rcvd.yml @@ -0,0 +1,57 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: stream.bytes_rcvd +categories: + - advanced-metrics +description: The total number of bytes received from clients. +type: counter +source: advanced-metrics-module +unit: bytes +rate: net_io_rate +visible: true +compound_payload: "false" +modules: + - adm + - acm +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - system.tags + - instance_group + - display_name + - nginx_id + - http.upstream_addr + - family + - proxied_protocol + - app + - environment + - component + - gateway + - acm_api_proxy_hostname + - acm_api_proxy_name + - acm_api_proxy_version + - acm_environments_name + - acm_environments_type + - acm_infra_workspaces_name + - acm_service_workspaces_name + - site + - environment_name + - gateway_name + - component_name + - app_name + - site_name diff --git a/site/data/v2metrics/stream.bytes_sent.yml b/site/data/v2metrics/stream.bytes_sent.yml new file mode 100644 index 000000000..8b556babf --- /dev/null +++ b/site/data/v2metrics/stream.bytes_sent.yml @@ -0,0 +1,57 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: stream.bytes_sent +categories: + - advanced-metrics +description: The total number of bytes sent from clients. +type: counter +source: advanced-metrics-module +unit: bytes +rate: net_io_rate +visible: true +compound_payload: "false" +modules: + - adm + - acm +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - system.tags + - instance_group + - display_name + - nginx_id + - http.upstream_addr + - family + - proxied_protocol + - app + - environment + - component + - gateway + - acm_api_proxy_hostname + - acm_api_proxy_name + - acm_api_proxy_version + - acm_environments_name + - acm_environments_type + - acm_infra_workspaces_name + - acm_service_workspaces_name + - site + - environment_name + - gateway_name + - component_name + - app_name + - site_name \ No newline at end of file diff --git a/site/data/v2metrics/stream.connection_duration.yml b/site/data/v2metrics/stream.connection_duration.yml new file mode 100644 index 000000000..eb79533d6 --- /dev/null +++ b/site/data/v2metrics/stream.connection_duration.yml @@ -0,0 +1,57 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: stream.connection_duration +categories: + - advanced-metrics +description: The duration of connection with the proxy. +type: gauge +source: advanced-metrics-module +unit: milliseconds +rate: double +visible: true +compound_payload: "false" +modules: + - adm + - acm +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - system.tags + - instance_group + - display_name + - nginx_id + - http.upstream_addr + - family + - proxied_protocol + - app + - environment + - component + - gateway + - acm_api_proxy_hostname + - acm_api_proxy_name + - acm_api_proxy_version + - acm_environments_name + - acm_environments_type + - acm_infra_workspaces_name + - acm_service_workspaces_name + - site + - environment_name + - gateway_name + - component_name + - app_name + - site_name diff --git a/site/data/v2metrics/stream.connections.yml b/site/data/v2metrics/stream.connections.yml new file mode 100644 index 000000000..6150de3fe --- /dev/null +++ b/site/data/v2metrics/stream.connections.yml @@ -0,0 +1,57 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: stream.connections +categories: + - advanced-metrics +description: The total number of connections accepted from clients. +type: gauge +source: advanced-metrics-module +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: + - adm + - acm +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - system.tags + - instance_group + - display_name + - nginx_id + - http.upstream_addr + - family + - proxied_protocol + - app + - environment + - component + - gateway + - acm_api_proxy_hostname + - acm_api_proxy_name + - acm_api_proxy_version + - acm_environments_name + - acm_environments_type + - acm_infra_workspaces_name + - acm_service_workspaces_name + - site + - environment_name + - gateway_name + - component_name + - app_name + - site_name diff --git a/site/data/v2metrics/system.cpu.idle.yml b/site/data/v2metrics/system.cpu.idle.yml new file mode 100644 index 000000000..b9128f505 --- /dev/null +++ b/site/data/v2metrics/system.cpu.idle.yml @@ -0,0 +1,36 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: system.cpu.idle +categories: +- system +description: System CPU utilization. +type: gauge +counted: true +source: psutil +unit: percent +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/system.cpu.iowait.yml b/site/data/v2metrics/system.cpu.iowait.yml new file mode 100644 index 000000000..653d3daf1 --- /dev/null +++ b/site/data/v2metrics/system.cpu.iowait.yml @@ -0,0 +1,36 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: system.cpu.iowait +categories: +- system +description: System CPU utilization. +type: gauge +counted: true +source: psutil +unit: percent +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/system.cpu.stolen.yml b/site/data/v2metrics/system.cpu.stolen.yml new file mode 100644 index 000000000..f5f8c4d7c --- /dev/null +++ b/site/data/v2metrics/system.cpu.stolen.yml @@ -0,0 +1,37 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: system.cpu.stolen +categories: +- system +description: System CPU stolen. Represents time when the real CPU was not available + to the current VM. +type: gauge +counted: true +source: psutil +unit: percent +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/system.cpu.system.yml b/site/data/v2metrics/system.cpu.system.yml new file mode 100644 index 000000000..b69a0f3d6 --- /dev/null +++ b/site/data/v2metrics/system.cpu.system.yml @@ -0,0 +1,36 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: system.cpu.system +categories: +- system +description: System CPU utilization. +type: gauge +counted: true +source: psutil +unit: percent +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/system.cpu.user.yml b/site/data/v2metrics/system.cpu.user.yml new file mode 100644 index 000000000..b6a10bac3 --- /dev/null +++ b/site/data/v2metrics/system.cpu.user.yml @@ -0,0 +1,36 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: system.cpu.user +categories: +- system +description: System CPU utilization. +type: gauge +counted: true +source: psutil +unit: percent +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/system.disk.free.yml b/site/data/v2metrics/system.disk.free.yml new file mode 100644 index 000000000..1ed972820 --- /dev/null +++ b/site/data/v2metrics/system.disk.free.yml @@ -0,0 +1,37 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: system.disk.free +categories: + - system +description: System disk usage statistics. +type: gauge +counted: true +source: psutil +unit: bytes +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - mount_point + - instance_group + - system.tags diff --git a/site/data/v2metrics/system.disk.in_use.yml b/site/data/v2metrics/system.disk.in_use.yml new file mode 100644 index 000000000..8eb6836c1 --- /dev/null +++ b/site/data/v2metrics/system.disk.in_use.yml @@ -0,0 +1,37 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: system.disk.in_use +categories: + - system +description: System disk usage statistics, percentage. +type: gauge +counted: true +source: psutil +unit: percent +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - mount_point + - instance_group + - system.tags diff --git a/site/data/v2metrics/system.disk.total.yml b/site/data/v2metrics/system.disk.total.yml new file mode 100644 index 000000000..d5d4e920d --- /dev/null +++ b/site/data/v2metrics/system.disk.total.yml @@ -0,0 +1,37 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: system.disk.total +categories: + - system +description: System disk usage statistics. +type: gauge +counted: true +source: psutil +unit: bytes +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - mount_point + - instance_group + - system.tags diff --git a/site/data/v2metrics/system.disk.used.yml b/site/data/v2metrics/system.disk.used.yml new file mode 100644 index 000000000..a08de3ba9 --- /dev/null +++ b/site/data/v2metrics/system.disk.used.yml @@ -0,0 +1,37 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: system.disk.used +categories: + - system +description: System disk usage statistics. +type: gauge +counted: true +source: psutil +unit: bytes +visible: true +compound_payload: "false" +modules: + - platform +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - system_id + - hostname + - display_name + - nginx_id + - mount_point + - instance_group + - system.tags diff --git a/site/data/v2metrics/system.io.iops_r.yml b/site/data/v2metrics/system.io.iops_r.yml new file mode 100644 index 000000000..8e6c868e5 --- /dev/null +++ b/site/data/v2metrics/system.io.iops_r.yml @@ -0,0 +1,38 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: system.io.iops_r +categories: +- system +description: Number of reads per sampling window. +type: counter +counted: true +source: psutil +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- mount_point +- instance_group +- system.tags diff --git a/site/data/v2metrics/system.io.iops_w.yml b/site/data/v2metrics/system.io.iops_w.yml new file mode 100644 index 000000000..d5abe5dd0 --- /dev/null +++ b/site/data/v2metrics/system.io.iops_w.yml @@ -0,0 +1,38 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: system.io.iops_w +categories: +- system +description: Number of writes per sampling window. +type: counter +counted: true +source: psutil +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- mount_point +- instance_group +- system.tags diff --git a/site/data/v2metrics/system.io.kbs_r.yml b/site/data/v2metrics/system.io.kbs_r.yml new file mode 100644 index 000000000..eddb1709e --- /dev/null +++ b/site/data/v2metrics/system.io.kbs_r.yml @@ -0,0 +1,38 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: system.io.kbs_r +categories: +- system +description: Number of kilobytes read. +type: counter +counted: true +source: psutil +unit: kilobytes +rate: disk_io_rate +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- mount_point +- instance_group +- system.tags diff --git a/site/data/v2metrics/system.io.kbs_w.yml b/site/data/v2metrics/system.io.kbs_w.yml new file mode 100644 index 000000000..e67cd20f1 --- /dev/null +++ b/site/data/v2metrics/system.io.kbs_w.yml @@ -0,0 +1,38 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: system.io.kbs_w +categories: +- system +description: Number of kilobytes written. +type: counter +counted: true +source: psutil +unit: kilobytes +rate: disk_io_rate +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- mount_point +- instance_group +- system.tags diff --git a/site/data/v2metrics/system.io.wait_r.yml b/site/data/v2metrics/system.io.wait_r.yml new file mode 100644 index 000000000..776ac4efe --- /dev/null +++ b/site/data/v2metrics/system.io.wait_r.yml @@ -0,0 +1,37 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: system.io.wait_r +categories: +- system +description: Time spent reading from disk. +type: counter +counted: true +source: psutil +unit: milliseconds +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- mount_point +- instance_group +- system.tags diff --git a/site/data/v2metrics/system.io.wait_w.yml b/site/data/v2metrics/system.io.wait_w.yml new file mode 100644 index 000000000..4743d45f3 --- /dev/null +++ b/site/data/v2metrics/system.io.wait_w.yml @@ -0,0 +1,37 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: system.io.wait_w +categories: +- system +description: Time spent writing to disk. +type: counter +counted: true +source: psutil +unit: milliseconds +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- mount_point +- instance_group +- system.tags diff --git a/site/data/v2metrics/system.load.1.yml b/site/data/v2metrics/system.load.1.yml new file mode 100644 index 000000000..3c6e603af --- /dev/null +++ b/site/data/v2metrics/system.load.1.yml @@ -0,0 +1,37 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: system.load.1 +categories: +- system +description: Number of processes in the system run queue, averaged over the last 1 + min. +type: gauge +counted: true +source: psutil +unit: float +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/system.load.15.yml b/site/data/v2metrics/system.load.15.yml new file mode 100644 index 000000000..c9a0e051d --- /dev/null +++ b/site/data/v2metrics/system.load.15.yml @@ -0,0 +1,37 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: system.load.15 +categories: +- system +description: Number of processes in the system run queue, averaged over the last 15 + min. +type: gauge +counted: true +source: psutil +unit: float +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/system.load.5.yml b/site/data/v2metrics/system.load.5.yml new file mode 100644 index 000000000..8259d37f3 --- /dev/null +++ b/site/data/v2metrics/system.load.5.yml @@ -0,0 +1,37 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: system.load.5 +categories: +- system +description: Number of processes in the system run queue, averaged over the last 5 + min. +type: gauge +counted: true +source: psutil +unit: float +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/system.mem.available.yml b/site/data/v2metrics/system.mem.available.yml new file mode 100644 index 000000000..a07dc5d0b --- /dev/null +++ b/site/data/v2metrics/system.mem.available.yml @@ -0,0 +1,36 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: system.mem.available +categories: +- system +description: Statistics about system memory usage. +type: gauge +counted: true +source: psutil +unit: bytes +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/system.mem.buffered.yml b/site/data/v2metrics/system.mem.buffered.yml new file mode 100644 index 000000000..64d9e6e78 --- /dev/null +++ b/site/data/v2metrics/system.mem.buffered.yml @@ -0,0 +1,36 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: system.mem.buffered +categories: +- system +description: Statistics about system memory usage. +type: gauge +counted: true +source: psutil +unit: bytes +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/system.mem.cached.yml b/site/data/v2metrics/system.mem.cached.yml new file mode 100644 index 000000000..20c792f8c --- /dev/null +++ b/site/data/v2metrics/system.mem.cached.yml @@ -0,0 +1,36 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: system.mem.cached +categories: +- system +description: Statistics about system memory usage. +type: gauge +counted: true +source: psutil +unit: bytes +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/system.mem.free.yml b/site/data/v2metrics/system.mem.free.yml new file mode 100644 index 000000000..3f2d285ce --- /dev/null +++ b/site/data/v2metrics/system.mem.free.yml @@ -0,0 +1,36 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: system.mem.free +categories: +- system +description: Statistics about system memory usage. +type: gauge +counted: true +source: psutil +unit: bytes +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/system.mem.pct_used.yml b/site/data/v2metrics/system.mem.pct_used.yml new file mode 100644 index 000000000..26ed65488 --- /dev/null +++ b/site/data/v2metrics/system.mem.pct_used.yml @@ -0,0 +1,36 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: system.mem.pct_used +categories: +- system +description: Statistics about system memory usage, percentage. +type: gauge +counted: true +source: psutil +unit: percent +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/system.mem.shared.yml b/site/data/v2metrics/system.mem.shared.yml new file mode 100644 index 000000000..b25e38f40 --- /dev/null +++ b/site/data/v2metrics/system.mem.shared.yml @@ -0,0 +1,35 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: system.mem.shared +categories: +- system +description: Statistics about system memory usage. +type: gauge +source: psutil +unit: bytes +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/system.mem.total.yml b/site/data/v2metrics/system.mem.total.yml new file mode 100644 index 000000000..9648cb789 --- /dev/null +++ b/site/data/v2metrics/system.mem.total.yml @@ -0,0 +1,36 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: system.mem.total +categories: +- system +description: Statistics about system memory usage. +type: gauge +counted: true +source: psutil +unit: bytes +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/system.mem.used.all.yml b/site/data/v2metrics/system.mem.used.all.yml new file mode 100644 index 000000000..2cd308ecc --- /dev/null +++ b/site/data/v2metrics/system.mem.used.all.yml @@ -0,0 +1,36 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: system.mem.used.all +categories: +- system +description: Statistics about system memory usage. +type: gauge +counted: true +source: psutil +unit: bytes +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/system.mem.used.yml b/site/data/v2metrics/system.mem.used.yml new file mode 100644 index 000000000..8388bd347 --- /dev/null +++ b/site/data/v2metrics/system.mem.used.yml @@ -0,0 +1,36 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: system.mem.used +categories: +- system +description: Statistics about system memory usage. +type: gauge +counted: true +source: psutil +unit: bytes +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/system.net.bytes_rcvd.yml b/site/data/v2metrics/system.net.bytes_rcvd.yml new file mode 100644 index 000000000..87ebf74c7 --- /dev/null +++ b/site/data/v2metrics/system.net.bytes_rcvd.yml @@ -0,0 +1,38 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: system.net.bytes_rcvd +categories: +- system +description: Network I/O statistics. Number of bytes received per network interface. +type: counter +counted: true +source: psutil +unit: bytes +rate: net_io_rate +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- network_interface +- instance_group +- system.tags diff --git a/site/data/v2metrics/system.net.bytes_sent.yml b/site/data/v2metrics/system.net.bytes_sent.yml new file mode 100644 index 000000000..e22d5d16a --- /dev/null +++ b/site/data/v2metrics/system.net.bytes_sent.yml @@ -0,0 +1,38 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: system.net.bytes_sent +categories: +- system +description: Network I/O statistics. Number of bytes sent per network interface. +type: counter +counted: true +source: psutil +unit: bytes +rate: net_io_rate +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- network_interface +- instance_group +- system.tags diff --git a/site/data/v2metrics/system.net.drops_in.count.yml b/site/data/v2metrics/system.net.drops_in.count.yml new file mode 100644 index 000000000..6cfff9920 --- /dev/null +++ b/site/data/v2metrics/system.net.drops_in.count.yml @@ -0,0 +1,39 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: system.net.drops_in.count +categories: +- system +description: Network I/O statistics. Total number of inbound packets dropped per network + interface. +type: counter +counted: true +source: psutil +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- network_interface +- instance_group +- system.tags diff --git a/site/data/v2metrics/system.net.drops_out.count.yml b/site/data/v2metrics/system.net.drops_out.count.yml new file mode 100644 index 000000000..bccaaebc5 --- /dev/null +++ b/site/data/v2metrics/system.net.drops_out.count.yml @@ -0,0 +1,39 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: system.net.drops_out.count +categories: +- system +description: Network I/O statistics. Total number of outbound packets dropped per + network interface. +type: counter +counted: true +source: psutil +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- network_interface +- instance_group +- system.tags diff --git a/site/data/v2metrics/system.net.listen_overflows.yml b/site/data/v2metrics/system.net.listen_overflows.yml new file mode 100644 index 000000000..f5877e0ff --- /dev/null +++ b/site/data/v2metrics/system.net.listen_overflows.yml @@ -0,0 +1,37 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: system.net.listen_overflows +categories: +- system +description: Number of times the listen queue of a socket overflowed. +type: counter +counted: true +source: psutil +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/system.net.packets_in.count.yml b/site/data/v2metrics/system.net.packets_in.count.yml new file mode 100644 index 000000000..2ba719d7e --- /dev/null +++ b/site/data/v2metrics/system.net.packets_in.count.yml @@ -0,0 +1,38 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: system.net.packets_in.count +categories: +- system +description: Network I/O statistics. Number of packets received per network interface. +type: counter +counted: true +source: psutil +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- network_interface +- instance_group +- system.tags diff --git a/site/data/v2metrics/system.net.packets_in.error.yml b/site/data/v2metrics/system.net.packets_in.error.yml new file mode 100644 index 000000000..bb3764e5c --- /dev/null +++ b/site/data/v2metrics/system.net.packets_in.error.yml @@ -0,0 +1,39 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: system.net.packets_in.error +categories: +- system +description: Network I/O statistics. Total number of errors while receiving per network + interface. +type: counter +counted: true +source: psutil +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- network_interface +- instance_group +- system.tags diff --git a/site/data/v2metrics/system.net.packets_out.count.yml b/site/data/v2metrics/system.net.packets_out.count.yml new file mode 100644 index 000000000..085ff2090 --- /dev/null +++ b/site/data/v2metrics/system.net.packets_out.count.yml @@ -0,0 +1,38 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: system.net.packets_out.count +categories: +- system +description: Network I/O statistics. Number of packets sent per network interface. +type: counter +counted: true +source: psutil +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- network_interface +- instance_group +- system.tags diff --git a/site/data/v2metrics/system.net.packets_out.error.yml b/site/data/v2metrics/system.net.packets_out.error.yml new file mode 100644 index 000000000..ac5f83c60 --- /dev/null +++ b/site/data/v2metrics/system.net.packets_out.error.yml @@ -0,0 +1,39 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: system.net.packets_out.error +categories: +- system +description: Network I/O statistics. Total number of errors while sending per network + interface. +type: counter +counted: true +source: psutil +unit: integer +rate: double +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- network_interface +- instance_group +- system.tags diff --git a/site/data/v2metrics/system.swap.free.yml b/site/data/v2metrics/system.swap.free.yml new file mode 100644 index 000000000..51a4b0240 --- /dev/null +++ b/site/data/v2metrics/system.swap.free.yml @@ -0,0 +1,36 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: system.swap.free +categories: +- system +description: System swap memory statistics. +type: gauge +counted: true +source: psutil +unit: bytes +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/system.swap.pct_free.yml b/site/data/v2metrics/system.swap.pct_free.yml new file mode 100644 index 000000000..9f2413a65 --- /dev/null +++ b/site/data/v2metrics/system.swap.pct_free.yml @@ -0,0 +1,36 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: system.swap.pct_free +categories: +- system +description: System swap memory statistics, percentage. +type: gauge +counted: true +source: psutil +unit: percent +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/system.swap.total.yml b/site/data/v2metrics/system.swap.total.yml new file mode 100644 index 000000000..346f8a784 --- /dev/null +++ b/site/data/v2metrics/system.swap.total.yml @@ -0,0 +1,36 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: system.swap.total +categories: +- system +description: System swap memory statistics. +type: gauge +counted: true +source: psutil +unit: bytes +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/system.swap.used.yml b/site/data/v2metrics/system.swap.used.yml new file mode 100644 index 000000000..c11071364 --- /dev/null +++ b/site/data/v2metrics/system.swap.used.yml @@ -0,0 +1,36 @@ +# +# Copyright (C) F5 2022 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: system.swap.used +categories: +- system +description: System swap memory statistics. +type: gauge +counted: true +source: psutil +unit: bytes +visible: true +compound_payload: "false" +modules: +- platform +aggregations: +- MIN +- MAX +- SUM +- AVG +- COUNT +- RATE +dimensions: +- system_id +- hostname +- display_name +- nginx_id +- instance_group +- system.tags diff --git a/site/data/v2metrics/upstream.header.latency.max.yml b/site/data/v2metrics/upstream.header.latency.max.yml new file mode 100644 index 000000000..8e30abd6c --- /dev/null +++ b/site/data/v2metrics/upstream.header.latency.max.yml @@ -0,0 +1,65 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: upstream.header.latency.max +categories: + - advanced-metrics +description: + Maximal header latency observed on a given upstream. + If `family` dimension is set to `web`, the request was `http` type + and if the `family` is set to `tcp-udp`, the request was `stream` type. +type: gauge +source: advanced-metrics-module +unit: milliseconds +rate: "" +visible: true +compound_payload: "false" +modules: + - adm + - acm +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - app + - environment + - component + - gateway + - http.hostname + - http.request_method + - http.response_code + - http.upstream_addr + - http.uri + - http.version_schema + - system_id + - hostname + - display_name + - nginx_id + - instance_group + - system.tags + - acm_api_proxy_hostname + - acm_api_proxy_name + - acm_api_proxy_version + - acm_environments_name + - acm_environments_type + - acm_infra_workspaces_name + - acm_service_workspaces_name + - family + - proxied_protocol + - site + - environment_name + - gateway_name + - component_name + - app_name + - site_name diff --git a/site/data/v2metrics/upstream.network.latency.max.yml b/site/data/v2metrics/upstream.network.latency.max.yml new file mode 100644 index 000000000..c42bd1b31 --- /dev/null +++ b/site/data/v2metrics/upstream.network.latency.max.yml @@ -0,0 +1,65 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: upstream.network.latency.max +categories: + - advanced-metrics +description: + Maximal network latency observed on a given upstream. + If `family` dimension is set to `web`, the request was `http` type + and if the `family` is set to `tcp-udp`, the request was `stream` type. +type: gauge +source: advanced-metrics-module +unit: milliseconds +rate: "" +visible: true +compound_payload: "false" +modules: + - adm + - acm +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - app + - environment + - component + - gateway + - http.hostname + - http.request_method + - http.response_code + - http.upstream_addr + - http.uri + - http.version_schema + - system_id + - hostname + - display_name + - nginx_id + - instance_group + - system.tags + - acm_api_proxy_hostname + - acm_api_proxy_name + - acm_api_proxy_version + - acm_environments_name + - acm_environments_type + - acm_infra_workspaces_name + - acm_service_workspaces_name + - family + - proxied_protocol + - site + - environment_name + - gateway_name + - component_name + - app_name + - site_name diff --git a/site/data/v2metrics/upstream.response.latency.max.yml b/site/data/v2metrics/upstream.response.latency.max.yml new file mode 100644 index 000000000..2efea01ce --- /dev/null +++ b/site/data/v2metrics/upstream.response.latency.max.yml @@ -0,0 +1,65 @@ +# +# Copyright (C) F5 2023 +# All rights reserved. +# +# No part of the software may be reproduced or transmitted in any +# form or by any means, electronic or mechanical, for any purpose, +# without express written permission of F5, Inc. +# + +--- +name: upstream.response.latency.max +categories: + - advanced-metrics +description: + Maximal response latency observed on a given upstream. + If `family` dimension is set to `web`, the request was `http` type + and if the `family` is set to `tcp-udp`, the request was `stream` type. +type: gauge +source: advanced-metrics-module +unit: milliseconds +rate: "" +visible: true +compound_payload: "false" +modules: + - adm + - acm +aggregations: + - MIN + - MAX + - SUM + - AVG + - COUNT + - RATE +dimensions: + - app + - environment + - component + - gateway + - http.hostname + - http.request_method + - http.response_code + - http.upstream_addr + - http.uri + - http.version_schema + - system_id + - hostname + - display_name + - nginx_id + - instance_group + - system.tags + - acm_api_proxy_hostname + - acm_api_proxy_name + - acm_api_proxy_version + - acm_environments_name + - acm_environments_type + - acm_infra_workspaces_name + - acm_service_workspaces_name + - family + - proxied_protocol + - site + - environment_name + - gateway_name + - component_name + - app_name + - site_name diff --git a/site/layouts/catalogs/single.html b/site/layouts/catalogs/single.html new file mode 100644 index 000000000..57b1d7779 --- /dev/null +++ b/site/layouts/catalogs/single.html @@ -0,0 +1,14 @@ +{{ define "main" }} +
+ + + {{ .Content }} + +{{if .Params.script}} + {{ $script := (delimit (slice "scripts" .Params.script) "/")}} + {{ partial (string $script) .}} +{{end }} + +{{ end }} diff --git a/site/layouts/shortcodes/v2-metrics.html b/site/layouts/shortcodes/v2-metrics.html new file mode 100644 index 000000000..dc14d9a35 --- /dev/null +++ b/site/layouts/shortcodes/v2-metrics.html @@ -0,0 +1,56 @@ +
+ {{ range .Site.Data.v2metrics }} + +

{{.name}} + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
description{{.description}}
type{{.type}}
categories{{.categories}}
source{{.source}}
rollup_aggregate{{.rollup_aggregate}}
unit{{.unit}}
aggregations + {{ range .aggregations }} + {{ . }}; + {{end}} +
dimensions + {{ range sort .dimensions }} +
  • + {{ . }} +
    • + {{end}} +
    +
    + {{ end }} +
    \ No newline at end of file From a4f17a690c8d9e0a1ca3de2284d442beb6087709 Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Thu, 22 Aug 2024 17:17:56 +0100 Subject: [PATCH 05/30] feat: Add toc:true to v2 metrics page frontmatter --- site/content/v2/metrics.md | 1 + 1 file changed, 1 insertion(+) diff --git a/site/content/v2/metrics.md b/site/content/v2/metrics.md index 2de0cb9a5..e90e55c93 100644 --- a/site/content/v2/metrics.md +++ b/site/content/v2/metrics.md @@ -2,6 +2,7 @@ title: Metrics catalog: true catalogType: v2metrics +toc: true weight: 200 docs: DOCS-000 --- From cbb4d52de70863a69704cd878002ac7d41b51e75 Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Fri, 23 Aug 2024 14:42:58 +0100 Subject: [PATCH 06/30] feat: Remove F5 copyright from top of metrics YAML files --- site/data/v2metrics/client.network.latency.max.yml | 8 -------- site/data/v2metrics/client.request.latency.max.yml | 8 -------- site/data/v2metrics/client.response.latency.max.yml | 8 -------- site/data/v2metrics/client.ttfb.latency.max.yml | 8 -------- site/data/v2metrics/http.request.bytes_rcvd.yml | 8 -------- site/data/v2metrics/http.request.bytes_sent.yml | 8 -------- site/data/v2metrics/http.request.count.yml | 8 -------- site/data/v2metrics/nginx.config.generation.yml | 8 -------- site/data/v2metrics/nginx.http.conn.accepted.yml | 8 -------- site/data/v2metrics/nginx.http.conn.active.yml | 8 -------- site/data/v2metrics/nginx.http.conn.current.yml | 8 -------- site/data/v2metrics/nginx.http.conn.dropped.yml | 8 -------- site/data/v2metrics/nginx.http.conn.handled.yml | 8 -------- site/data/v2metrics/nginx.http.conn.idle.yml | 8 -------- site/data/v2metrics/nginx.http.conn.reading.yml | 8 -------- site/data/v2metrics/nginx.http.conn.writing.yml | 8 -------- site/data/v2metrics/nginx.http.gzip.ratio.yml | 8 -------- site/data/v2metrics/nginx.http.method.delete.yml | 8 -------- site/data/v2metrics/nginx.http.method.get.yml | 8 -------- site/data/v2metrics/nginx.http.method.head.yml | 8 -------- site/data/v2metrics/nginx.http.method.options.yml | 8 -------- site/data/v2metrics/nginx.http.method.others.yml | 8 -------- site/data/v2metrics/nginx.http.method.post.yml | 8 -------- site/data/v2metrics/nginx.http.method.put.yml | 8 -------- .../data/v2metrics/nginx.http.request.body_bytes_sent.yml | 8 -------- site/data/v2metrics/nginx.http.request.buffered.yml | 8 -------- site/data/v2metrics/nginx.http.request.bytes_sent.yml | 8 -------- site/data/v2metrics/nginx.http.request.count.yml | 8 -------- site/data/v2metrics/nginx.http.request.current.yml | 8 -------- site/data/v2metrics/nginx.http.request.length.yml | 8 -------- site/data/v2metrics/nginx.http.request.malformed.yml | 8 -------- site/data/v2metrics/nginx.http.request.time.max.yml | 8 -------- site/data/v2metrics/nginx.http.request.time.median.yml | 8 -------- site/data/v2metrics/nginx.http.request.time.pctl95.yml | 8 -------- site/data/v2metrics/nginx.http.request.time.yml | 8 -------- site/data/v2metrics/nginx.http.status.1xx.yml | 8 -------- site/data/v2metrics/nginx.http.status.2xx.yml | 8 -------- site/data/v2metrics/nginx.http.status.3xx.yml | 8 -------- site/data/v2metrics/nginx.http.status.403.yml | 8 -------- site/data/v2metrics/nginx.http.status.404.yml | 8 -------- site/data/v2metrics/nginx.http.status.4xx.yml | 8 -------- site/data/v2metrics/nginx.http.status.500.yml | 8 -------- site/data/v2metrics/nginx.http.status.502.yml | 8 -------- site/data/v2metrics/nginx.http.status.503.yml | 8 -------- site/data/v2metrics/nginx.http.status.504.yml | 8 -------- site/data/v2metrics/nginx.http.status.5xx.yml | 8 -------- site/data/v2metrics/nginx.http.status.discarded.yml | 8 -------- site/data/v2metrics/nginx.http.v0_9.yml | 8 -------- site/data/v2metrics/nginx.http.v1_0.yml | 8 -------- site/data/v2metrics/nginx.http.v1_1.yml | 8 -------- site/data/v2metrics/nginx.http.v2.yml | 8 -------- site/data/v2metrics/nginx.status.yml | 8 -------- site/data/v2metrics/nginx.upstream.request.failed.yml | 8 -------- site/data/v2metrics/nginx.upstream.response.buffered.yml | 8 -------- site/data/v2metrics/nginx.upstream.response.failed.yml | 8 -------- site/data/v2metrics/nginx.workers.count.yml | 8 -------- site/data/v2metrics/nginx.workers.cpu.system.yml | 8 -------- site/data/v2metrics/nginx.workers.cpu.total.yml | 8 -------- site/data/v2metrics/nginx.workers.cpu.user.yml | 8 -------- site/data/v2metrics/nginx.workers.fds_count.yml | 8 -------- site/data/v2metrics/nginx.workers.io.kbs_r.yml | 8 -------- site/data/v2metrics/nginx.workers.io.kbs_w.yml | 8 -------- site/data/v2metrics/nginx.workers.mem.rss.yml | 8 -------- site/data/v2metrics/nginx.workers.mem.rss_pct.yml | 8 -------- site/data/v2metrics/nginx.workers.mem.vms.yml | 8 -------- site/data/v2metrics/nginx.workers.rlimit_nofile.yml | 8 -------- site/data/v2metrics/plus.cache.bypass.bytes.yml | 8 -------- site/data/v2metrics/plus.cache.bypass.responses.yml | 8 -------- site/data/v2metrics/plus.cache.expired.bytes.yml | 8 -------- site/data/v2metrics/plus.cache.expired.responses.yml | 8 -------- site/data/v2metrics/plus.cache.hit.bytes.yml | 8 -------- site/data/v2metrics/plus.cache.hit.responses.yml | 8 -------- site/data/v2metrics/plus.cache.max_size.yml | 8 -------- site/data/v2metrics/plus.cache.miss.bytes.yml | 8 -------- site/data/v2metrics/plus.cache.miss.responses.yml | 8 -------- site/data/v2metrics/plus.cache.revalidated.bytes.yml | 8 -------- site/data/v2metrics/plus.cache.revalidated.responses.yml | 8 -------- site/data/v2metrics/plus.cache.size.yml | 8 -------- site/data/v2metrics/plus.cache.stale.bytes.yml | 8 -------- site/data/v2metrics/plus.cache.stale.responses.yml | 8 -------- site/data/v2metrics/plus.cache.updating.bytes.yml | 8 -------- site/data/v2metrics/plus.cache.updating.responses.yml | 8 -------- site/data/v2metrics/plus.http.limit_conns.passed.yml | 8 -------- site/data/v2metrics/plus.http.limit_conns.rejected.yml | 8 -------- .../v2metrics/plus.http.limit_conns.rejected_dry_run.yml | 8 -------- site/data/v2metrics/plus.http.limit_reqs.delayed.yml | 8 -------- .../v2metrics/plus.http.limit_reqs.delayed_dry_run.yml | 8 -------- site/data/v2metrics/plus.http.limit_reqs.passed.yml | 8 -------- site/data/v2metrics/plus.http.limit_reqs.rejected.yml | 8 -------- .../v2metrics/plus.http.limit_reqs.rejected_dry_run.yml | 8 -------- site/data/v2metrics/plus.http.request.bytes_rcvd.yml | 8 -------- site/data/v2metrics/plus.http.request.bytes_sent.yml | 8 -------- site/data/v2metrics/plus.http.request.count.yml | 8 -------- site/data/v2metrics/plus.http.response.count.yml | 8 -------- site/data/v2metrics/plus.http.status.1xx.yml | 8 -------- site/data/v2metrics/plus.http.status.2xx.yml | 8 -------- site/data/v2metrics/plus.http.status.3xx.yml | 8 -------- site/data/v2metrics/plus.http.status.4xx.yml | 8 -------- site/data/v2metrics/plus.http.status.5xx.yml | 8 -------- site/data/v2metrics/plus.http.status.discarded.yml | 8 -------- site/data/v2metrics/plus.http.status.processing.yml | 8 -------- site/data/v2metrics/plus.http.upstream.keepalives.yml | 8 -------- .../v2metrics/plus.http.upstream.peers.bytes_rcvd.yml | 8 -------- .../v2metrics/plus.http.upstream.peers.bytes_sent.yml | 8 -------- .../v2metrics/plus.http.upstream.peers.conn.active.yml | 8 -------- site/data/v2metrics/plus.http.upstream.peers.fails.yml | 8 -------- .../v2metrics/plus.http.upstream.peers.header_time.yml | 8 -------- .../plus.http.upstream.peers.health_checks.checks.yml | 8 -------- .../plus.http.upstream.peers.health_checks.fails.yml | 8 -------- .../plus.http.upstream.peers.health_checks.unhealthy.yml | 8 -------- .../v2metrics/plus.http.upstream.peers.request.count.yml | 8 -------- .../v2metrics/plus.http.upstream.peers.response.count.yml | 8 -------- .../v2metrics/plus.http.upstream.peers.response.time.yml | 8 -------- .../v2metrics/plus.http.upstream.peers.state.checking.yml | 8 -------- .../v2metrics/plus.http.upstream.peers.state.down.yml | 8 -------- .../v2metrics/plus.http.upstream.peers.state.draining.yml | 8 -------- .../v2metrics/plus.http.upstream.peers.state.unavail.yml | 8 -------- .../plus.http.upstream.peers.state.unhealthy.yml | 8 -------- site/data/v2metrics/plus.http.upstream.peers.state.up.yml | 8 -------- .../v2metrics/plus.http.upstream.peers.status.1xx.yml | 8 -------- .../v2metrics/plus.http.upstream.peers.status.2xx.yml | 8 -------- .../v2metrics/plus.http.upstream.peers.status.3xx.yml | 8 -------- .../v2metrics/plus.http.upstream.peers.status.4xx.yml | 8 -------- .../v2metrics/plus.http.upstream.peers.status.5xx.yml | 8 -------- .../v2metrics/plus.http.upstream.peers.total.checking.yml | 8 -------- .../v2metrics/plus.http.upstream.peers.total.down.yml | 8 -------- .../v2metrics/plus.http.upstream.peers.total.draining.yml | 8 -------- .../v2metrics/plus.http.upstream.peers.total.unavail.yml | 8 -------- .../plus.http.upstream.peers.total.unhealthy.yml | 8 -------- site/data/v2metrics/plus.http.upstream.peers.total.up.yml | 8 -------- site/data/v2metrics/plus.http.upstream.peers.unavail.yml | 8 -------- site/data/v2metrics/plus.http.upstream.queue.maxsize.yml | 8 -------- .../data/v2metrics/plus.http.upstream.queue.overflows.yml | 8 -------- site/data/v2metrics/plus.http.upstream.queue.size.yml | 8 -------- site/data/v2metrics/plus.http.upstream.zombies.yml | 8 -------- site/data/v2metrics/plus.instance.count.yml | 8 -------- site/data/v2metrics/plus.slab.pages.free.yml | 8 -------- site/data/v2metrics/plus.slab.pages.pct_used.yml | 8 -------- site/data/v2metrics/plus.slab.pages.total.yml | 8 -------- site/data/v2metrics/plus.slab.pages.used.yml | 8 -------- site/data/v2metrics/plus.ssl.failed.yml | 8 -------- site/data/v2metrics/plus.ssl.handshakes.yml | 8 -------- site/data/v2metrics/plus.ssl.reuses.yml | 8 -------- site/data/v2metrics/plus.stream.bytes_rcvd.yml | 8 -------- site/data/v2metrics/plus.stream.bytes_sent.yml | 8 -------- site/data/v2metrics/plus.stream.connections.yml | 8 -------- site/data/v2metrics/plus.stream.discarded.yml | 8 -------- site/data/v2metrics/plus.stream.processing.yml | 8 -------- site/data/v2metrics/plus.stream.status.2xx.yml | 8 -------- site/data/v2metrics/plus.stream.status.4xx.yml | 8 -------- site/data/v2metrics/plus.stream.status.5xx.yml | 8 -------- site/data/v2metrics/plus.stream.status.total.yml | 8 -------- .../v2metrics/plus.stream.upstream.peers.bytes_rcvd.yml | 8 -------- .../v2metrics/plus.stream.upstream.peers.bytes_sent.yml | 8 -------- .../v2metrics/plus.stream.upstream.peers.conn.active.yml | 8 -------- .../v2metrics/plus.stream.upstream.peers.conn.count.yml | 8 -------- .../v2metrics/plus.stream.upstream.peers.connect_time.yml | 8 -------- site/data/v2metrics/plus.stream.upstream.peers.fails.yml | 8 -------- .../plus.stream.upstream.peers.health_checks.checks.yml | 8 -------- .../plus.stream.upstream.peers.health_checks.fails.yml | 8 -------- ...plus.stream.upstream.peers.health_checks.unhealthy.yml | 8 -------- .../plus.stream.upstream.peers.response.time.yml | 8 -------- .../plus.stream.upstream.peers.state.checking.yml | 8 -------- .../v2metrics/plus.stream.upstream.peers.state.down.yml | 8 -------- .../plus.stream.upstream.peers.state.draining.yml | 8 -------- .../plus.stream.upstream.peers.state.unavail.yml | 8 -------- .../plus.stream.upstream.peers.state.unhealthy.yml | 8 -------- .../v2metrics/plus.stream.upstream.peers.state.up.yml | 8 -------- .../plus.stream.upstream.peers.total.checking.yml | 8 -------- .../v2metrics/plus.stream.upstream.peers.total.down.yml | 8 -------- .../plus.stream.upstream.peers.total.draining.yml | 8 -------- .../plus.stream.upstream.peers.total.unavail.yml | 8 -------- .../plus.stream.upstream.peers.total.unhealthy.yml | 8 -------- .../v2metrics/plus.stream.upstream.peers.total.up.yml | 8 -------- site/data/v2metrics/plus.stream.upstream.peers.ttfb.yml | 8 -------- .../data/v2metrics/plus.stream.upstream.peers.unavail.yml | 8 -------- site/data/v2metrics/plus.stream.upstream.zombies.yml | 8 -------- site/data/v2metrics/stream.bytes_rcvd.yml | 8 -------- site/data/v2metrics/stream.bytes_sent.yml | 8 -------- site/data/v2metrics/stream.connection_duration.yml | 8 -------- site/data/v2metrics/stream.connections.yml | 8 -------- site/data/v2metrics/system.cpu.idle.yml | 8 -------- site/data/v2metrics/system.cpu.iowait.yml | 8 -------- site/data/v2metrics/system.cpu.stolen.yml | 8 -------- site/data/v2metrics/system.cpu.system.yml | 8 -------- site/data/v2metrics/system.cpu.user.yml | 8 -------- site/data/v2metrics/system.disk.free.yml | 8 -------- site/data/v2metrics/system.disk.in_use.yml | 8 -------- site/data/v2metrics/system.disk.total.yml | 8 -------- site/data/v2metrics/system.disk.used.yml | 8 -------- site/data/v2metrics/system.io.iops_r.yml | 8 -------- site/data/v2metrics/system.io.iops_w.yml | 8 -------- site/data/v2metrics/system.io.kbs_r.yml | 8 -------- site/data/v2metrics/system.io.kbs_w.yml | 8 -------- site/data/v2metrics/system.io.wait_r.yml | 8 -------- site/data/v2metrics/system.io.wait_w.yml | 8 -------- site/data/v2metrics/system.load.1.yml | 8 -------- site/data/v2metrics/system.load.15.yml | 8 -------- site/data/v2metrics/system.load.5.yml | 8 -------- site/data/v2metrics/system.mem.available.yml | 8 -------- site/data/v2metrics/system.mem.buffered.yml | 8 -------- site/data/v2metrics/system.mem.cached.yml | 8 -------- site/data/v2metrics/system.mem.free.yml | 8 -------- site/data/v2metrics/system.mem.pct_used.yml | 8 -------- site/data/v2metrics/system.mem.shared.yml | 8 -------- site/data/v2metrics/system.mem.total.yml | 8 -------- site/data/v2metrics/system.mem.used.all.yml | 8 -------- site/data/v2metrics/system.mem.used.yml | 8 -------- site/data/v2metrics/system.net.bytes_rcvd.yml | 8 -------- site/data/v2metrics/system.net.bytes_sent.yml | 8 -------- site/data/v2metrics/system.net.drops_in.count.yml | 8 -------- site/data/v2metrics/system.net.drops_out.count.yml | 8 -------- site/data/v2metrics/system.net.listen_overflows.yml | 8 -------- site/data/v2metrics/system.net.packets_in.count.yml | 8 -------- site/data/v2metrics/system.net.packets_in.error.yml | 8 -------- site/data/v2metrics/system.net.packets_out.count.yml | 8 -------- site/data/v2metrics/system.net.packets_out.error.yml | 8 -------- site/data/v2metrics/system.swap.free.yml | 8 -------- site/data/v2metrics/system.swap.pct_free.yml | 8 -------- site/data/v2metrics/system.swap.total.yml | 8 -------- site/data/v2metrics/system.swap.used.yml | 8 -------- site/data/v2metrics/upstream.header.latency.max.yml | 8 -------- site/data/v2metrics/upstream.network.latency.max.yml | 8 -------- site/data/v2metrics/upstream.response.latency.max.yml | 8 -------- 224 files changed, 1792 deletions(-) diff --git a/site/data/v2metrics/client.network.latency.max.yml b/site/data/v2metrics/client.network.latency.max.yml index ef331b7f8..c0b9bc5bb 100644 --- a/site/data/v2metrics/client.network.latency.max.yml +++ b/site/data/v2metrics/client.network.latency.max.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: client.network.latency.max diff --git a/site/data/v2metrics/client.request.latency.max.yml b/site/data/v2metrics/client.request.latency.max.yml index ac18ee097..3cf023f73 100644 --- a/site/data/v2metrics/client.request.latency.max.yml +++ b/site/data/v2metrics/client.request.latency.max.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: client.request.latency.max diff --git a/site/data/v2metrics/client.response.latency.max.yml b/site/data/v2metrics/client.response.latency.max.yml index 090089518..a38e1e522 100644 --- a/site/data/v2metrics/client.response.latency.max.yml +++ b/site/data/v2metrics/client.response.latency.max.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: client.response.latency.max diff --git a/site/data/v2metrics/client.ttfb.latency.max.yml b/site/data/v2metrics/client.ttfb.latency.max.yml index 06ceeca77..eb2c496b4 100644 --- a/site/data/v2metrics/client.ttfb.latency.max.yml +++ b/site/data/v2metrics/client.ttfb.latency.max.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: client.ttfb.latency.max diff --git a/site/data/v2metrics/http.request.bytes_rcvd.yml b/site/data/v2metrics/http.request.bytes_rcvd.yml index 0aea4ae26..ff39cd2fd 100644 --- a/site/data/v2metrics/http.request.bytes_rcvd.yml +++ b/site/data/v2metrics/http.request.bytes_rcvd.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: http.request.bytes_rcvd diff --git a/site/data/v2metrics/http.request.bytes_sent.yml b/site/data/v2metrics/http.request.bytes_sent.yml index 2460c35bc..6729005fb 100644 --- a/site/data/v2metrics/http.request.bytes_sent.yml +++ b/site/data/v2metrics/http.request.bytes_sent.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: http.request.bytes_sent diff --git a/site/data/v2metrics/http.request.count.yml b/site/data/v2metrics/http.request.count.yml index 12b585696..614b349a1 100644 --- a/site/data/v2metrics/http.request.count.yml +++ b/site/data/v2metrics/http.request.count.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: http.request.count diff --git a/site/data/v2metrics/nginx.config.generation.yml b/site/data/v2metrics/nginx.config.generation.yml index cdee83001..dc385eb7c 100644 --- a/site/data/v2metrics/nginx.config.generation.yml +++ b/site/data/v2metrics/nginx.config.generation.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.config.generation diff --git a/site/data/v2metrics/nginx.http.conn.accepted.yml b/site/data/v2metrics/nginx.http.conn.accepted.yml index de3857f77..298ed5750 100644 --- a/site/data/v2metrics/nginx.http.conn.accepted.yml +++ b/site/data/v2metrics/nginx.http.conn.accepted.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.conn.accepted diff --git a/site/data/v2metrics/nginx.http.conn.active.yml b/site/data/v2metrics/nginx.http.conn.active.yml index 5a3709ba9..2cbb83f4d 100644 --- a/site/data/v2metrics/nginx.http.conn.active.yml +++ b/site/data/v2metrics/nginx.http.conn.active.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.conn.active diff --git a/site/data/v2metrics/nginx.http.conn.current.yml b/site/data/v2metrics/nginx.http.conn.current.yml index f8ebb8a6e..90c1da97c 100644 --- a/site/data/v2metrics/nginx.http.conn.current.yml +++ b/site/data/v2metrics/nginx.http.conn.current.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.conn.current diff --git a/site/data/v2metrics/nginx.http.conn.dropped.yml b/site/data/v2metrics/nginx.http.conn.dropped.yml index 566a32340..26591f6f9 100644 --- a/site/data/v2metrics/nginx.http.conn.dropped.yml +++ b/site/data/v2metrics/nginx.http.conn.dropped.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.conn.dropped diff --git a/site/data/v2metrics/nginx.http.conn.handled.yml b/site/data/v2metrics/nginx.http.conn.handled.yml index ace364c3a..9560bde13 100644 --- a/site/data/v2metrics/nginx.http.conn.handled.yml +++ b/site/data/v2metrics/nginx.http.conn.handled.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.conn.handled diff --git a/site/data/v2metrics/nginx.http.conn.idle.yml b/site/data/v2metrics/nginx.http.conn.idle.yml index 1002f6bc1..f71f72f1f 100644 --- a/site/data/v2metrics/nginx.http.conn.idle.yml +++ b/site/data/v2metrics/nginx.http.conn.idle.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.conn.idle diff --git a/site/data/v2metrics/nginx.http.conn.reading.yml b/site/data/v2metrics/nginx.http.conn.reading.yml index 6cf02091c..d71c25d78 100644 --- a/site/data/v2metrics/nginx.http.conn.reading.yml +++ b/site/data/v2metrics/nginx.http.conn.reading.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.conn.reading diff --git a/site/data/v2metrics/nginx.http.conn.writing.yml b/site/data/v2metrics/nginx.http.conn.writing.yml index c918d8fb8..c6a66c8d2 100644 --- a/site/data/v2metrics/nginx.http.conn.writing.yml +++ b/site/data/v2metrics/nginx.http.conn.writing.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.conn.writing diff --git a/site/data/v2metrics/nginx.http.gzip.ratio.yml b/site/data/v2metrics/nginx.http.gzip.ratio.yml index 450409ae7..5a2f0795f 100644 --- a/site/data/v2metrics/nginx.http.gzip.ratio.yml +++ b/site/data/v2metrics/nginx.http.gzip.ratio.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.gzip.ratio diff --git a/site/data/v2metrics/nginx.http.method.delete.yml b/site/data/v2metrics/nginx.http.method.delete.yml index f8043428f..9f0b78a18 100644 --- a/site/data/v2metrics/nginx.http.method.delete.yml +++ b/site/data/v2metrics/nginx.http.method.delete.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.method.delete diff --git a/site/data/v2metrics/nginx.http.method.get.yml b/site/data/v2metrics/nginx.http.method.get.yml index 1cb18bb1d..3bee08acd 100644 --- a/site/data/v2metrics/nginx.http.method.get.yml +++ b/site/data/v2metrics/nginx.http.method.get.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.method.get diff --git a/site/data/v2metrics/nginx.http.method.head.yml b/site/data/v2metrics/nginx.http.method.head.yml index 28fbd605e..c86e1f7f1 100644 --- a/site/data/v2metrics/nginx.http.method.head.yml +++ b/site/data/v2metrics/nginx.http.method.head.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.method.head diff --git a/site/data/v2metrics/nginx.http.method.options.yml b/site/data/v2metrics/nginx.http.method.options.yml index 6fdc005e2..4256edb8b 100644 --- a/site/data/v2metrics/nginx.http.method.options.yml +++ b/site/data/v2metrics/nginx.http.method.options.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.method.options diff --git a/site/data/v2metrics/nginx.http.method.others.yml b/site/data/v2metrics/nginx.http.method.others.yml index ac161dbd7..0b5c839c7 100644 --- a/site/data/v2metrics/nginx.http.method.others.yml +++ b/site/data/v2metrics/nginx.http.method.others.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.method.others diff --git a/site/data/v2metrics/nginx.http.method.post.yml b/site/data/v2metrics/nginx.http.method.post.yml index 17abefe61..aa4758884 100644 --- a/site/data/v2metrics/nginx.http.method.post.yml +++ b/site/data/v2metrics/nginx.http.method.post.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.method.post diff --git a/site/data/v2metrics/nginx.http.method.put.yml b/site/data/v2metrics/nginx.http.method.put.yml index 28389e07f..fe3207a76 100644 --- a/site/data/v2metrics/nginx.http.method.put.yml +++ b/site/data/v2metrics/nginx.http.method.put.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.method.put diff --git a/site/data/v2metrics/nginx.http.request.body_bytes_sent.yml b/site/data/v2metrics/nginx.http.request.body_bytes_sent.yml index d8d1aac2b..26aab3598 100644 --- a/site/data/v2metrics/nginx.http.request.body_bytes_sent.yml +++ b/site/data/v2metrics/nginx.http.request.body_bytes_sent.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.request.body_bytes_sent diff --git a/site/data/v2metrics/nginx.http.request.buffered.yml b/site/data/v2metrics/nginx.http.request.buffered.yml index ffe0fcbab..b3a4b678d 100644 --- a/site/data/v2metrics/nginx.http.request.buffered.yml +++ b/site/data/v2metrics/nginx.http.request.buffered.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.request.buffered diff --git a/site/data/v2metrics/nginx.http.request.bytes_sent.yml b/site/data/v2metrics/nginx.http.request.bytes_sent.yml index 9c0c422e9..b5c327f6a 100644 --- a/site/data/v2metrics/nginx.http.request.bytes_sent.yml +++ b/site/data/v2metrics/nginx.http.request.bytes_sent.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.request.bytes_sent diff --git a/site/data/v2metrics/nginx.http.request.count.yml b/site/data/v2metrics/nginx.http.request.count.yml index 91a4fa86a..b2a32fb48 100644 --- a/site/data/v2metrics/nginx.http.request.count.yml +++ b/site/data/v2metrics/nginx.http.request.count.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.request.count diff --git a/site/data/v2metrics/nginx.http.request.current.yml b/site/data/v2metrics/nginx.http.request.current.yml index d51fac058..0f4954a83 100644 --- a/site/data/v2metrics/nginx.http.request.current.yml +++ b/site/data/v2metrics/nginx.http.request.current.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.request.current diff --git a/site/data/v2metrics/nginx.http.request.length.yml b/site/data/v2metrics/nginx.http.request.length.yml index 2884d39e5..5e7e453e8 100644 --- a/site/data/v2metrics/nginx.http.request.length.yml +++ b/site/data/v2metrics/nginx.http.request.length.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.request.length diff --git a/site/data/v2metrics/nginx.http.request.malformed.yml b/site/data/v2metrics/nginx.http.request.malformed.yml index 80f5e7338..246d0a66d 100644 --- a/site/data/v2metrics/nginx.http.request.malformed.yml +++ b/site/data/v2metrics/nginx.http.request.malformed.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.request.malformed diff --git a/site/data/v2metrics/nginx.http.request.time.max.yml b/site/data/v2metrics/nginx.http.request.time.max.yml index 7b574cb33..cd6ef0968 100644 --- a/site/data/v2metrics/nginx.http.request.time.max.yml +++ b/site/data/v2metrics/nginx.http.request.time.max.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.request.time.max diff --git a/site/data/v2metrics/nginx.http.request.time.median.yml b/site/data/v2metrics/nginx.http.request.time.median.yml index 64b01db46..90bb7876f 100644 --- a/site/data/v2metrics/nginx.http.request.time.median.yml +++ b/site/data/v2metrics/nginx.http.request.time.median.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.request.time.median diff --git a/site/data/v2metrics/nginx.http.request.time.pctl95.yml b/site/data/v2metrics/nginx.http.request.time.pctl95.yml index 5d8ce546c..1bca844eb 100644 --- a/site/data/v2metrics/nginx.http.request.time.pctl95.yml +++ b/site/data/v2metrics/nginx.http.request.time.pctl95.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.request.time.pctl95 diff --git a/site/data/v2metrics/nginx.http.request.time.yml b/site/data/v2metrics/nginx.http.request.time.yml index 1486f9074..84132ede7 100644 --- a/site/data/v2metrics/nginx.http.request.time.yml +++ b/site/data/v2metrics/nginx.http.request.time.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.request.time diff --git a/site/data/v2metrics/nginx.http.status.1xx.yml b/site/data/v2metrics/nginx.http.status.1xx.yml index e766c7251..7d412b85a 100644 --- a/site/data/v2metrics/nginx.http.status.1xx.yml +++ b/site/data/v2metrics/nginx.http.status.1xx.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.status.1xx diff --git a/site/data/v2metrics/nginx.http.status.2xx.yml b/site/data/v2metrics/nginx.http.status.2xx.yml index e7889ee20..f76fa49e7 100644 --- a/site/data/v2metrics/nginx.http.status.2xx.yml +++ b/site/data/v2metrics/nginx.http.status.2xx.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.status.2xx diff --git a/site/data/v2metrics/nginx.http.status.3xx.yml b/site/data/v2metrics/nginx.http.status.3xx.yml index e5cf8b3a1..d81d1fea2 100644 --- a/site/data/v2metrics/nginx.http.status.3xx.yml +++ b/site/data/v2metrics/nginx.http.status.3xx.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.status.3xx diff --git a/site/data/v2metrics/nginx.http.status.403.yml b/site/data/v2metrics/nginx.http.status.403.yml index 9f4522bfe..df378c000 100644 --- a/site/data/v2metrics/nginx.http.status.403.yml +++ b/site/data/v2metrics/nginx.http.status.403.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.status.403 diff --git a/site/data/v2metrics/nginx.http.status.404.yml b/site/data/v2metrics/nginx.http.status.404.yml index a6a88d508..3a88bff6d 100644 --- a/site/data/v2metrics/nginx.http.status.404.yml +++ b/site/data/v2metrics/nginx.http.status.404.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.status.404 diff --git a/site/data/v2metrics/nginx.http.status.4xx.yml b/site/data/v2metrics/nginx.http.status.4xx.yml index e2284c4d8..a8ce485e9 100644 --- a/site/data/v2metrics/nginx.http.status.4xx.yml +++ b/site/data/v2metrics/nginx.http.status.4xx.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.status.4xx diff --git a/site/data/v2metrics/nginx.http.status.500.yml b/site/data/v2metrics/nginx.http.status.500.yml index f50de3b8b..7cd70bac2 100644 --- a/site/data/v2metrics/nginx.http.status.500.yml +++ b/site/data/v2metrics/nginx.http.status.500.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.status.500 diff --git a/site/data/v2metrics/nginx.http.status.502.yml b/site/data/v2metrics/nginx.http.status.502.yml index a9dca7361..1d25fb99e 100644 --- a/site/data/v2metrics/nginx.http.status.502.yml +++ b/site/data/v2metrics/nginx.http.status.502.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.status.502 diff --git a/site/data/v2metrics/nginx.http.status.503.yml b/site/data/v2metrics/nginx.http.status.503.yml index a63856ed3..d600e4635 100644 --- a/site/data/v2metrics/nginx.http.status.503.yml +++ b/site/data/v2metrics/nginx.http.status.503.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.status.503 diff --git a/site/data/v2metrics/nginx.http.status.504.yml b/site/data/v2metrics/nginx.http.status.504.yml index 4a4462588..d5d1b55f4 100644 --- a/site/data/v2metrics/nginx.http.status.504.yml +++ b/site/data/v2metrics/nginx.http.status.504.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.status.504 diff --git a/site/data/v2metrics/nginx.http.status.5xx.yml b/site/data/v2metrics/nginx.http.status.5xx.yml index f745c216b..e95bd2d77 100644 --- a/site/data/v2metrics/nginx.http.status.5xx.yml +++ b/site/data/v2metrics/nginx.http.status.5xx.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.status.5xx diff --git a/site/data/v2metrics/nginx.http.status.discarded.yml b/site/data/v2metrics/nginx.http.status.discarded.yml index 4227a0903..ddb1fc438 100644 --- a/site/data/v2metrics/nginx.http.status.discarded.yml +++ b/site/data/v2metrics/nginx.http.status.discarded.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.status.discarded diff --git a/site/data/v2metrics/nginx.http.v0_9.yml b/site/data/v2metrics/nginx.http.v0_9.yml index ae4c71365..7e6651b6b 100644 --- a/site/data/v2metrics/nginx.http.v0_9.yml +++ b/site/data/v2metrics/nginx.http.v0_9.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.v0_9 diff --git a/site/data/v2metrics/nginx.http.v1_0.yml b/site/data/v2metrics/nginx.http.v1_0.yml index f8c3310b7..1fbdf5393 100644 --- a/site/data/v2metrics/nginx.http.v1_0.yml +++ b/site/data/v2metrics/nginx.http.v1_0.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.v1_0 diff --git a/site/data/v2metrics/nginx.http.v1_1.yml b/site/data/v2metrics/nginx.http.v1_1.yml index acd2999b6..92b766369 100644 --- a/site/data/v2metrics/nginx.http.v1_1.yml +++ b/site/data/v2metrics/nginx.http.v1_1.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.v1_1 diff --git a/site/data/v2metrics/nginx.http.v2.yml b/site/data/v2metrics/nginx.http.v2.yml index 49b3a567e..4342ef878 100644 --- a/site/data/v2metrics/nginx.http.v2.yml +++ b/site/data/v2metrics/nginx.http.v2.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.http.v2 diff --git a/site/data/v2metrics/nginx.status.yml b/site/data/v2metrics/nginx.status.yml index be0db4c79..8308580e3 100644 --- a/site/data/v2metrics/nginx.status.yml +++ b/site/data/v2metrics/nginx.status.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.status diff --git a/site/data/v2metrics/nginx.upstream.request.failed.yml b/site/data/v2metrics/nginx.upstream.request.failed.yml index 7ea71b3ae..33b24ed29 100644 --- a/site/data/v2metrics/nginx.upstream.request.failed.yml +++ b/site/data/v2metrics/nginx.upstream.request.failed.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.upstream.request.failed diff --git a/site/data/v2metrics/nginx.upstream.response.buffered.yml b/site/data/v2metrics/nginx.upstream.response.buffered.yml index f1475d4d9..950c82151 100644 --- a/site/data/v2metrics/nginx.upstream.response.buffered.yml +++ b/site/data/v2metrics/nginx.upstream.response.buffered.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.upstream.response.buffered diff --git a/site/data/v2metrics/nginx.upstream.response.failed.yml b/site/data/v2metrics/nginx.upstream.response.failed.yml index 9e9b7a4ee..9af5bb87d 100644 --- a/site/data/v2metrics/nginx.upstream.response.failed.yml +++ b/site/data/v2metrics/nginx.upstream.response.failed.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.upstream.response.failed diff --git a/site/data/v2metrics/nginx.workers.count.yml b/site/data/v2metrics/nginx.workers.count.yml index 45e6833cc..2b6a38f09 100644 --- a/site/data/v2metrics/nginx.workers.count.yml +++ b/site/data/v2metrics/nginx.workers.count.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.workers.count diff --git a/site/data/v2metrics/nginx.workers.cpu.system.yml b/site/data/v2metrics/nginx.workers.cpu.system.yml index cda540e07..be1ba0c3d 100644 --- a/site/data/v2metrics/nginx.workers.cpu.system.yml +++ b/site/data/v2metrics/nginx.workers.cpu.system.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.workers.cpu.system diff --git a/site/data/v2metrics/nginx.workers.cpu.total.yml b/site/data/v2metrics/nginx.workers.cpu.total.yml index 8791515c6..ed19900c6 100644 --- a/site/data/v2metrics/nginx.workers.cpu.total.yml +++ b/site/data/v2metrics/nginx.workers.cpu.total.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.workers.cpu.total diff --git a/site/data/v2metrics/nginx.workers.cpu.user.yml b/site/data/v2metrics/nginx.workers.cpu.user.yml index 56e71593b..5c9dabcd3 100644 --- a/site/data/v2metrics/nginx.workers.cpu.user.yml +++ b/site/data/v2metrics/nginx.workers.cpu.user.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.workers.cpu.user diff --git a/site/data/v2metrics/nginx.workers.fds_count.yml b/site/data/v2metrics/nginx.workers.fds_count.yml index 4fd2e2916..b1992f028 100644 --- a/site/data/v2metrics/nginx.workers.fds_count.yml +++ b/site/data/v2metrics/nginx.workers.fds_count.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.workers.fds_count diff --git a/site/data/v2metrics/nginx.workers.io.kbs_r.yml b/site/data/v2metrics/nginx.workers.io.kbs_r.yml index 400d4847e..1c0b6016c 100644 --- a/site/data/v2metrics/nginx.workers.io.kbs_r.yml +++ b/site/data/v2metrics/nginx.workers.io.kbs_r.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.workers.io.kbs_r diff --git a/site/data/v2metrics/nginx.workers.io.kbs_w.yml b/site/data/v2metrics/nginx.workers.io.kbs_w.yml index 52a2d0fa1..06ec297de 100644 --- a/site/data/v2metrics/nginx.workers.io.kbs_w.yml +++ b/site/data/v2metrics/nginx.workers.io.kbs_w.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.workers.io.kbs_w diff --git a/site/data/v2metrics/nginx.workers.mem.rss.yml b/site/data/v2metrics/nginx.workers.mem.rss.yml index 79cdf3171..e1a096486 100644 --- a/site/data/v2metrics/nginx.workers.mem.rss.yml +++ b/site/data/v2metrics/nginx.workers.mem.rss.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.workers.mem.rss diff --git a/site/data/v2metrics/nginx.workers.mem.rss_pct.yml b/site/data/v2metrics/nginx.workers.mem.rss_pct.yml index 464b7e974..a176f54a1 100644 --- a/site/data/v2metrics/nginx.workers.mem.rss_pct.yml +++ b/site/data/v2metrics/nginx.workers.mem.rss_pct.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.workers.mem.rss_pct diff --git a/site/data/v2metrics/nginx.workers.mem.vms.yml b/site/data/v2metrics/nginx.workers.mem.vms.yml index 15da43854..3a90a8bba 100644 --- a/site/data/v2metrics/nginx.workers.mem.vms.yml +++ b/site/data/v2metrics/nginx.workers.mem.vms.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.workers.mem.vms diff --git a/site/data/v2metrics/nginx.workers.rlimit_nofile.yml b/site/data/v2metrics/nginx.workers.rlimit_nofile.yml index 3e2861123..6cf446687 100644 --- a/site/data/v2metrics/nginx.workers.rlimit_nofile.yml +++ b/site/data/v2metrics/nginx.workers.rlimit_nofile.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: nginx.workers.rlimit_nofile diff --git a/site/data/v2metrics/plus.cache.bypass.bytes.yml b/site/data/v2metrics/plus.cache.bypass.bytes.yml index d9fa7fcab..3dc3b4360 100644 --- a/site/data/v2metrics/plus.cache.bypass.bytes.yml +++ b/site/data/v2metrics/plus.cache.bypass.bytes.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.cache.bypass.bytes diff --git a/site/data/v2metrics/plus.cache.bypass.responses.yml b/site/data/v2metrics/plus.cache.bypass.responses.yml index 860c6998c..b8d2af348 100644 --- a/site/data/v2metrics/plus.cache.bypass.responses.yml +++ b/site/data/v2metrics/plus.cache.bypass.responses.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.cache.bypass.responses diff --git a/site/data/v2metrics/plus.cache.expired.bytes.yml b/site/data/v2metrics/plus.cache.expired.bytes.yml index 7c67836a4..56bb7f81d 100644 --- a/site/data/v2metrics/plus.cache.expired.bytes.yml +++ b/site/data/v2metrics/plus.cache.expired.bytes.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.cache.expired.bytes diff --git a/site/data/v2metrics/plus.cache.expired.responses.yml b/site/data/v2metrics/plus.cache.expired.responses.yml index ba65c2042..eef68bdbd 100644 --- a/site/data/v2metrics/plus.cache.expired.responses.yml +++ b/site/data/v2metrics/plus.cache.expired.responses.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.cache.expired.responses diff --git a/site/data/v2metrics/plus.cache.hit.bytes.yml b/site/data/v2metrics/plus.cache.hit.bytes.yml index f298136ae..dedd9fe3a 100644 --- a/site/data/v2metrics/plus.cache.hit.bytes.yml +++ b/site/data/v2metrics/plus.cache.hit.bytes.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.cache.hit.bytes diff --git a/site/data/v2metrics/plus.cache.hit.responses.yml b/site/data/v2metrics/plus.cache.hit.responses.yml index 6d3a337ba..4eed3fe4c 100644 --- a/site/data/v2metrics/plus.cache.hit.responses.yml +++ b/site/data/v2metrics/plus.cache.hit.responses.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.cache.hit.responses diff --git a/site/data/v2metrics/plus.cache.max_size.yml b/site/data/v2metrics/plus.cache.max_size.yml index 7c5e57f4b..efa74b4be 100644 --- a/site/data/v2metrics/plus.cache.max_size.yml +++ b/site/data/v2metrics/plus.cache.max_size.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.cache.max_size diff --git a/site/data/v2metrics/plus.cache.miss.bytes.yml b/site/data/v2metrics/plus.cache.miss.bytes.yml index 12fc487d6..d8d78f84f 100644 --- a/site/data/v2metrics/plus.cache.miss.bytes.yml +++ b/site/data/v2metrics/plus.cache.miss.bytes.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.cache.miss.bytes diff --git a/site/data/v2metrics/plus.cache.miss.responses.yml b/site/data/v2metrics/plus.cache.miss.responses.yml index 5bd128b37..841fc1c2f 100644 --- a/site/data/v2metrics/plus.cache.miss.responses.yml +++ b/site/data/v2metrics/plus.cache.miss.responses.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.cache.miss.responses diff --git a/site/data/v2metrics/plus.cache.revalidated.bytes.yml b/site/data/v2metrics/plus.cache.revalidated.bytes.yml index bd50b4430..75a3d67cb 100644 --- a/site/data/v2metrics/plus.cache.revalidated.bytes.yml +++ b/site/data/v2metrics/plus.cache.revalidated.bytes.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.cache.revalidated.bytes diff --git a/site/data/v2metrics/plus.cache.revalidated.responses.yml b/site/data/v2metrics/plus.cache.revalidated.responses.yml index 30d7fa872..825de05ff 100644 --- a/site/data/v2metrics/plus.cache.revalidated.responses.yml +++ b/site/data/v2metrics/plus.cache.revalidated.responses.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.cache.revalidated.responses diff --git a/site/data/v2metrics/plus.cache.size.yml b/site/data/v2metrics/plus.cache.size.yml index 0baace24d..3f0f3489e 100644 --- a/site/data/v2metrics/plus.cache.size.yml +++ b/site/data/v2metrics/plus.cache.size.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.cache.size diff --git a/site/data/v2metrics/plus.cache.stale.bytes.yml b/site/data/v2metrics/plus.cache.stale.bytes.yml index 65ad39404..0fc24ba97 100644 --- a/site/data/v2metrics/plus.cache.stale.bytes.yml +++ b/site/data/v2metrics/plus.cache.stale.bytes.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.cache.stale.bytes diff --git a/site/data/v2metrics/plus.cache.stale.responses.yml b/site/data/v2metrics/plus.cache.stale.responses.yml index ec02fa896..9970d630c 100644 --- a/site/data/v2metrics/plus.cache.stale.responses.yml +++ b/site/data/v2metrics/plus.cache.stale.responses.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.cache.stale.responses diff --git a/site/data/v2metrics/plus.cache.updating.bytes.yml b/site/data/v2metrics/plus.cache.updating.bytes.yml index 46e9c8acb..f627e43bc 100644 --- a/site/data/v2metrics/plus.cache.updating.bytes.yml +++ b/site/data/v2metrics/plus.cache.updating.bytes.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.cache.updating.bytes diff --git a/site/data/v2metrics/plus.cache.updating.responses.yml b/site/data/v2metrics/plus.cache.updating.responses.yml index ff45b5a34..db5ff85ee 100644 --- a/site/data/v2metrics/plus.cache.updating.responses.yml +++ b/site/data/v2metrics/plus.cache.updating.responses.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.cache.updating.responses diff --git a/site/data/v2metrics/plus.http.limit_conns.passed.yml b/site/data/v2metrics/plus.http.limit_conns.passed.yml index d8eb6be88..7428738f5 100644 --- a/site/data/v2metrics/plus.http.limit_conns.passed.yml +++ b/site/data/v2metrics/plus.http.limit_conns.passed.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.limit_conns.passed diff --git a/site/data/v2metrics/plus.http.limit_conns.rejected.yml b/site/data/v2metrics/plus.http.limit_conns.rejected.yml index fb7ce4d54..3b1fa3645 100644 --- a/site/data/v2metrics/plus.http.limit_conns.rejected.yml +++ b/site/data/v2metrics/plus.http.limit_conns.rejected.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.limit_conns.rejected diff --git a/site/data/v2metrics/plus.http.limit_conns.rejected_dry_run.yml b/site/data/v2metrics/plus.http.limit_conns.rejected_dry_run.yml index d952945b5..3682253e7 100644 --- a/site/data/v2metrics/plus.http.limit_conns.rejected_dry_run.yml +++ b/site/data/v2metrics/plus.http.limit_conns.rejected_dry_run.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.limit_conns.rejected_dry_run diff --git a/site/data/v2metrics/plus.http.limit_reqs.delayed.yml b/site/data/v2metrics/plus.http.limit_reqs.delayed.yml index 6f33f7bcd..f86dde184 100644 --- a/site/data/v2metrics/plus.http.limit_reqs.delayed.yml +++ b/site/data/v2metrics/plus.http.limit_reqs.delayed.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.limit_reqs.delayed diff --git a/site/data/v2metrics/plus.http.limit_reqs.delayed_dry_run.yml b/site/data/v2metrics/plus.http.limit_reqs.delayed_dry_run.yml index 4b08a670c..102fe6abb 100644 --- a/site/data/v2metrics/plus.http.limit_reqs.delayed_dry_run.yml +++ b/site/data/v2metrics/plus.http.limit_reqs.delayed_dry_run.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.limit_reqs.delayed_dry_run diff --git a/site/data/v2metrics/plus.http.limit_reqs.passed.yml b/site/data/v2metrics/plus.http.limit_reqs.passed.yml index 64b277bbb..7e4bec75e 100644 --- a/site/data/v2metrics/plus.http.limit_reqs.passed.yml +++ b/site/data/v2metrics/plus.http.limit_reqs.passed.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.limit_reqs.passed diff --git a/site/data/v2metrics/plus.http.limit_reqs.rejected.yml b/site/data/v2metrics/plus.http.limit_reqs.rejected.yml index 44adb29b8..fd63ce12b 100644 --- a/site/data/v2metrics/plus.http.limit_reqs.rejected.yml +++ b/site/data/v2metrics/plus.http.limit_reqs.rejected.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.limit_reqs.rejected diff --git a/site/data/v2metrics/plus.http.limit_reqs.rejected_dry_run.yml b/site/data/v2metrics/plus.http.limit_reqs.rejected_dry_run.yml index ddc92f861..6cd625716 100644 --- a/site/data/v2metrics/plus.http.limit_reqs.rejected_dry_run.yml +++ b/site/data/v2metrics/plus.http.limit_reqs.rejected_dry_run.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.limit_reqs.rejected_dry_run diff --git a/site/data/v2metrics/plus.http.request.bytes_rcvd.yml b/site/data/v2metrics/plus.http.request.bytes_rcvd.yml index cb0571df8..e56d39ee1 100644 --- a/site/data/v2metrics/plus.http.request.bytes_rcvd.yml +++ b/site/data/v2metrics/plus.http.request.bytes_rcvd.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.request.bytes_rcvd diff --git a/site/data/v2metrics/plus.http.request.bytes_sent.yml b/site/data/v2metrics/plus.http.request.bytes_sent.yml index fcaa5c6d9..49cb8b7eb 100644 --- a/site/data/v2metrics/plus.http.request.bytes_sent.yml +++ b/site/data/v2metrics/plus.http.request.bytes_sent.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.request.bytes_sent diff --git a/site/data/v2metrics/plus.http.request.count.yml b/site/data/v2metrics/plus.http.request.count.yml index d30b1da23..116e9a3c1 100644 --- a/site/data/v2metrics/plus.http.request.count.yml +++ b/site/data/v2metrics/plus.http.request.count.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.request.count diff --git a/site/data/v2metrics/plus.http.response.count.yml b/site/data/v2metrics/plus.http.response.count.yml index 71df6e7d8..b17e81592 100644 --- a/site/data/v2metrics/plus.http.response.count.yml +++ b/site/data/v2metrics/plus.http.response.count.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.response.count diff --git a/site/data/v2metrics/plus.http.status.1xx.yml b/site/data/v2metrics/plus.http.status.1xx.yml index bd8dd88c5..d40516660 100644 --- a/site/data/v2metrics/plus.http.status.1xx.yml +++ b/site/data/v2metrics/plus.http.status.1xx.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.status.1xx diff --git a/site/data/v2metrics/plus.http.status.2xx.yml b/site/data/v2metrics/plus.http.status.2xx.yml index 05269a472..4c0129cad 100644 --- a/site/data/v2metrics/plus.http.status.2xx.yml +++ b/site/data/v2metrics/plus.http.status.2xx.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.status.2xx diff --git a/site/data/v2metrics/plus.http.status.3xx.yml b/site/data/v2metrics/plus.http.status.3xx.yml index 5634f3585..9ffcc73f6 100644 --- a/site/data/v2metrics/plus.http.status.3xx.yml +++ b/site/data/v2metrics/plus.http.status.3xx.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.status.3xx diff --git a/site/data/v2metrics/plus.http.status.4xx.yml b/site/data/v2metrics/plus.http.status.4xx.yml index d7c24b73c..0d1bb4423 100644 --- a/site/data/v2metrics/plus.http.status.4xx.yml +++ b/site/data/v2metrics/plus.http.status.4xx.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.status.4xx diff --git a/site/data/v2metrics/plus.http.status.5xx.yml b/site/data/v2metrics/plus.http.status.5xx.yml index 3e55c6f03..03fc88154 100644 --- a/site/data/v2metrics/plus.http.status.5xx.yml +++ b/site/data/v2metrics/plus.http.status.5xx.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.status.5xx diff --git a/site/data/v2metrics/plus.http.status.discarded.yml b/site/data/v2metrics/plus.http.status.discarded.yml index ba02662e8..003ca2f3d 100644 --- a/site/data/v2metrics/plus.http.status.discarded.yml +++ b/site/data/v2metrics/plus.http.status.discarded.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.status.discarded diff --git a/site/data/v2metrics/plus.http.status.processing.yml b/site/data/v2metrics/plus.http.status.processing.yml index fd0d56919..bec68bc50 100644 --- a/site/data/v2metrics/plus.http.status.processing.yml +++ b/site/data/v2metrics/plus.http.status.processing.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.status.processing diff --git a/site/data/v2metrics/plus.http.upstream.keepalives.yml b/site/data/v2metrics/plus.http.upstream.keepalives.yml index aac0fab87..8778f442e 100644 --- a/site/data/v2metrics/plus.http.upstream.keepalives.yml +++ b/site/data/v2metrics/plus.http.upstream.keepalives.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.upstream.keepalives diff --git a/site/data/v2metrics/plus.http.upstream.peers.bytes_rcvd.yml b/site/data/v2metrics/plus.http.upstream.peers.bytes_rcvd.yml index 31e94c977..f9cf4d53e 100644 --- a/site/data/v2metrics/plus.http.upstream.peers.bytes_rcvd.yml +++ b/site/data/v2metrics/plus.http.upstream.peers.bytes_rcvd.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.upstream.peers.bytes_rcvd diff --git a/site/data/v2metrics/plus.http.upstream.peers.bytes_sent.yml b/site/data/v2metrics/plus.http.upstream.peers.bytes_sent.yml index 48fb3d910..bac53b474 100644 --- a/site/data/v2metrics/plus.http.upstream.peers.bytes_sent.yml +++ b/site/data/v2metrics/plus.http.upstream.peers.bytes_sent.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.upstream.peers.bytes_sent diff --git a/site/data/v2metrics/plus.http.upstream.peers.conn.active.yml b/site/data/v2metrics/plus.http.upstream.peers.conn.active.yml index 9a8ba6b4c..f094ee6d0 100644 --- a/site/data/v2metrics/plus.http.upstream.peers.conn.active.yml +++ b/site/data/v2metrics/plus.http.upstream.peers.conn.active.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.upstream.peers.conn.active diff --git a/site/data/v2metrics/plus.http.upstream.peers.fails.yml b/site/data/v2metrics/plus.http.upstream.peers.fails.yml index 7199b27a6..24751a4fa 100644 --- a/site/data/v2metrics/plus.http.upstream.peers.fails.yml +++ b/site/data/v2metrics/plus.http.upstream.peers.fails.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.upstream.peers.fails diff --git a/site/data/v2metrics/plus.http.upstream.peers.header_time.yml b/site/data/v2metrics/plus.http.upstream.peers.header_time.yml index aa719784c..4cc1b7bb9 100644 --- a/site/data/v2metrics/plus.http.upstream.peers.header_time.yml +++ b/site/data/v2metrics/plus.http.upstream.peers.header_time.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.upstream.peers.header_time diff --git a/site/data/v2metrics/plus.http.upstream.peers.health_checks.checks.yml b/site/data/v2metrics/plus.http.upstream.peers.health_checks.checks.yml index 531a95d92..85b9d4aea 100644 --- a/site/data/v2metrics/plus.http.upstream.peers.health_checks.checks.yml +++ b/site/data/v2metrics/plus.http.upstream.peers.health_checks.checks.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.upstream.peers.health_checks.checks diff --git a/site/data/v2metrics/plus.http.upstream.peers.health_checks.fails.yml b/site/data/v2metrics/plus.http.upstream.peers.health_checks.fails.yml index 3c9950d15..f1ae36751 100644 --- a/site/data/v2metrics/plus.http.upstream.peers.health_checks.fails.yml +++ b/site/data/v2metrics/plus.http.upstream.peers.health_checks.fails.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.upstream.peers.health_checks.fails diff --git a/site/data/v2metrics/plus.http.upstream.peers.health_checks.unhealthy.yml b/site/data/v2metrics/plus.http.upstream.peers.health_checks.unhealthy.yml index f18cb9903..ffea2ed71 100644 --- a/site/data/v2metrics/plus.http.upstream.peers.health_checks.unhealthy.yml +++ b/site/data/v2metrics/plus.http.upstream.peers.health_checks.unhealthy.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.upstream.peers.health_checks.unhealthy diff --git a/site/data/v2metrics/plus.http.upstream.peers.request.count.yml b/site/data/v2metrics/plus.http.upstream.peers.request.count.yml index 02b98b948..b9e7b3db2 100644 --- a/site/data/v2metrics/plus.http.upstream.peers.request.count.yml +++ b/site/data/v2metrics/plus.http.upstream.peers.request.count.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.upstream.peers.request.count diff --git a/site/data/v2metrics/plus.http.upstream.peers.response.count.yml b/site/data/v2metrics/plus.http.upstream.peers.response.count.yml index 5b3c63b13..08c59b2af 100644 --- a/site/data/v2metrics/plus.http.upstream.peers.response.count.yml +++ b/site/data/v2metrics/plus.http.upstream.peers.response.count.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.upstream.peers.response.count diff --git a/site/data/v2metrics/plus.http.upstream.peers.response.time.yml b/site/data/v2metrics/plus.http.upstream.peers.response.time.yml index 7b224f0ec..2d1256c73 100644 --- a/site/data/v2metrics/plus.http.upstream.peers.response.time.yml +++ b/site/data/v2metrics/plus.http.upstream.peers.response.time.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.upstream.peers.response.time diff --git a/site/data/v2metrics/plus.http.upstream.peers.state.checking.yml b/site/data/v2metrics/plus.http.upstream.peers.state.checking.yml index 5fd413552..7279ef32e 100644 --- a/site/data/v2metrics/plus.http.upstream.peers.state.checking.yml +++ b/site/data/v2metrics/plus.http.upstream.peers.state.checking.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.upstream.peers.state.checking diff --git a/site/data/v2metrics/plus.http.upstream.peers.state.down.yml b/site/data/v2metrics/plus.http.upstream.peers.state.down.yml index ca7225619..0315524ba 100644 --- a/site/data/v2metrics/plus.http.upstream.peers.state.down.yml +++ b/site/data/v2metrics/plus.http.upstream.peers.state.down.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.upstream.peers.state.down diff --git a/site/data/v2metrics/plus.http.upstream.peers.state.draining.yml b/site/data/v2metrics/plus.http.upstream.peers.state.draining.yml index b82c55103..b164adfd1 100644 --- a/site/data/v2metrics/plus.http.upstream.peers.state.draining.yml +++ b/site/data/v2metrics/plus.http.upstream.peers.state.draining.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.upstream.peers.state.draining diff --git a/site/data/v2metrics/plus.http.upstream.peers.state.unavail.yml b/site/data/v2metrics/plus.http.upstream.peers.state.unavail.yml index 6498d08cd..2c7c02d6e 100644 --- a/site/data/v2metrics/plus.http.upstream.peers.state.unavail.yml +++ b/site/data/v2metrics/plus.http.upstream.peers.state.unavail.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.upstream.peers.state.unavail diff --git a/site/data/v2metrics/plus.http.upstream.peers.state.unhealthy.yml b/site/data/v2metrics/plus.http.upstream.peers.state.unhealthy.yml index 4adba3d51..a33daa013 100644 --- a/site/data/v2metrics/plus.http.upstream.peers.state.unhealthy.yml +++ b/site/data/v2metrics/plus.http.upstream.peers.state.unhealthy.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.upstream.peers.state.unhealthy diff --git a/site/data/v2metrics/plus.http.upstream.peers.state.up.yml b/site/data/v2metrics/plus.http.upstream.peers.state.up.yml index e71a63e84..bb77c1e81 100644 --- a/site/data/v2metrics/plus.http.upstream.peers.state.up.yml +++ b/site/data/v2metrics/plus.http.upstream.peers.state.up.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.upstream.peers.state.up diff --git a/site/data/v2metrics/plus.http.upstream.peers.status.1xx.yml b/site/data/v2metrics/plus.http.upstream.peers.status.1xx.yml index 263b55e18..487f0009f 100644 --- a/site/data/v2metrics/plus.http.upstream.peers.status.1xx.yml +++ b/site/data/v2metrics/plus.http.upstream.peers.status.1xx.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.upstream.peers.status.1xx diff --git a/site/data/v2metrics/plus.http.upstream.peers.status.2xx.yml b/site/data/v2metrics/plus.http.upstream.peers.status.2xx.yml index 536997311..c6698b28e 100644 --- a/site/data/v2metrics/plus.http.upstream.peers.status.2xx.yml +++ b/site/data/v2metrics/plus.http.upstream.peers.status.2xx.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.upstream.peers.status.2xx diff --git a/site/data/v2metrics/plus.http.upstream.peers.status.3xx.yml b/site/data/v2metrics/plus.http.upstream.peers.status.3xx.yml index 233806b1f..680965911 100644 --- a/site/data/v2metrics/plus.http.upstream.peers.status.3xx.yml +++ b/site/data/v2metrics/plus.http.upstream.peers.status.3xx.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.upstream.peers.status.3xx diff --git a/site/data/v2metrics/plus.http.upstream.peers.status.4xx.yml b/site/data/v2metrics/plus.http.upstream.peers.status.4xx.yml index 7a676eeaa..bea773131 100644 --- a/site/data/v2metrics/plus.http.upstream.peers.status.4xx.yml +++ b/site/data/v2metrics/plus.http.upstream.peers.status.4xx.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.upstream.peers.status.4xx diff --git a/site/data/v2metrics/plus.http.upstream.peers.status.5xx.yml b/site/data/v2metrics/plus.http.upstream.peers.status.5xx.yml index 0c5adec79..e5b557de3 100644 --- a/site/data/v2metrics/plus.http.upstream.peers.status.5xx.yml +++ b/site/data/v2metrics/plus.http.upstream.peers.status.5xx.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.upstream.peers.status.5xx diff --git a/site/data/v2metrics/plus.http.upstream.peers.total.checking.yml b/site/data/v2metrics/plus.http.upstream.peers.total.checking.yml index 07db8ad39..d98bc87dc 100644 --- a/site/data/v2metrics/plus.http.upstream.peers.total.checking.yml +++ b/site/data/v2metrics/plus.http.upstream.peers.total.checking.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.upstream.peers.total.checking diff --git a/site/data/v2metrics/plus.http.upstream.peers.total.down.yml b/site/data/v2metrics/plus.http.upstream.peers.total.down.yml index 865f5c784..be13fdc0f 100644 --- a/site/data/v2metrics/plus.http.upstream.peers.total.down.yml +++ b/site/data/v2metrics/plus.http.upstream.peers.total.down.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.upstream.peers.total.down diff --git a/site/data/v2metrics/plus.http.upstream.peers.total.draining.yml b/site/data/v2metrics/plus.http.upstream.peers.total.draining.yml index e7817345f..24e9f0f14 100644 --- a/site/data/v2metrics/plus.http.upstream.peers.total.draining.yml +++ b/site/data/v2metrics/plus.http.upstream.peers.total.draining.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.upstream.peers.total.draining diff --git a/site/data/v2metrics/plus.http.upstream.peers.total.unavail.yml b/site/data/v2metrics/plus.http.upstream.peers.total.unavail.yml index 318c19527..c2e531a17 100644 --- a/site/data/v2metrics/plus.http.upstream.peers.total.unavail.yml +++ b/site/data/v2metrics/plus.http.upstream.peers.total.unavail.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.upstream.peers.total.unavail diff --git a/site/data/v2metrics/plus.http.upstream.peers.total.unhealthy.yml b/site/data/v2metrics/plus.http.upstream.peers.total.unhealthy.yml index 7fc3c516f..84fc1b563 100644 --- a/site/data/v2metrics/plus.http.upstream.peers.total.unhealthy.yml +++ b/site/data/v2metrics/plus.http.upstream.peers.total.unhealthy.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.upstream.peers.total.unhealthy diff --git a/site/data/v2metrics/plus.http.upstream.peers.total.up.yml b/site/data/v2metrics/plus.http.upstream.peers.total.up.yml index a6d5daa45..55f5c15c6 100644 --- a/site/data/v2metrics/plus.http.upstream.peers.total.up.yml +++ b/site/data/v2metrics/plus.http.upstream.peers.total.up.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.upstream.peers.total.up diff --git a/site/data/v2metrics/plus.http.upstream.peers.unavail.yml b/site/data/v2metrics/plus.http.upstream.peers.unavail.yml index db12ac002..f77838040 100644 --- a/site/data/v2metrics/plus.http.upstream.peers.unavail.yml +++ b/site/data/v2metrics/plus.http.upstream.peers.unavail.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.upstream.peers.unavail diff --git a/site/data/v2metrics/plus.http.upstream.queue.maxsize.yml b/site/data/v2metrics/plus.http.upstream.queue.maxsize.yml index c67dd5219..0046dc980 100644 --- a/site/data/v2metrics/plus.http.upstream.queue.maxsize.yml +++ b/site/data/v2metrics/plus.http.upstream.queue.maxsize.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.upstream.queue.maxsize diff --git a/site/data/v2metrics/plus.http.upstream.queue.overflows.yml b/site/data/v2metrics/plus.http.upstream.queue.overflows.yml index dabb43824..93d63098c 100644 --- a/site/data/v2metrics/plus.http.upstream.queue.overflows.yml +++ b/site/data/v2metrics/plus.http.upstream.queue.overflows.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.upstream.queue.overflows diff --git a/site/data/v2metrics/plus.http.upstream.queue.size.yml b/site/data/v2metrics/plus.http.upstream.queue.size.yml index d984cc411..12550d031 100644 --- a/site/data/v2metrics/plus.http.upstream.queue.size.yml +++ b/site/data/v2metrics/plus.http.upstream.queue.size.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.upstream.queue.size diff --git a/site/data/v2metrics/plus.http.upstream.zombies.yml b/site/data/v2metrics/plus.http.upstream.zombies.yml index f347de438..e035b6831 100644 --- a/site/data/v2metrics/plus.http.upstream.zombies.yml +++ b/site/data/v2metrics/plus.http.upstream.zombies.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.http.upstream.zombies diff --git a/site/data/v2metrics/plus.instance.count.yml b/site/data/v2metrics/plus.instance.count.yml index 1c778d692..2ade09dfb 100644 --- a/site/data/v2metrics/plus.instance.count.yml +++ b/site/data/v2metrics/plus.instance.count.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.instance.count diff --git a/site/data/v2metrics/plus.slab.pages.free.yml b/site/data/v2metrics/plus.slab.pages.free.yml index 387adccb6..b5895c114 100644 --- a/site/data/v2metrics/plus.slab.pages.free.yml +++ b/site/data/v2metrics/plus.slab.pages.free.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.slab.pages.free diff --git a/site/data/v2metrics/plus.slab.pages.pct_used.yml b/site/data/v2metrics/plus.slab.pages.pct_used.yml index 860f03946..b26384e01 100644 --- a/site/data/v2metrics/plus.slab.pages.pct_used.yml +++ b/site/data/v2metrics/plus.slab.pages.pct_used.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.slab.pages.pct_used diff --git a/site/data/v2metrics/plus.slab.pages.total.yml b/site/data/v2metrics/plus.slab.pages.total.yml index c88f89229..371b485ec 100644 --- a/site/data/v2metrics/plus.slab.pages.total.yml +++ b/site/data/v2metrics/plus.slab.pages.total.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.slab.pages.total diff --git a/site/data/v2metrics/plus.slab.pages.used.yml b/site/data/v2metrics/plus.slab.pages.used.yml index 6e71cd921..af4aff40a 100644 --- a/site/data/v2metrics/plus.slab.pages.used.yml +++ b/site/data/v2metrics/plus.slab.pages.used.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.slab.pages.used diff --git a/site/data/v2metrics/plus.ssl.failed.yml b/site/data/v2metrics/plus.ssl.failed.yml index ca97ede9f..170b75672 100644 --- a/site/data/v2metrics/plus.ssl.failed.yml +++ b/site/data/v2metrics/plus.ssl.failed.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.ssl.failed diff --git a/site/data/v2metrics/plus.ssl.handshakes.yml b/site/data/v2metrics/plus.ssl.handshakes.yml index 26ce28bc8..217d022b9 100644 --- a/site/data/v2metrics/plus.ssl.handshakes.yml +++ b/site/data/v2metrics/plus.ssl.handshakes.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.ssl.handshakes diff --git a/site/data/v2metrics/plus.ssl.reuses.yml b/site/data/v2metrics/plus.ssl.reuses.yml index c48e0550f..5d411c55b 100644 --- a/site/data/v2metrics/plus.ssl.reuses.yml +++ b/site/data/v2metrics/plus.ssl.reuses.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.ssl.reuses diff --git a/site/data/v2metrics/plus.stream.bytes_rcvd.yml b/site/data/v2metrics/plus.stream.bytes_rcvd.yml index 8890c273f..0a7fda382 100644 --- a/site/data/v2metrics/plus.stream.bytes_rcvd.yml +++ b/site/data/v2metrics/plus.stream.bytes_rcvd.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.stream.bytes_rcvd diff --git a/site/data/v2metrics/plus.stream.bytes_sent.yml b/site/data/v2metrics/plus.stream.bytes_sent.yml index 8e9712d0a..d54103876 100644 --- a/site/data/v2metrics/plus.stream.bytes_sent.yml +++ b/site/data/v2metrics/plus.stream.bytes_sent.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.stream.bytes_sent diff --git a/site/data/v2metrics/plus.stream.connections.yml b/site/data/v2metrics/plus.stream.connections.yml index b1260b986..718e24020 100644 --- a/site/data/v2metrics/plus.stream.connections.yml +++ b/site/data/v2metrics/plus.stream.connections.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.stream.connections diff --git a/site/data/v2metrics/plus.stream.discarded.yml b/site/data/v2metrics/plus.stream.discarded.yml index f47758e4f..3d685354e 100644 --- a/site/data/v2metrics/plus.stream.discarded.yml +++ b/site/data/v2metrics/plus.stream.discarded.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.stream.discarded diff --git a/site/data/v2metrics/plus.stream.processing.yml b/site/data/v2metrics/plus.stream.processing.yml index 79006fd92..6aa613111 100644 --- a/site/data/v2metrics/plus.stream.processing.yml +++ b/site/data/v2metrics/plus.stream.processing.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.stream.processing diff --git a/site/data/v2metrics/plus.stream.status.2xx.yml b/site/data/v2metrics/plus.stream.status.2xx.yml index c24548ee7..5890f69ca 100644 --- a/site/data/v2metrics/plus.stream.status.2xx.yml +++ b/site/data/v2metrics/plus.stream.status.2xx.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.stream.status.2xx diff --git a/site/data/v2metrics/plus.stream.status.4xx.yml b/site/data/v2metrics/plus.stream.status.4xx.yml index 1cb99bc29..3889cbaa5 100644 --- a/site/data/v2metrics/plus.stream.status.4xx.yml +++ b/site/data/v2metrics/plus.stream.status.4xx.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.stream.status.4xx diff --git a/site/data/v2metrics/plus.stream.status.5xx.yml b/site/data/v2metrics/plus.stream.status.5xx.yml index 1ed6c1811..742a70a9e 100644 --- a/site/data/v2metrics/plus.stream.status.5xx.yml +++ b/site/data/v2metrics/plus.stream.status.5xx.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.stream.status.5xx diff --git a/site/data/v2metrics/plus.stream.status.total.yml b/site/data/v2metrics/plus.stream.status.total.yml index f216ab9b4..2161d927f 100644 --- a/site/data/v2metrics/plus.stream.status.total.yml +++ b/site/data/v2metrics/plus.stream.status.total.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.stream.status.total diff --git a/site/data/v2metrics/plus.stream.upstream.peers.bytes_rcvd.yml b/site/data/v2metrics/plus.stream.upstream.peers.bytes_rcvd.yml index e9dec85e6..c875c6cf7 100644 --- a/site/data/v2metrics/plus.stream.upstream.peers.bytes_rcvd.yml +++ b/site/data/v2metrics/plus.stream.upstream.peers.bytes_rcvd.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.stream.upstream.peers.bytes_rcvd diff --git a/site/data/v2metrics/plus.stream.upstream.peers.bytes_sent.yml b/site/data/v2metrics/plus.stream.upstream.peers.bytes_sent.yml index f33eec38b..9e651db41 100644 --- a/site/data/v2metrics/plus.stream.upstream.peers.bytes_sent.yml +++ b/site/data/v2metrics/plus.stream.upstream.peers.bytes_sent.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.stream.upstream.peers.bytes_sent diff --git a/site/data/v2metrics/plus.stream.upstream.peers.conn.active.yml b/site/data/v2metrics/plus.stream.upstream.peers.conn.active.yml index 3e36f3726..86e990a0c 100644 --- a/site/data/v2metrics/plus.stream.upstream.peers.conn.active.yml +++ b/site/data/v2metrics/plus.stream.upstream.peers.conn.active.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.stream.upstream.peers.conn.active diff --git a/site/data/v2metrics/plus.stream.upstream.peers.conn.count.yml b/site/data/v2metrics/plus.stream.upstream.peers.conn.count.yml index 9de3b74f5..9f2bd4129 100644 --- a/site/data/v2metrics/plus.stream.upstream.peers.conn.count.yml +++ b/site/data/v2metrics/plus.stream.upstream.peers.conn.count.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.stream.upstream.peers.conn.count diff --git a/site/data/v2metrics/plus.stream.upstream.peers.connect_time.yml b/site/data/v2metrics/plus.stream.upstream.peers.connect_time.yml index 8dfc72ba8..96eeeeda2 100644 --- a/site/data/v2metrics/plus.stream.upstream.peers.connect_time.yml +++ b/site/data/v2metrics/plus.stream.upstream.peers.connect_time.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.stream.upstream.peers.connect_time diff --git a/site/data/v2metrics/plus.stream.upstream.peers.fails.yml b/site/data/v2metrics/plus.stream.upstream.peers.fails.yml index efbffbf6f..d0bebf039 100644 --- a/site/data/v2metrics/plus.stream.upstream.peers.fails.yml +++ b/site/data/v2metrics/plus.stream.upstream.peers.fails.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.stream.upstream.peers.fails diff --git a/site/data/v2metrics/plus.stream.upstream.peers.health_checks.checks.yml b/site/data/v2metrics/plus.stream.upstream.peers.health_checks.checks.yml index 4150d33c8..b725f92e2 100644 --- a/site/data/v2metrics/plus.stream.upstream.peers.health_checks.checks.yml +++ b/site/data/v2metrics/plus.stream.upstream.peers.health_checks.checks.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.stream.upstream.peers.health_checks.checks diff --git a/site/data/v2metrics/plus.stream.upstream.peers.health_checks.fails.yml b/site/data/v2metrics/plus.stream.upstream.peers.health_checks.fails.yml index 2833c5f18..2a5f7b159 100644 --- a/site/data/v2metrics/plus.stream.upstream.peers.health_checks.fails.yml +++ b/site/data/v2metrics/plus.stream.upstream.peers.health_checks.fails.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.stream.upstream.peers.health_checks.fails diff --git a/site/data/v2metrics/plus.stream.upstream.peers.health_checks.unhealthy.yml b/site/data/v2metrics/plus.stream.upstream.peers.health_checks.unhealthy.yml index 0a8d726b2..60bc24987 100644 --- a/site/data/v2metrics/plus.stream.upstream.peers.health_checks.unhealthy.yml +++ b/site/data/v2metrics/plus.stream.upstream.peers.health_checks.unhealthy.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.stream.upstream.peers.health_checks.unhealthy diff --git a/site/data/v2metrics/plus.stream.upstream.peers.response.time.yml b/site/data/v2metrics/plus.stream.upstream.peers.response.time.yml index 3def60320..0e2f34c39 100644 --- a/site/data/v2metrics/plus.stream.upstream.peers.response.time.yml +++ b/site/data/v2metrics/plus.stream.upstream.peers.response.time.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.stream.upstream.peers.response.time diff --git a/site/data/v2metrics/plus.stream.upstream.peers.state.checking.yml b/site/data/v2metrics/plus.stream.upstream.peers.state.checking.yml index bb43ca137..dc877310d 100644 --- a/site/data/v2metrics/plus.stream.upstream.peers.state.checking.yml +++ b/site/data/v2metrics/plus.stream.upstream.peers.state.checking.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.stream.upstream.peers.state.checking diff --git a/site/data/v2metrics/plus.stream.upstream.peers.state.down.yml b/site/data/v2metrics/plus.stream.upstream.peers.state.down.yml index b215ed5fe..38a4b12b3 100644 --- a/site/data/v2metrics/plus.stream.upstream.peers.state.down.yml +++ b/site/data/v2metrics/plus.stream.upstream.peers.state.down.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.stream.upstream.peers.state.down diff --git a/site/data/v2metrics/plus.stream.upstream.peers.state.draining.yml b/site/data/v2metrics/plus.stream.upstream.peers.state.draining.yml index c863a4f78..cfe7cafd7 100644 --- a/site/data/v2metrics/plus.stream.upstream.peers.state.draining.yml +++ b/site/data/v2metrics/plus.stream.upstream.peers.state.draining.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.stream.upstream.peers.state.draining diff --git a/site/data/v2metrics/plus.stream.upstream.peers.state.unavail.yml b/site/data/v2metrics/plus.stream.upstream.peers.state.unavail.yml index 0bb68d5cb..01af8552e 100644 --- a/site/data/v2metrics/plus.stream.upstream.peers.state.unavail.yml +++ b/site/data/v2metrics/plus.stream.upstream.peers.state.unavail.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.stream.upstream.peers.state.unavail diff --git a/site/data/v2metrics/plus.stream.upstream.peers.state.unhealthy.yml b/site/data/v2metrics/plus.stream.upstream.peers.state.unhealthy.yml index 9488acfd3..73e92dd69 100644 --- a/site/data/v2metrics/plus.stream.upstream.peers.state.unhealthy.yml +++ b/site/data/v2metrics/plus.stream.upstream.peers.state.unhealthy.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.stream.upstream.peers.state.unhealthy diff --git a/site/data/v2metrics/plus.stream.upstream.peers.state.up.yml b/site/data/v2metrics/plus.stream.upstream.peers.state.up.yml index 2b02f63dd..eab6f3abf 100644 --- a/site/data/v2metrics/plus.stream.upstream.peers.state.up.yml +++ b/site/data/v2metrics/plus.stream.upstream.peers.state.up.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.stream.upstream.peers.state.up diff --git a/site/data/v2metrics/plus.stream.upstream.peers.total.checking.yml b/site/data/v2metrics/plus.stream.upstream.peers.total.checking.yml index c3de6bd03..bbe579a3b 100644 --- a/site/data/v2metrics/plus.stream.upstream.peers.total.checking.yml +++ b/site/data/v2metrics/plus.stream.upstream.peers.total.checking.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.stream.upstream.peers.total.checking diff --git a/site/data/v2metrics/plus.stream.upstream.peers.total.down.yml b/site/data/v2metrics/plus.stream.upstream.peers.total.down.yml index 2ff602ff8..c791ae2e2 100644 --- a/site/data/v2metrics/plus.stream.upstream.peers.total.down.yml +++ b/site/data/v2metrics/plus.stream.upstream.peers.total.down.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.stream.upstream.peers.total.down diff --git a/site/data/v2metrics/plus.stream.upstream.peers.total.draining.yml b/site/data/v2metrics/plus.stream.upstream.peers.total.draining.yml index 65d415fa2..fba16f6eb 100644 --- a/site/data/v2metrics/plus.stream.upstream.peers.total.draining.yml +++ b/site/data/v2metrics/plus.stream.upstream.peers.total.draining.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.stream.upstream.peers.total.draining diff --git a/site/data/v2metrics/plus.stream.upstream.peers.total.unavail.yml b/site/data/v2metrics/plus.stream.upstream.peers.total.unavail.yml index e94621270..294222ccd 100644 --- a/site/data/v2metrics/plus.stream.upstream.peers.total.unavail.yml +++ b/site/data/v2metrics/plus.stream.upstream.peers.total.unavail.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.stream.upstream.peers.total.unavail diff --git a/site/data/v2metrics/plus.stream.upstream.peers.total.unhealthy.yml b/site/data/v2metrics/plus.stream.upstream.peers.total.unhealthy.yml index 1f7bf8c3f..2b5fbff0b 100644 --- a/site/data/v2metrics/plus.stream.upstream.peers.total.unhealthy.yml +++ b/site/data/v2metrics/plus.stream.upstream.peers.total.unhealthy.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.stream.upstream.peers.total.unhealthy diff --git a/site/data/v2metrics/plus.stream.upstream.peers.total.up.yml b/site/data/v2metrics/plus.stream.upstream.peers.total.up.yml index aadce70fc..1c6b48a33 100644 --- a/site/data/v2metrics/plus.stream.upstream.peers.total.up.yml +++ b/site/data/v2metrics/plus.stream.upstream.peers.total.up.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.stream.upstream.peers.total.up diff --git a/site/data/v2metrics/plus.stream.upstream.peers.ttfb.yml b/site/data/v2metrics/plus.stream.upstream.peers.ttfb.yml index 549c56429..ada330b9a 100644 --- a/site/data/v2metrics/plus.stream.upstream.peers.ttfb.yml +++ b/site/data/v2metrics/plus.stream.upstream.peers.ttfb.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.stream.upstream.peers.ttfb diff --git a/site/data/v2metrics/plus.stream.upstream.peers.unavail.yml b/site/data/v2metrics/plus.stream.upstream.peers.unavail.yml index e690f5cef..5ee6409fd 100644 --- a/site/data/v2metrics/plus.stream.upstream.peers.unavail.yml +++ b/site/data/v2metrics/plus.stream.upstream.peers.unavail.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.stream.upstream.peers.unavail diff --git a/site/data/v2metrics/plus.stream.upstream.zombies.yml b/site/data/v2metrics/plus.stream.upstream.zombies.yml index 9b9a3f35a..61ded2950 100644 --- a/site/data/v2metrics/plus.stream.upstream.zombies.yml +++ b/site/data/v2metrics/plus.stream.upstream.zombies.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: plus.stream.upstream.zombies diff --git a/site/data/v2metrics/stream.bytes_rcvd.yml b/site/data/v2metrics/stream.bytes_rcvd.yml index 32b5bfd41..c32893ce6 100644 --- a/site/data/v2metrics/stream.bytes_rcvd.yml +++ b/site/data/v2metrics/stream.bytes_rcvd.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: stream.bytes_rcvd diff --git a/site/data/v2metrics/stream.bytes_sent.yml b/site/data/v2metrics/stream.bytes_sent.yml index 8b556babf..bc854cd50 100644 --- a/site/data/v2metrics/stream.bytes_sent.yml +++ b/site/data/v2metrics/stream.bytes_sent.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: stream.bytes_sent diff --git a/site/data/v2metrics/stream.connection_duration.yml b/site/data/v2metrics/stream.connection_duration.yml index eb79533d6..b284dbe00 100644 --- a/site/data/v2metrics/stream.connection_duration.yml +++ b/site/data/v2metrics/stream.connection_duration.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: stream.connection_duration diff --git a/site/data/v2metrics/stream.connections.yml b/site/data/v2metrics/stream.connections.yml index 6150de3fe..0fca58901 100644 --- a/site/data/v2metrics/stream.connections.yml +++ b/site/data/v2metrics/stream.connections.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: stream.connections diff --git a/site/data/v2metrics/system.cpu.idle.yml b/site/data/v2metrics/system.cpu.idle.yml index b9128f505..aa2e17e37 100644 --- a/site/data/v2metrics/system.cpu.idle.yml +++ b/site/data/v2metrics/system.cpu.idle.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: system.cpu.idle diff --git a/site/data/v2metrics/system.cpu.iowait.yml b/site/data/v2metrics/system.cpu.iowait.yml index 653d3daf1..afbb48dab 100644 --- a/site/data/v2metrics/system.cpu.iowait.yml +++ b/site/data/v2metrics/system.cpu.iowait.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: system.cpu.iowait diff --git a/site/data/v2metrics/system.cpu.stolen.yml b/site/data/v2metrics/system.cpu.stolen.yml index f5f8c4d7c..0ffa1e906 100644 --- a/site/data/v2metrics/system.cpu.stolen.yml +++ b/site/data/v2metrics/system.cpu.stolen.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: system.cpu.stolen diff --git a/site/data/v2metrics/system.cpu.system.yml b/site/data/v2metrics/system.cpu.system.yml index b69a0f3d6..afaf4d9ff 100644 --- a/site/data/v2metrics/system.cpu.system.yml +++ b/site/data/v2metrics/system.cpu.system.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: system.cpu.system diff --git a/site/data/v2metrics/system.cpu.user.yml b/site/data/v2metrics/system.cpu.user.yml index b6a10bac3..fdf7a4687 100644 --- a/site/data/v2metrics/system.cpu.user.yml +++ b/site/data/v2metrics/system.cpu.user.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: system.cpu.user diff --git a/site/data/v2metrics/system.disk.free.yml b/site/data/v2metrics/system.disk.free.yml index 1ed972820..416b58b6e 100644 --- a/site/data/v2metrics/system.disk.free.yml +++ b/site/data/v2metrics/system.disk.free.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: system.disk.free diff --git a/site/data/v2metrics/system.disk.in_use.yml b/site/data/v2metrics/system.disk.in_use.yml index 8eb6836c1..5e4231142 100644 --- a/site/data/v2metrics/system.disk.in_use.yml +++ b/site/data/v2metrics/system.disk.in_use.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: system.disk.in_use diff --git a/site/data/v2metrics/system.disk.total.yml b/site/data/v2metrics/system.disk.total.yml index d5d4e920d..916bc19d7 100644 --- a/site/data/v2metrics/system.disk.total.yml +++ b/site/data/v2metrics/system.disk.total.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: system.disk.total diff --git a/site/data/v2metrics/system.disk.used.yml b/site/data/v2metrics/system.disk.used.yml index a08de3ba9..3459f1312 100644 --- a/site/data/v2metrics/system.disk.used.yml +++ b/site/data/v2metrics/system.disk.used.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: system.disk.used diff --git a/site/data/v2metrics/system.io.iops_r.yml b/site/data/v2metrics/system.io.iops_r.yml index 8e6c868e5..8869e3e76 100644 --- a/site/data/v2metrics/system.io.iops_r.yml +++ b/site/data/v2metrics/system.io.iops_r.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: system.io.iops_r diff --git a/site/data/v2metrics/system.io.iops_w.yml b/site/data/v2metrics/system.io.iops_w.yml index d5abe5dd0..43c9a2327 100644 --- a/site/data/v2metrics/system.io.iops_w.yml +++ b/site/data/v2metrics/system.io.iops_w.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: system.io.iops_w diff --git a/site/data/v2metrics/system.io.kbs_r.yml b/site/data/v2metrics/system.io.kbs_r.yml index eddb1709e..4b86ac82a 100644 --- a/site/data/v2metrics/system.io.kbs_r.yml +++ b/site/data/v2metrics/system.io.kbs_r.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: system.io.kbs_r diff --git a/site/data/v2metrics/system.io.kbs_w.yml b/site/data/v2metrics/system.io.kbs_w.yml index e67cd20f1..2b8a0f164 100644 --- a/site/data/v2metrics/system.io.kbs_w.yml +++ b/site/data/v2metrics/system.io.kbs_w.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: system.io.kbs_w diff --git a/site/data/v2metrics/system.io.wait_r.yml b/site/data/v2metrics/system.io.wait_r.yml index 776ac4efe..015010eb1 100644 --- a/site/data/v2metrics/system.io.wait_r.yml +++ b/site/data/v2metrics/system.io.wait_r.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: system.io.wait_r diff --git a/site/data/v2metrics/system.io.wait_w.yml b/site/data/v2metrics/system.io.wait_w.yml index 4743d45f3..0143cb8c0 100644 --- a/site/data/v2metrics/system.io.wait_w.yml +++ b/site/data/v2metrics/system.io.wait_w.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: system.io.wait_w diff --git a/site/data/v2metrics/system.load.1.yml b/site/data/v2metrics/system.load.1.yml index 3c6e603af..cbeb4cf05 100644 --- a/site/data/v2metrics/system.load.1.yml +++ b/site/data/v2metrics/system.load.1.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: system.load.1 diff --git a/site/data/v2metrics/system.load.15.yml b/site/data/v2metrics/system.load.15.yml index c9a0e051d..34e85577e 100644 --- a/site/data/v2metrics/system.load.15.yml +++ b/site/data/v2metrics/system.load.15.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: system.load.15 diff --git a/site/data/v2metrics/system.load.5.yml b/site/data/v2metrics/system.load.5.yml index 8259d37f3..decaa2358 100644 --- a/site/data/v2metrics/system.load.5.yml +++ b/site/data/v2metrics/system.load.5.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: system.load.5 diff --git a/site/data/v2metrics/system.mem.available.yml b/site/data/v2metrics/system.mem.available.yml index a07dc5d0b..fab6690d4 100644 --- a/site/data/v2metrics/system.mem.available.yml +++ b/site/data/v2metrics/system.mem.available.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: system.mem.available diff --git a/site/data/v2metrics/system.mem.buffered.yml b/site/data/v2metrics/system.mem.buffered.yml index 64d9e6e78..b78024bb2 100644 --- a/site/data/v2metrics/system.mem.buffered.yml +++ b/site/data/v2metrics/system.mem.buffered.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: system.mem.buffered diff --git a/site/data/v2metrics/system.mem.cached.yml b/site/data/v2metrics/system.mem.cached.yml index 20c792f8c..ecc98d132 100644 --- a/site/data/v2metrics/system.mem.cached.yml +++ b/site/data/v2metrics/system.mem.cached.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: system.mem.cached diff --git a/site/data/v2metrics/system.mem.free.yml b/site/data/v2metrics/system.mem.free.yml index 3f2d285ce..84f4335d0 100644 --- a/site/data/v2metrics/system.mem.free.yml +++ b/site/data/v2metrics/system.mem.free.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: system.mem.free diff --git a/site/data/v2metrics/system.mem.pct_used.yml b/site/data/v2metrics/system.mem.pct_used.yml index 26ed65488..d89817c85 100644 --- a/site/data/v2metrics/system.mem.pct_used.yml +++ b/site/data/v2metrics/system.mem.pct_used.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: system.mem.pct_used diff --git a/site/data/v2metrics/system.mem.shared.yml b/site/data/v2metrics/system.mem.shared.yml index b25e38f40..38bce1c36 100644 --- a/site/data/v2metrics/system.mem.shared.yml +++ b/site/data/v2metrics/system.mem.shared.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: system.mem.shared diff --git a/site/data/v2metrics/system.mem.total.yml b/site/data/v2metrics/system.mem.total.yml index 9648cb789..ba9caf467 100644 --- a/site/data/v2metrics/system.mem.total.yml +++ b/site/data/v2metrics/system.mem.total.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: system.mem.total diff --git a/site/data/v2metrics/system.mem.used.all.yml b/site/data/v2metrics/system.mem.used.all.yml index 2cd308ecc..41789a2ca 100644 --- a/site/data/v2metrics/system.mem.used.all.yml +++ b/site/data/v2metrics/system.mem.used.all.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: system.mem.used.all diff --git a/site/data/v2metrics/system.mem.used.yml b/site/data/v2metrics/system.mem.used.yml index 8388bd347..ce6768c83 100644 --- a/site/data/v2metrics/system.mem.used.yml +++ b/site/data/v2metrics/system.mem.used.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: system.mem.used diff --git a/site/data/v2metrics/system.net.bytes_rcvd.yml b/site/data/v2metrics/system.net.bytes_rcvd.yml index 87ebf74c7..c60183e11 100644 --- a/site/data/v2metrics/system.net.bytes_rcvd.yml +++ b/site/data/v2metrics/system.net.bytes_rcvd.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: system.net.bytes_rcvd diff --git a/site/data/v2metrics/system.net.bytes_sent.yml b/site/data/v2metrics/system.net.bytes_sent.yml index e22d5d16a..e098f1cd8 100644 --- a/site/data/v2metrics/system.net.bytes_sent.yml +++ b/site/data/v2metrics/system.net.bytes_sent.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: system.net.bytes_sent diff --git a/site/data/v2metrics/system.net.drops_in.count.yml b/site/data/v2metrics/system.net.drops_in.count.yml index 6cfff9920..95aad9db7 100644 --- a/site/data/v2metrics/system.net.drops_in.count.yml +++ b/site/data/v2metrics/system.net.drops_in.count.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: system.net.drops_in.count diff --git a/site/data/v2metrics/system.net.drops_out.count.yml b/site/data/v2metrics/system.net.drops_out.count.yml index bccaaebc5..a4593ba67 100644 --- a/site/data/v2metrics/system.net.drops_out.count.yml +++ b/site/data/v2metrics/system.net.drops_out.count.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: system.net.drops_out.count diff --git a/site/data/v2metrics/system.net.listen_overflows.yml b/site/data/v2metrics/system.net.listen_overflows.yml index f5877e0ff..ead52a772 100644 --- a/site/data/v2metrics/system.net.listen_overflows.yml +++ b/site/data/v2metrics/system.net.listen_overflows.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: system.net.listen_overflows diff --git a/site/data/v2metrics/system.net.packets_in.count.yml b/site/data/v2metrics/system.net.packets_in.count.yml index 2ba719d7e..502283731 100644 --- a/site/data/v2metrics/system.net.packets_in.count.yml +++ b/site/data/v2metrics/system.net.packets_in.count.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: system.net.packets_in.count diff --git a/site/data/v2metrics/system.net.packets_in.error.yml b/site/data/v2metrics/system.net.packets_in.error.yml index bb3764e5c..c0e14b058 100644 --- a/site/data/v2metrics/system.net.packets_in.error.yml +++ b/site/data/v2metrics/system.net.packets_in.error.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: system.net.packets_in.error diff --git a/site/data/v2metrics/system.net.packets_out.count.yml b/site/data/v2metrics/system.net.packets_out.count.yml index 085ff2090..1a6e44461 100644 --- a/site/data/v2metrics/system.net.packets_out.count.yml +++ b/site/data/v2metrics/system.net.packets_out.count.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: system.net.packets_out.count diff --git a/site/data/v2metrics/system.net.packets_out.error.yml b/site/data/v2metrics/system.net.packets_out.error.yml index ac5f83c60..7f4342576 100644 --- a/site/data/v2metrics/system.net.packets_out.error.yml +++ b/site/data/v2metrics/system.net.packets_out.error.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: system.net.packets_out.error diff --git a/site/data/v2metrics/system.swap.free.yml b/site/data/v2metrics/system.swap.free.yml index 51a4b0240..8b6f99c89 100644 --- a/site/data/v2metrics/system.swap.free.yml +++ b/site/data/v2metrics/system.swap.free.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: system.swap.free diff --git a/site/data/v2metrics/system.swap.pct_free.yml b/site/data/v2metrics/system.swap.pct_free.yml index 9f2413a65..7211c1e66 100644 --- a/site/data/v2metrics/system.swap.pct_free.yml +++ b/site/data/v2metrics/system.swap.pct_free.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: system.swap.pct_free diff --git a/site/data/v2metrics/system.swap.total.yml b/site/data/v2metrics/system.swap.total.yml index 346f8a784..64da68923 100644 --- a/site/data/v2metrics/system.swap.total.yml +++ b/site/data/v2metrics/system.swap.total.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: system.swap.total diff --git a/site/data/v2metrics/system.swap.used.yml b/site/data/v2metrics/system.swap.used.yml index c11071364..ca87fd6e7 100644 --- a/site/data/v2metrics/system.swap.used.yml +++ b/site/data/v2metrics/system.swap.used.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2022 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: system.swap.used diff --git a/site/data/v2metrics/upstream.header.latency.max.yml b/site/data/v2metrics/upstream.header.latency.max.yml index 8e30abd6c..9936dac6a 100644 --- a/site/data/v2metrics/upstream.header.latency.max.yml +++ b/site/data/v2metrics/upstream.header.latency.max.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: upstream.header.latency.max diff --git a/site/data/v2metrics/upstream.network.latency.max.yml b/site/data/v2metrics/upstream.network.latency.max.yml index c42bd1b31..3ddb21326 100644 --- a/site/data/v2metrics/upstream.network.latency.max.yml +++ b/site/data/v2metrics/upstream.network.latency.max.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: upstream.network.latency.max diff --git a/site/data/v2metrics/upstream.response.latency.max.yml b/site/data/v2metrics/upstream.response.latency.max.yml index 2efea01ce..4bf5dd596 100644 --- a/site/data/v2metrics/upstream.response.latency.max.yml +++ b/site/data/v2metrics/upstream.response.latency.max.yml @@ -1,11 +1,3 @@ -# -# Copyright (C) F5 2023 -# All rights reserved. -# -# No part of the software may be reproduced or transmitted in any -# form or by any means, electronic or mechanical, for any purpose, -# without express written permission of F5, Inc. -# --- name: upstream.response.latency.max From d551b0edf50ffbc13b4c4bf8f98f5ecba3d567a2 Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Fri, 23 Aug 2024 15:55:22 +0100 Subject: [PATCH 07/30] feat: Add placeholder document for exporting metrics, update pages This commit adds a placeholder document for exporting metrics, and adds the key template information for how-to documents to the exporting metrics and migrating from v2 to v3 pages. It also cleans up metadata description instances on the folder index pages. --- site/content/_index.md | 6 ++- site/content/changelog.md | 2 +- site/content/configuration/_index.md | 5 ++- site/content/contribute/_index.md | 9 ++-- site/content/export-metrics.md | 43 +++++++++++++++++++ site/content/installation-upgrade/_index.md | 5 ++- .../container-environments/_index.md | 8 ++-- .../installation-upgrade/migrate-v3.md | 41 +++++++++++++++++- .../content/installation-upgrade/uninstall.md | 2 +- site/content/v2/_index.md | 1 + site/content/v2/configuration/_index.md | 7 ++- .../content/v2/installation-upgrade/_index.md | 5 ++- .../container-environments/_index.md | 6 +-- 13 files changed, 112 insertions(+), 28 deletions(-) create mode 100644 site/content/export-metrics.md diff --git a/site/content/_index.md b/site/content/_index.md index be15d6b1b..b3764d916 100644 --- a/site/content/_index.md +++ b/site/content/_index.md @@ -1,4 +1,6 @@ --- title: "NGINX Agent Documentation" -description: "NGINX Agent is a companion daemon for your NGINX Open Source or NGINX Plus instance." ---- \ No newline at end of file +weight: 900 +--- + +NGINX Agent is a companion daemon for your NGINX Open Source or NGINX Plus instance \ No newline at end of file diff --git a/site/content/changelog.md b/site/content/changelog.md index 8da814d0e..114c6d28b 100644 --- a/site/content/changelog.md +++ b/site/content/changelog.md @@ -1,6 +1,6 @@ --- title: "Changelog" -weight: 1200 +weight: 800 toc: true --- diff --git a/site/content/configuration/_index.md b/site/content/configuration/_index.md index a391ae3ea..d11c90b07 100644 --- a/site/content/configuration/_index.md +++ b/site/content/configuration/_index.md @@ -1,5 +1,6 @@ --- title: "Configuration" -description: "Learn how to configure NGINX Agent." weight: 500 ---- \ No newline at end of file +--- + +Learn how to configure NGINX Agent \ No newline at end of file diff --git a/site/content/contribute/_index.md b/site/content/contribute/_index.md index dc79b629a..08f789713 100644 --- a/site/content/contribute/_index.md +++ b/site/content/contribute/_index.md @@ -1,7 +1,6 @@ --- title: "Contribute" -description: "Learn about the NGINX Agent community and contribute to the project." -linkTitle: "Contribute" -menu: docs -weight: "500" ---- \ No newline at end of file +weight: "700" +--- + +Learn about the NGINX Agent community and how to contribute to the project. \ No newline at end of file diff --git a/site/content/export-metrics.md b/site/content/export-metrics.md new file mode 100644 index 000000000..d96433f8c --- /dev/null +++ b/site/content/export-metrics.md @@ -0,0 +1,43 @@ +--- +title: "Export metrics data" +weight: 600 +docs: DOCS-000 +--- + +[//]: # "These are Markdown comments to guide you through document structure." +[//]: # "Remove them as you go, as well as unnecessary sections for this use case." + +## Overview + +[//]: # "Write a description which outlines precisely what this page of instructions will accomplish." +[//]: # "This description, like all instructions, should be direct and imperative." +[//]: # "Avoid ambiguous promises such as 'enables functionality': state precisely what it does." + +--- + +## Before you begin + +[//]: # "List all of the prerequisites for completing this task." +[//]: # "This might be the first page for a reader, so include a link to installation." + +To begin this task, you will require the following: + +- A [working NGINX Agent instance]({{< ref "/installation-upgrade/getting-started.md" >}}). +- +- + + +--- + +## Export metrics data + + +--- + +## See also + +[//]: # "Examples of additional topics users might want to read include:" +[//]: # "Relevant reference information, configuration options and more complex use cases." + +- [OpenTelemetry metrics]({{< ref "/metrics.md" >}}) +- diff --git a/site/content/installation-upgrade/_index.md b/site/content/installation-upgrade/_index.md index 3b231d8eb..db1eae8ab 100644 --- a/site/content/installation-upgrade/_index.md +++ b/site/content/installation-upgrade/_index.md @@ -1,5 +1,6 @@ --- title: "Install and upgrade" -description: "Learn how to install, upgrade, and uninstall NGINX Agent." weight: 400 ---- \ No newline at end of file +--- + +Learn how to install, upgrade, and uninstall NGINX Agent. \ No newline at end of file diff --git a/site/content/installation-upgrade/container-environments/_index.md b/site/content/installation-upgrade/container-environments/_index.md index 6d0a3bf81..899786a91 100644 --- a/site/content/installation-upgrade/container-environments/_index.md +++ b/site/content/installation-upgrade/container-environments/_index.md @@ -1,6 +1,6 @@ --- title: "Container environments" -description: "Learn how to build and run NGINX Agent docker images." -menu: docs -weight: 900 ---- \ No newline at end of file +weight: 700 +--- + +Learn how to build and run NGINX Agent docker images. \ No newline at end of file diff --git a/site/content/installation-upgrade/migrate-v3.md b/site/content/installation-upgrade/migrate-v3.md index 8cc115920..559ead4c1 100644 --- a/site/content/installation-upgrade/migrate-v3.md +++ b/site/content/installation-upgrade/migrate-v3.md @@ -1,5 +1,42 @@ --- title: Migrate from NGINX Agent v2 to v3 -weight: 800 +weight: 900 docs: DOCS-000 ---- \ No newline at end of file +--- + +[//]: # "These are Markdown comments to guide you through document structure." +[//]: # "Remove them as you go, as well as unnecessary sections for this use case." + +## Overview + +[//]: # "Write a description which outlines precisely what this page of instructions will accomplish." +[//]: # "This description, like all instructions, should be direct and imperative." +[//]: # "Avoid ambiguous promises such as 'enables functionality': state precisely what it does." + +--- + +## Before you begin + +[//]: # "List all of the prerequisites for completing this task." +[//]: # "This might be the first page for a reader, so include a link to installation." + +To begin this task, you will require the following: + +- A [working NGINX Agent instance]({{< ref "/installation-upgrade/getting-started.md" >}}). +- +- + +--- + +## Migrate from NGINX Agent v2 to v3 + + +--- + +## See also + +[//]: # "Examples of additional topics users might want to read include:" +[//]: # "Relevant reference information, configuration options and more complex use cases." + +- +- diff --git a/site/content/installation-upgrade/uninstall.md b/site/content/installation-upgrade/uninstall.md index 4e1112a8e..2a18a20b1 100644 --- a/site/content/installation-upgrade/uninstall.md +++ b/site/content/installation-upgrade/uninstall.md @@ -1,7 +1,7 @@ --- title: "Uninstall NGINX Agent package" toc: true -weight: 700 +weight: 600 docs: DOCS-000 --- diff --git a/site/content/v2/_index.md b/site/content/v2/_index.md index 7b760953f..f0138d948 100644 --- a/site/content/v2/_index.md +++ b/site/content/v2/_index.md @@ -1,6 +1,7 @@ --- title: "NGINX Agent v2" description: "NGINX Agent is a companion daemon for your NGINX Open Source or NGINX Plus instance." +weight: 900 cascade: type: agent-v2-migration --- \ No newline at end of file diff --git a/site/content/v2/configuration/_index.md b/site/content/v2/configuration/_index.md index 3d1fdf4e3..cd9db7e49 100644 --- a/site/content/v2/configuration/_index.md +++ b/site/content/v2/configuration/_index.md @@ -1,7 +1,6 @@ --- title: "Configuration" -description: "Learn how to configure NGINX Agent." -linkTitle: "Configuration" weight: "400" -menu: docs ---- \ No newline at end of file +--- + +Learn how to configure NGINX Agent. \ No newline at end of file diff --git a/site/content/v2/installation-upgrade/_index.md b/site/content/v2/installation-upgrade/_index.md index 211fc3e9b..9419e7185 100644 --- a/site/content/v2/installation-upgrade/_index.md +++ b/site/content/v2/installation-upgrade/_index.md @@ -1,6 +1,7 @@ --- title: "Installation and Upgrade" -description: "Learn how to install, upgrade, and uninstall NGINX Agent." menu: docs weight: 300 ---- \ No newline at end of file +--- + +Learn how to install, upgrade, and uninstall NGINX Agent. \ No newline at end of file diff --git a/site/content/v2/installation-upgrade/container-environments/_index.md b/site/content/v2/installation-upgrade/container-environments/_index.md index e2de9f52c..939ba9d18 100644 --- a/site/content/v2/installation-upgrade/container-environments/_index.md +++ b/site/content/v2/installation-upgrade/container-environments/_index.md @@ -1,6 +1,6 @@ --- title: "Container Environments" -description: "Learn how to build and run NGINX Agent docker images." -menu: docs weight: 800 ---- \ No newline at end of file +--- + +Learn how to build and run NGINX Agent docker images. \ No newline at end of file From ee56e0aa10603f227e5d0bc42788e7cb0d595a51 Mon Sep 17 00:00:00 2001 From: nginx-aoife <50101789+nginx-aoife@users.noreply.github.com> Date: Wed, 28 Aug 2024 09:01:56 +0100 Subject: [PATCH 08/30] Update installation-plus.md Fix broken URL --- site/content/installation-upgrade/installation-plus.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/content/installation-upgrade/installation-plus.md b/site/content/installation-upgrade/installation-plus.md index 4069dafc0..acaf20c0d 100644 --- a/site/content/installation-upgrade/installation-plus.md +++ b/site/content/installation-upgrade/installation-plus.md @@ -15,7 +15,7 @@ Learn how to install NGINX Agent from NGINX Plus repository - An NGINX Plus subscription (purchased or trial) - NGINX Plus installed. Once installed, ensure it is running. If you don't have it installed already, follow these steps to install [NGINX Plus](https://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-plus/) -- A [supported operating system and architecture](../technical-specifications/#supported-distributions) +- A [supported operating system and architecture]({{< relref "/technical-specifications.md#supported-distributions" >}}) - `root` privilege - Your credentials to the MyF5 Customer Portal, provided by email from F5, Inc. - Your NGINX Plus certificate and public key (`nginx-repo.crt` and `nginx-repo.key` files), provided by email from F5, Inc. From 3ab72670ef45d03f11c02f03152b04a790caa276 Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Fri, 30 Aug 2024 15:30:47 +0100 Subject: [PATCH 09/30] Bump documentation theme version --- site/go.mod | 2 +- site/go.sum | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/site/go.mod b/site/go.mod index 1675cfcc8..b1614296c 100644 --- a/site/go.mod +++ b/site/go.mod @@ -2,4 +2,4 @@ module github.com/nginx/agent/site go 1.18 -require github.com/nginxinc/nginx-hugo-theme v0.40.8 // indirect +require github.com/nginxinc/nginx-hugo-theme v0.41.14 // indirect diff --git a/site/go.sum b/site/go.sum index bd8c870cc..7db714541 100644 --- a/site/go.sum +++ b/site/go.sum @@ -10,3 +10,7 @@ github.com/nginxinc/nginx-hugo-theme v0.35.0 h1:7XB2GMy6qeJgKEJy9wOS3SYKYpfvLW3/ github.com/nginxinc/nginx-hugo-theme v0.35.0/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M= github.com/nginxinc/nginx-hugo-theme v0.40.8 h1:VtoSAtf9k67tI2jzbLRo0oFBAMHZBUPRh/xV4MYullI= github.com/nginxinc/nginx-hugo-theme v0.40.8/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M= +github.com/nginxinc/nginx-hugo-theme v0.41.9 h1:8TKgjocF95ZSRP0PHkyvk9TyJvwPrdz1k0FB5RfKT3I= +github.com/nginxinc/nginx-hugo-theme v0.41.9/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M= +github.com/nginxinc/nginx-hugo-theme v0.41.14 h1:OraNB01CdMJXufPddvIVt6qn6Mj38Z/XCVIWBgVtuY0= +github.com/nginxinc/nginx-hugo-theme v0.41.14/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M= From 001720b687b2f26ef00b8d1d60ae870dc1b1b849 Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Tue, 3 Sep 2024 16:38:42 +0100 Subject: [PATCH 10/30] Update Makefile and README This commit updates the documentation Makefile and README, reflecting changes to it across NGINX's open source repositories for consistency. It removes unnecessary targets: Netlify is no longer used, nor was the Makefile used for Netlify for quite some time. The guidance for Makefile targets in the README is updated accordingly, as well formatting instructions for how we use Hugo contemporaneously. --- site/Makefile | 67 +++++++++++++++++++++++++++++ site/README.md | 114 ++++++++++++++++++++++++++++--------------------- site/go.sum | 14 ------ site/makefile | 94 ---------------------------------------- 4 files changed, 133 insertions(+), 156 deletions(-) create mode 100644 site/Makefile delete mode 100644 site/makefile diff --git a/site/Makefile b/site/Makefile new file mode 100644 index 000000000..6b980f156 --- /dev/null +++ b/site/Makefile @@ -0,0 +1,67 @@ +HUGO?=hugo +HUGO_IMG?=hugomods/hugo:0.115.3 + +THEME_MODULE = github.com/nginxinc/nginx-hugo-theme +THEME_VERSION = 0.41.14 + +ifeq (, $(shell ${HUGO} version 2> /dev/null)) +ifeq (, $(shell docker version 2> /dev/null)) + $(error Docker and Hugo are not installed. Hugo (<0.91) or Docker are required to build the local preview.) +else + HUGO=docker run --rm -it -v ${CURDIR}:/src -p 1313:1313 ${HUGO_IMG} hugo --bind 0.0.0.0 -p 1313 +endif +endif + +MARKDOWNLINT?=markdownlint +MARKDOWNLINT_IMG?=ghcr.io/igorshubovych/markdownlint-cli:latest + +ifeq (, $(shell ${MARKDOWNLINT} version 2> /dev/null)) +ifeq (, $(shell docker version 2> /dev/null)) +ifneq (, $(shell $(NETLIFY) "true")) + $(error Docker and markdownlint are not installed. markdownlint or Docker are required to lint.) +endif +else + MARKDOWNLINT=docker run --rm -i -v ${CURDIR}:/src --workdir /src ${MARKDOWNLINT_IMG} +endif +endif + +MARKDOWNLINKCHECK?=markdown-link-check +MARKDOWNLINKCHECK_IMG?=ghcr.io/tcort/markdown-link-check:stable + +ifeq (, $(shell ${MARKDOWNLINKCHECK} --version 2> /dev/null)) +ifeq (, $(shell docker version 2> /dev/null)) +ifneq (, $(shell $(NETLIFY) "true")) + $(error Docker and markdown-link-check are not installed. markdown-link-check or Docker are required to check links.) +endif +else + MARKDOWNLINKCHECK=docker run --rm -it -v ${CURDIR}:/docs --workdir /docs ${MARKDOWNLINKCHECK_IMG} +endif +endif + +.PHONY: docs docs-draft docs-local clean hugo-get hugo-tidy lint-markdown link-check + +docs: + ${HUGO} + +watch: + ${HUGO} --bind 0.0.0.0 -p 1313 server --disableFastRender + +drafts: + ${HUGO} --bind 0.0.0.0 -p 1313 server -D --disableFastRender + +clean: + [ -d "public" ] && rm -rf "public" + +hugo-get: + hugo mod get $(THEME_MODULE)@v$(THEME_VERSION) + +hugo-tidy: + hugo mod tidy + +hugo-update: hugo-get hugo-tidy + +lint-markdown: + ${MARKDOWNLINT} -c .markdownlint.yaml -- content + +link-check: + ${MARKDOWNLINKCHECK} $(shell find content -name '*.md') \ No newline at end of file diff --git a/site/README.md b/site/README.md index 4b313bd1a..0e771c2de 100644 --- a/site/README.md +++ b/site/README.md @@ -1,14 +1,14 @@ -# NGINX Agent Docs +# NGINX Agent Documentation This directory contains all of the user documentation for NGINX Agent, as well as the requirements for linting, building, and publishing the documentation. -Docs are written in Markdown. We build the docs using [Hugo](https://gohugo.io). Previews and deployments are handled by the [docs-actions](https://github.com/nginxinc/docs-actions?tab=readme-ov-file#docs-actions) workflow. +We write our documentation in Markdown. We build it with [Hugo](https://gohugo.io) and our custom [NGINX Hugo theme](https://github.com/nginxinc/nginx-hugo-theme). We set up previews and deployments using our [docs-actions](https://github.com/nginxinc/docs-actions?tab=readme-ov-file#docs-actions) workflow. ## Setup 1. To install Hugo locally, refer to the [Hugo installation instructions](https://gohugo.io/getting-started/installing/). - > **NOTE**: We are currently running [Hugo v0.115.3](https://github.com/gohugoio/hugo/releases/tag/v0.115.3) in production. + > **Note**: We currently use [Hugo v0.115.3](https://github.com/gohugoio/hugo/releases/tag/v0.115.3) in production. 2. We use markdownlint to check that Markdown files are correct. Use `npm` to install markdownlint-cli: @@ -16,32 +16,37 @@ Docs are written in Markdown. We build the docs using [Hugo](https://gohugo.io). npm install -g markdownlint-cli ``` -## Local Docs Development +## Develop documentation locally -To build the docs locally, run the desired `make` command from the docs directory: +To build the docs locally, use the `make` command in the documentation folder with these targets: ```text -make clean - removes the local `public` directory, which is the default output path used by Hugo -make docs - runs a local hugo server so you can view docs in your browser while you work -make hugo-mod - cleans the Hugo module cache and fetches the latest version of the theme module -make docs-drafts - runs the local hugo server and includes all docs marked with `draft: true` +make docs - Builds the documentation +make watch - Runs a local Hugo server to automatically preview changes +make drafts - Runs a local Hugo server, and displays documentation marked as drafts +make clean - Removes the output 'public' directory created by Hugo +make hugo-get - Updates the go module file with the latest version of the theme +make hugo-tidy - Removes unnecessary dependencies from the go module file +make hugo-update - Runs the hugo-get and hugo-tidy targets in sequence +make lint-markdown - Runs markdownlint on the content folder +make link-check - Runs markdown-link-check on all Markdown files ``` ## Linting -- To run the markdownlint check, run the following command from the docs directory: +- To use markdownlint, use the following command in the documentation directory: ```bash markdownlint -c docs/mdlint_conf.json content ``` - Note: You can run this tool on an entire directory or on an individual file. + > **Note**: You can run this tool on an entire directory or on an individual file. -## Add new docs +## Add new documentation -### Generate a new doc file using Hugo +### Generate a new documentation file using Hugo -To create a new doc file that contains all of the pre-configured Hugo front-matter and the docs task template, **run the following command in the docs directory**: +To create a new documentation file containing the pre-configured Hugo front-matter with the task template, **run the following command in the documentation directory**: `hugo new /.` @@ -51,7 +56,7 @@ For example: hugo new getting-started/install.md ``` -The default template -- task -- should be used for most docs. To create docs using the other content templates, you can use the `--kind` flag: +The default template -- task -- should be used for most documentation. To create documentation using the other content templates, you can use the `--kind` flag: ```shell hugo new tutorials/deploy.md --kind tutorial @@ -65,52 +70,63 @@ The available content types (`kind`) are: - troubleshooting: Helps a customer solve a specific problem. - openapi: Contains front-matter and shortcode for rendering an openapi.yaml spec -## How to format docs +## Documentation formatting -### How to format internal links +### Basic markdown formatting -Format links as [Hugo refs](https://gohugo.io/content-management/cross-references/). +There are multiple ways to format text: for consistency and clarity, these are our conventions: -- File extensions are optional. -- You can use relative paths or just the filename. (**Paths without a leading / are first resolved relative to the current page, then to the remainder of the site.**) -- Anchors are supported. +- Bold: Two asterisks on each side - `**Bolded text**`. +- Italic: One underscore on each side - `_Italicized text_`. +- Unordered lists: One dash - `- Unordered list item`. +- Ordered lists: The 1 character followed by a stop - `1. Ordered list item`. -For example: +> **Note**: The ordered notation automatically enumerates lists when built by Hugo. -```md -To install , refer to the [installation instructions]({{< ref "install" >}}). -``` +Close every section with a horizontal line by using three dashes: `---`. + +### How to format internal links -### How to include images +Internal links should use Hugo [ref and relref shortcodes](https://gohugo.io/content-management/cross-references/). -You can use the `img` [shortcode](#how-to-use-hugo-shortcodes) to add images into your documentation. +- Although file extensions are optional for Hugo, we include them as best practice for page anchors. +- Relative paths are preferred, but just the filename is permissible. +- Paths without a leading forward slash (`/`) are first resolved relative to the current page, then the remainder of the website. -1. Add the image to the static/img directory, or to the same directory as the doc you want to use it in. +Here are two examples: - - **DO NOT include a forward slash at the beginning of the file path.** This will break the image when it's rendered. - See the docs for the [Hugo relURL Function](https://gohugo.io/functions/relurl/#input-begins-with-a-slash) to learn more. +```md +To install , refer to the [installation instructions]({{< ref "install.md" >}}). +To install , refer to the [integration instructions]({{< relref "/integration/thing.md#section" >}}). +``` -1. Add the img shortcode: +### How to add images - {{< img src="" >}} +Use the `img` [shortcode](#using-hugo-shortcodes) to add images into your documentation. -> Note: The shortcode accepts all of the same parameters as the [Hugo figure shortcode](https://gohugo.io/content-management/shortcodes/#figure). +1. Add the image to the `/static/img` directory. +1. Add the `img` shortcode: + `{{< img src="" >}}` + - **Do not include a forward slash at the beginning of the file path.** + - This will break the image when it's rendered: read about the [Hugo relURL Function](https://gohugo.io/functions/relurl/#input-begins-with-a-slash) to learn more. -### How to use Hugo shortcodes +> **Note**: The `img` shortcode accepts all of the same parameters as the Hugo [figure shortcode](https://gohugo.io/content-management/shortcodes/#figure). -You can use [Hugo shortcodes](/docs/themes/f5-hugo/layouts/shortcodes/) to do things like format callouts, add images, and reuse content across different docs. +### Using Hugo shortcodes -For example, to use the note callout: +[Hugo shortcodes](https://github.com/nginxinc/nginx-hugo-theme/tree/main/layouts/shortcodes) are used to format callouts, add images, and reuse content across different pages. + +For example, to use the `note` callout: ```md -{{< note >}}Provide the text of the note here. {{< /note >}} +{{< note >}}Provide the text of the note here.{{< /note >}} ``` -The callout shortcodes also support multi-line blocks: +The callout shortcodes support multi-line blocks: ```md {{< caution >}} -You should probably never do this specific thing in a production environment. +You should probably never do this specific thing in a production environment. If you do, and things break, don't say we didn't warn you. {{< /caution >}} @@ -125,12 +141,14 @@ Supported callouts: - `tip` - `warning` -A few more fun shortcodes: - -- `fa`: inserts a Font Awesome icon -- `img`: include an image and define things like alt text and dimensions -- `include`: include the content of a file in another file; the included file must be present in the content/includes directory -- `link`: makes it possible to link to a file and prepend the path with the Hugo baseUrl -- `openapi`: loads an OpenAPI spec and renders as HTML using ReDoc -- `raw-html`: makes it possible to include a block of raw HTML -- `readfile`: includes the content of another file in the current file; does not require the included file to be in a specific location +Here are some other shortcodes: + +- `fa`: Inserts a Font Awesome icon +- `collapse`: Make a section collapsible +- `tab`: Create mutually exclusive tabbed window panes, useful for parallel instructions +- `table`: Add scrollbars to wide tables for browsers with smaller viewports +- `link`: Link to a file, prepending its path with the Hugo baseUrl +- `openapi`: Loads an OpenAPI specifcation and render it as HTML using ReDoc +- `include`: Include the content of a file in another file; the included file must be present in the '/content/includes/' directory +- `raw-html`: Include a block of raw HTML +- `readfile`: Include the content of another file in the current file, which can be in an arbitrary location. \ No newline at end of file diff --git a/site/go.sum b/site/go.sum index 7db714541..1cbbb6618 100644 --- a/site/go.sum +++ b/site/go.sum @@ -1,16 +1,2 @@ -github.com/nginxinc/nginx-hugo-theme v0.28.0 h1:RHHvBmFk2Uptk+efLPSIuBd2elc3IOZPElkJbkkpAHo= -github.com/nginxinc/nginx-hugo-theme v0.28.0/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M= -github.com/nginxinc/nginx-hugo-theme v0.33.0 h1:6mZdgxf5kNhInsrAXXiSlWXRy3fsP51lWKOdrvmkR6U= -github.com/nginxinc/nginx-hugo-theme v0.33.0/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M= -github.com/nginxinc/nginx-hugo-theme v0.34.0-alpha h1:8tKWnkhxP5Nk0V64v8rE9T3crusycohXl3wmOWc4uFk= -github.com/nginxinc/nginx-hugo-theme v0.34.0-alpha/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M= -github.com/nginxinc/nginx-hugo-theme v0.34.0 h1:G7LPVq7w1ls6IS4+OkTwjhFb67rLCzPdfZvW1/sn2Cw= -github.com/nginxinc/nginx-hugo-theme v0.34.0/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M= -github.com/nginxinc/nginx-hugo-theme v0.35.0 h1:7XB2GMy6qeJgKEJy9wOS3SYKYpfvLW3/H+UHRPLM4FU= -github.com/nginxinc/nginx-hugo-theme v0.35.0/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M= -github.com/nginxinc/nginx-hugo-theme v0.40.8 h1:VtoSAtf9k67tI2jzbLRo0oFBAMHZBUPRh/xV4MYullI= -github.com/nginxinc/nginx-hugo-theme v0.40.8/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M= -github.com/nginxinc/nginx-hugo-theme v0.41.9 h1:8TKgjocF95ZSRP0PHkyvk9TyJvwPrdz1k0FB5RfKT3I= -github.com/nginxinc/nginx-hugo-theme v0.41.9/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M= github.com/nginxinc/nginx-hugo-theme v0.41.14 h1:OraNB01CdMJXufPddvIVt6qn6Mj38Z/XCVIWBgVtuY0= github.com/nginxinc/nginx-hugo-theme v0.41.14/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M= diff --git a/site/makefile b/site/makefile deleted file mode 100644 index 849a80b0f..000000000 --- a/site/makefile +++ /dev/null @@ -1,94 +0,0 @@ -HUGO?=hugo -HUGO_IMG?=hugomods/hugo:0.115.3 - -THEME_MODULE = github.com/nginxinc/nginx-hugo-theme -## Pulls the current theme version from the Netlify settings -THEME_VERSION = $(NGINX_THEME_VERSION) - -# if there's no local hugo, fallback to docker -ifeq (, $(shell ${HUGO} version 2> /dev/null)) -ifeq (, $(shell docker version 2> /dev/null)) - $(error Docker and Hugo are not installed. Hugo (<0.91) or Docker are required to build the local preview.) -else - HUGO=docker run --rm -it -v ${CURDIR}:/src -p 1313:1313 ${HUGO_IMG} hugo --bind 0.0.0.0 -p 1313 -endif -endif - -MARKDOWNLINT?=markdownlint -MARKDOWNLINT_IMG?=ghcr.io/igorshubovych/markdownlint-cli:latest - -# if there's no local markdownlint, fallback to docker -ifeq (, $(shell ${MARKDOWNLINT} version 2> /dev/null)) -ifeq (, $(shell docker version 2> /dev/null)) -ifneq (, $(shell $(NETLIFY) "true")) - $(error Docker and markdownlint are not installed. markdownlint or Docker are required to lint.) -endif -else - MARKDOWNLINT=docker run --rm -i -v ${CURDIR}:/src --workdir /src ${MARKDOWNLINT_IMG} -endif -endif - -MARKDOWNLINKCHECK?=markdown-link-check -MARKDOWNLINKCHECK_IMG?=ghcr.io/tcort/markdown-link-check:stable -# if there's no local markdown-link-check, fallback to docker -ifeq (, $(shell ${MARKDOWNLINKCHECK} --version 2> /dev/null)) -ifeq (, $(shell docker version 2> /dev/null)) -ifneq (, $(shell $(NETLIFY) "true")) - $(error Docker and markdown-link-check are not installed. markdown-link-check or Docker are required to check links.) -endif -else - MARKDOWNLINKCHECK=docker run --rm -it -v ${CURDIR}:/docs --workdir /docs ${MARKDOWNLINKCHECK_IMG} -endif -endif - -.PHONY: all clean hugo-mod all-staging all-dev hugo-server-drafts hugo-server netlify deploy-preview - -# Removes the public directory generated by the `hugo` command -clean: - if [[ -d ${PWD}/public ]] ; then rm -rf ${PWD}/public && echo "Removed public directory" ; else echo "Did not find a public directory to remove" ; fi - -hugo-mod: - hugo mod get $(THEME_MODULE)@v$(THEME_VERSION) - -# Builds using the Hugo "production" environment -# For deploys to docs.nginx.com only -all: hugo-mod - hugo --gc -e production - -# Builds using the Hugo "staging" environment -# For deploys to docs-staging.nginx.com only -all-staging: hugo-mod - hugo --gc -e staging - -# Builds using the Hugo "development" environment -# For deploys to docs-dev.nginx.com only -all-dev: hugo-mod - hugo --gc -e development - -# Runs the Hugo server with content marked as draft -# Serves docs at localhost:1313 -docs-drafts: - ${HUGO} server -D --disableFastRender - -docs-local: clean - ${HUGO} - -# Runs the Hugo server -# Serves docs at localhost:1313 -docs: - ${HUGO} server --disableFastRender - -lint-markdown: - ${MARKDOWNLINT} -c .markdownlint.yaml -- content - -link-check: - ${MARKDOWNLINKCHECK} $(shell find content -name '*.md') - -# Can be used to deploy to netlify from your local -# development environment. -# Requires a netlify login. -netlify: clean - netlify deploy --build -d public --alias $(shell git branch --show-current)-branch - -deploy-preview: hugo-mod - hugo --gc -b ${NETLIFY_DEPLOY_URL}/nginx-agent From 248f72121f1c8bab9b79da87d9aeb3eeb719b9f5 Mon Sep 17 00:00:00 2001 From: Jack Hickey <133868041+nginx-jack@users.noreply.github.com> Date: Tue, 17 Sep 2024 15:45:10 +0100 Subject: [PATCH 11/30] Cherry-pick bump docs-action to v1.0.5 --- .github/workflows/docs-build-push.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs-build-push.yml b/.github/workflows/docs-build-push.yml index ec799ae8c..0469d9b32 100644 --- a/.github/workflows/docs-build-push.yml +++ b/.github/workflows/docs-build-push.yml @@ -23,7 +23,7 @@ permissions: jobs: call-docs-build-push: - uses: nginxinc/docs-actions/.github/workflows/docs-build-push.yml@03a9a3808fcb77cd0c19d7fa5d59b25565dd1d6d # v1.0.2 + uses: nginxinc/docs-actions/.github/workflows/docs-build-push.yml@f88844356d32c94be057b60033b3a933bebabf77 # v1.0.5 permissions: pull-requests: write # needed to write preview url comment to PR contents: read From 2367482f6425289712fe60e630ccbfe2fdeb0bd9 Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Mon, 23 Sep 2024 15:41:25 +0100 Subject: [PATCH 12/30] Combine installation guides into one document, update links This commit combines all of the install guides into a singular document and updates a few subsequently broken links. There are some peripheral documentation changes to improve the general user flow. --- .../contribute/dev-environment-setup.md | 2 +- .../container-environments/_index.md | 2 +- .../installation-upgrade/getting-started.md | 43 +- .../{installation-plus.md => install.md} | 426 +++++++++++++++--- .../installation-github.md | 49 -- .../installation-upgrade/installation-oss.md | 348 -------------- .../installation-upgrade/migrate-v3.md | 2 +- .../content/installation-upgrade/uninstall.md | 4 +- site/content/installation-upgrade/upgrade.md | 6 +- 9 files changed, 399 insertions(+), 483 deletions(-) rename site/content/installation-upgrade/{installation-plus.md => install.md} (50%) delete mode 100644 site/content/installation-upgrade/installation-github.md delete mode 100644 site/content/installation-upgrade/installation-oss.md diff --git a/site/content/contribute/dev-environment-setup.md b/site/content/contribute/dev-environment-setup.md index f756ef7fc..2fdbb67ae 100644 --- a/site/content/contribute/dev-environment-setup.md +++ b/site/content/contribute/dev-environment-setup.md @@ -18,7 +18,7 @@ While most Linux or FreeBSD operating systems can be used to contribute to the N ## Install NGINX -Follow the steps in the [Installation]({{< relref "/installation-upgrade/installation-github.md" >}}) section to download, install, and run NGINX and NGINX Agent. +Follow the steps in the [Installation]({{< relref "/installation-upgrade/" >}}) section to download, install, and run NGINX and NGINX Agent. ## Clone the NGINX Agent Repository diff --git a/site/content/installation-upgrade/container-environments/_index.md b/site/content/installation-upgrade/container-environments/_index.md index 899786a91..77393ca9b 100644 --- a/site/content/installation-upgrade/container-environments/_index.md +++ b/site/content/installation-upgrade/container-environments/_index.md @@ -1,6 +1,6 @@ --- title: "Container environments" -weight: 700 +weight: 500 --- Learn how to build and run NGINX Agent docker images. \ No newline at end of file diff --git a/site/content/installation-upgrade/getting-started.md b/site/content/installation-upgrade/getting-started.md index 0e453618b..84f473a09 100644 --- a/site/content/installation-upgrade/getting-started.md +++ b/site/content/installation-upgrade/getting-started.md @@ -1,21 +1,25 @@ --- title: "Getting started" toc: true -weight: 100 +weight: 200 docs: DOCS-000 --- ## Overview -Follow these steps to configure and run NGINX Agent and a mock interface ("control plane") to which NGINX Agent will report. +This document describes how to configure and run NGINX Agent using a mock interface ("control plane") for NGINX Agent to report to. ## Install NGINX -Follow the steps in the [Installation]({{< relref "/installation-upgrade/installation-github.md" >}}) section to download, install, and run NGINX. +Follow the [Install NGINX Agent]({{< relref "/installation-upgrade/" >}}) topic to download and install NGINX Agent. ## Clone the NGINX Agent repository -Using your preferred method, clone the NGINX Agent repository into your development directory. See [Cloning a GitHub Repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) for additional help. +```shell +git clone git@github.com:nginx/agent.git +``` + +Read [Cloning a GitHub Repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) for more information ## Install Go @@ -98,28 +102,15 @@ To launch the Swagger UI for the REST interface run the following command: make launch-swagger-ui ``` -## Extensions - -An extension is a piece of code, not critical to the main functionality that NGINX agent is responsible for. This generally falls outside the remit of managing NGINX Configuration and reporting NGINX metrics. - -To enable an extension, it must be added to the extensions list in the `/etc/nginx-agent/nginx-agent.conf`. -Here is an example of enabling the advanced metrics extension: - -```yaml -extensions: - - advanced-metrics -``` +## Apply new NGINX Agent configuration -## Start NGINX Agent - -If already running, restart NGINX Agent to apply the new configuration. Alternatively, if NGINX Agent is not running, you may run it from the source code root directory. +Start or restart NGINX Agent to apply the new configuration. Open another terminal window and start NGINX Agent. Issue the following command from the `agent` source code root directory. ```shell sudo make run ``` - ```text WARN[0000] Log level is info INFO[0000] setting displayName to XXX @@ -153,7 +144,7 @@ Open a web browser to view the mock control plane at [http://localhost:54790](ht For more NGINX Agent use cases, refer to the [NGINX Agent SDK examples](https://github.com/nginx/agent/tree/main/sdk/examples). -## Start and enable start on boot +## systemd environments To start NGINX Agent on `systemd` systems, run the following command: @@ -176,3 +167,15 @@ Without log rotation or storage on a separate partition, log files could use up For more information, see [NGINX Agent Log Rotation]({{< relref "configuration/configuration-overview.md#nginx-agent-log-rotation" >}}). {{< /important >}} + +## Extensions + +An extension is a piece of code, not critical to the main functionality that NGINX agent is responsible for. This generally falls outside the remit of managing NGINX Configuration and reporting NGINX metrics. + +To enable an extension, it must be added to the extensions list in the `/etc/nginx-agent/nginx-agent.conf`. +Here is an example of enabling the advanced metrics extension: + +```yaml +extensions: + - advanced-metrics +``` \ No newline at end of file diff --git a/site/content/installation-upgrade/installation-plus.md b/site/content/installation-upgrade/install.md similarity index 50% rename from site/content/installation-upgrade/installation-plus.md rename to site/content/installation-upgrade/install.md index acaf20c0d..6b777f011 100644 --- a/site/content/installation-upgrade/installation-plus.md +++ b/site/content/installation-upgrade/install.md @@ -1,26 +1,337 @@ --- -title: "Installation from NGINX Plus repository" +title: Install NGINX Agent toc: true -weight: 400 +weight: 100 docs: DOCS-000 --- -## Overview +This document describes the three main ways to install NGINX agent: -Learn how to install NGINX Agent from NGINX Plus repository +- Using the NGINX Open Source repository +- Using the NGINX Plus repository +- Using the GitHub package files ## Before you begin -### Prerequisites +There are a few prerequisites shared between all installation methods: -- An NGINX Plus subscription (purchased or trial) -- NGINX Plus installed. Once installed, ensure it is running. If you don't have it installed already, follow these steps to install [NGINX Plus](https://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-plus/) -- A [supported operating system and architecture]({{< relref "/technical-specifications.md#supported-distributions" >}}) +- A [supported operating system and architecture](../technical-specifications/#supported-distributions) - `root` privilege + +## NGINX Open Source repository + +Before you install NGINX Agent, you must install and run NGINX. + +If you don't have it installed already, read the [Installing NGINX Open Source +](https://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-open-source/) topic. + + +### Configure NGINX OSS Repository for installing NGINX Agent + +Before you install NGINX Agent for the first time on your system, you need to set up the `nginx-agent` packages repository. Afterward, you can install and update NGINX Agent from the repository. + +- [Install NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux](#install-nginx-agent-on-rhel-centos-rocky-linux-almalinux-and-oracle-linux) +- [Install NGINX Agent on Ubuntu](#install-nginx-agent-on-ubuntu) +- [Install NGINX Agent on Debian](#install-nginx-agent-on-debian) +- [Install NGINX Agent on SLES](#install-nginx-agent-on-sles) +- [Install NGINX Agent on Alpine Linux](#install-nginx-agent-on-alpine-linux) +- [Install NGINX Agent on Amazon Linux](#install-nginx-agent-on-amazon-linux) +- [Install NGINX Agent on FreeBSD](#install-nginx-agent-on-freebsd) + +#### Install NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux + +1. Install the prerequisites: + + ```shell + sudo yum install yum-utils + ``` + +1. To set up the yum repository, create the file named `/etc/yum.repos.d/nginx-agent.repo` with the following contents: + + ``` + [nginx-agent] + name=nginx agent repo + baseurl=http://packages.nginx.org/nginx-agent/centos/$releasever/$basearch/ + gpgcheck=1 + enabled=1 + gpgkey=https://nginx.org/keys/nginx_signing.key + module_hotfixes=true + ``` + +1. To install `nginx-agent`, run the following command: + + ```shell + sudo yum install nginx-agent + ``` + + When prompted to accept the GPG key, verify that the fingerprint matches `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62`, and if so, accept it. + +#### Install NGINX Agent on Ubuntu + +1. Install the prerequisites: + + ```shell + sudo apt install curl gnupg2 ca-certificates lsb-release ubuntu-keyring + ``` + +1. Import an official nginx signing key so apt could verify the packages authenticity. Fetch the key: + + ```shell + curl https://nginx.org/keys/nginx_signing.key | gpg --dearmor \ + | sudo tee /usr/share/keyrings/nginx-archive-keyring.gpg >/dev/null + ``` + +1. Verify that the downloaded file contains the proper key: + + ```shell + gpg --dry-run --quiet --no-keyring --import --import-options import-show /usr/share/keyrings/nginx-archive-keyring.gpg + ``` + + The output should contain the full fingerprint `573BFD6B3D8FBC641079A6ABABF5BD827BD9BF62` as follows: + + ``` + pub rsa2048 2011-08-19 [SC] [expires: 2024-06-14] + 573BFD6B3D8FBC641079A6ABABF5BD827BD9BF62 + uid nginx signing key + ``` + + {{< important >}}If the fingerprint is different, remove the file.{{< /important >}} + +1. Add the nginx agent repository: + + ```shell + echo "deb [signed-by=/usr/share/keyrings/nginx-archive-keyring.gpg] \ + http://packages.nginx.org/nginx-agent/ubuntu/ `lsb_release -cs` agent" \ + | sudo tee /etc/apt/sources.list.d/nginx-agent.list + ``` + +1. To install `nginx-agent`, run the following commands: + + ```shell + sudo apt update + sudo apt install nginx-agent + ``` + +#### Install NGINX Agent on Debian + +1. Install the prerequisites: + + ```shell + sudo apt install curl gnupg2 ca-certificates lsb-release debian-archive-keyring + ``` + +1. Import an official nginx signing key so apt could verify the packages authenticity. Fetch the key: + + ```shell + curl https://nginx.org/keys/nginx_signing.key | gpg --dearmor \ + | sudo tee /usr/share/keyrings/nginx-archive-keyring.gpg >/dev/null + ``` + +1. Verify that the downloaded file contains the proper key: + + ```shell + gpg --dry-run --quiet --no-keyring \ + --import --import-options import-show /usr/share/keyrings/nginx-archive-keyring.gpg + ``` + + The output should contain the full fingerprint `573BFD6B3D8FBC641079A6ABABF5BD827BD9BF62` as follows: + + ``` + pub rsa2048 2011-08-19 [SC] [expires: 2024-06-14] + 573BFD6B3D8FBC641079A6ABABF5BD827BD9BF62 + uid nginx signing key + ``` + + {{< important >}}If the fingerprint is different, remove the file.{{< /important >}} + +1. Add the `nginx-agent` repository: + + ```shell + echo "deb [signed-by=/usr/share/keyrings/nginx-archive-keyring.gpg] \ + http://packages.nginx.org/nginx-agent/debian/ `lsb_release -cs` agent" \ | sudo tee /etc/apt/sources.list.d/nginx-agent.list + ``` + +1. To install `nginx-agent`, run the following commands: + + ```shell + sudo apt update + sudo apt install nginx-agent + ``` + +#### Install NGINX Agent on SLES + +1. Install the prerequisites: + + ```shell + sudo zypper install curl ca-certificates gpg2 gawk + ``` + +1. To set up the zypper repository for `nginx-agent` packages, run the following command: + + ```shell + sudo zypper addrepo --gpgcheck --refresh --check \ + 'http://packages.nginx.org/nginx-agent/sles/$releasever_major' nginx-agent + ``` + +1. Next, import an official NGINX signing key so `zypper`/`rpm` can verify the package's authenticity. Fetch the key: + + ```shell + curl -o /tmp/nginx_signing.key https://nginx.org/keys/nginx_signing.key + ``` + +1. Verify that the downloaded file contains the proper key: + + ```shell + gpg --with-fingerprint --dry-run --quiet --no-keyring --import --import-options import-show /tmp/nginx_signing.key + ``` + +1. The output should contain the full fingerprint `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62` as follows: + + ``` + pub rsa2048 2011-08-19 [SC] [expires: 2024-06-14] + 573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62 + uid nginx signing key + ``` + +1. Finally, import the key to the rpm database: + + ```shell + sudo rpmkeys --import /tmp/nginx_signing.key + ``` + +1. To install `nginx-agent`, run the following command: + + ```shell + sudo zypper install nginx-agent + ``` + +#### Install NGINX Agent on Alpine Linux + +1. Install the prerequisites: + + ```shell + sudo apk add openssl curl ca-certificates + ``` + +1. To set up the apk repository for `nginx-agent` packages, run the following command: + + ```shell + printf "%s%s%s\n" \ + "http://packages.nginx.org/nginx-agent/alpine/v" \ + `grep -o -E '^[0-9]+\.[0-9]+' /etc/alpine-release` \ + "/main" \ + | sudo tee -a /etc/apk/repositories + ``` + +1. Next, import an official NGINX signing key so apk can verify the package's authenticity. Fetch the key: + + ```shell + curl -o /tmp/nginx_signing.rsa.pub https://nginx.org/keys/nginx_signing.rsa.pub + ``` + +1. Verify that downloaded file contains the proper key: + + ```shell + openssl rsa -pubin -in /tmp/nginx_signing.rsa.pub -text -noout + ``` + + The output should contain the following modulus: + + ``` + Public-Key: (2048 bit) + Modulus: + 00:fe:14:f6:0a:1a:b8:86:19:fe:cd:ab:02:9f:58: + 2f:37:70:15:74:d6:06:9b:81:55:90:99:96:cc:70: + 5c:de:5b:e8:4c:b2:0c:47:5b:a8:a2:98:3d:11:b1: + f6:7d:a0:46:df:24:23:c6:d0:24:52:67:ba:69:ab: + 9a:4a:6a:66:2c:db:e1:09:f1:0d:b2:b0:e1:47:1f: + 0a:46:ac:0d:82:f3:3c:8d:02:ce:08:43:19:d9:64: + 86:c4:4e:07:12:c0:5b:43:ba:7d:17:8a:a3:f0:3d: + 98:32:b9:75:66:f4:f0:1b:2d:94:5b:7c:1c:e6:f3: + 04:7f:dd:25:b2:82:a6:41:04:b7:50:93:94:c4:7c: + 34:7e:12:7c:bf:33:54:55:47:8c:42:94:40:8e:34: + 5f:54:04:1d:9e:8c:57:48:d4:b0:f8:e4:03:db:3f: + 68:6c:37:fa:62:14:1c:94:d6:de:f2:2b:68:29:17: + 24:6d:f7:b5:b3:18:79:fd:31:5e:7f:4c:be:c0:99: + 13:cc:e2:97:2b:dc:96:9c:9a:d0:a7:c5:77:82:67: + c9:cb:a9:e7:68:4a:e1:c5:ba:1c:32:0e:79:40:6e: + ef:08:d7:a3:b9:5d:1a:df:ce:1a:c7:44:91:4c:d4: + 99:c8:88:69:b3:66:2e:b3:06:f1:f4:22:d7:f2:5f: + ab:6d + Exponent: 65537 (0x10001) + ``` + +1. Finally, move the key to apk trusted keys storage: + + ```shell + sudo mv /tmp/nginx_signing.rsa.pub /etc/apk/keys/ + ``` + +1. To install `nginx-agent`, run the following command: + + ```shell + sudo apk add nginx-agent + ``` + +#### Install NGINX Agent on Amazon Linux + +1. Install the prerequisites: + + ```shell + sudo yum install yum-utils procps + ``` + +1. To set up the yum repository for Amazon Linux 2, create the file named `/etc/yum.repos.d/nginx-agent.repo` with the following contents: + ``` + [nginx-agent] + name=nginx agent repo + baseurl=http://packages.nginx.org/nginx-agent/amzn2/$releasever/$basearch/ + gpgcheck=1 + enabled=1 + gpgkey=https://nginx.org/keys/nginx_signing.key + module_hotfixes=true + ``` + +1. To install `nginx-agent`, run the following command: + + ```shell + sudo yum install nginx-agent + ``` + +1. When prompted to accept the GPG key, verify that the fingerprint matches `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62`, and if so, accept it. + +#### Install NGINX Agent on FreeBSD + +1. To setup the pkg repository create the file named `/etc/pkg/nginx-agent.conf` with the following content: + + ``` + nginx-agent: { + URL: pkg+http://packages.nginx.org/nginx-agent/freebsd/${ABI}/latest + ENABLED: true + MIRROR_TYPE: SRV + } + ``` + +1. To install `nginx-agent`, run the following command: + + ```shell + sudo pkg install nginx-agent + ``` + +## NGINX Plus repository + +Before you install NGINX Agent, you must install and run NGINX Plus. + +If you don’t have it installed already, read the [Installing NGINX Plus +](https://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-plus/) topic. + +You will also need the following: + - Your credentials to the MyF5 Customer Portal, provided by email from F5, Inc. +- An NGINX Plus subscription (Full or trial) - Your NGINX Plus certificate and public key (`nginx-repo.crt` and `nginx-repo.key` files), provided by email from F5, Inc. -## Configure NGINX Plus Repository for installing NGINX Agent +### Configure NGINX Plus Repository for installing NGINX Agent Before you install NGINX Agent for the first time on your system, you need to set up the `nginx-agent` packages repository. Afterward, you can install and update NGINX Agent from the repository. @@ -32,7 +343,7 @@ Before you install NGINX Agent for the first time on your system, you need to se - [Install NGINX Agent on Amazon Linux](#install-nginx-agent-on-amazon-linux) - [Install NGINX Agent on FreeBSD](#install-nginx-agent-on-freebsd) -### Install NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux +#### Install NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux 1. Create the `/etc/ssl/nginx` directory: @@ -80,13 +391,7 @@ Before you install NGINX Agent for the first time on your system, you need to se When prompted to accept the GPG key, verify that the fingerprint matches `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62`, and if so, accept it. -1. Verify the installation: - - ```shell - sudo nginx-agent -v - ``` - -### Install NGINX Agent on Ubuntu +#### Install NGINX Agent on Ubuntu 1. Create the `/etc/ssl/nginx` directory: @@ -137,14 +442,7 @@ Before you install NGINX Agent for the first time on your system, you need to se sudo apt install nginx-agent ``` -1. Verify the installation: - - ```shell - sudo nginx-agent -v - ``` - - -### Install NGINX Agent on Debian +#### Install NGINX Agent on Debian 1. Create the `/etc/ssl/nginx` directory: @@ -189,13 +487,7 @@ Before you install NGINX Agent for the first time on your system, you need to se sudo apt install nginx-agent ``` -1. Verify the installation: - - ```shell - sudo nginx-agent -v - ``` - -### Install NGINX Agent on SLES +#### Install NGINX Agent on SLES 1. Create the `/etc/ssl/nginx` directory: @@ -262,13 +554,7 @@ Before you install NGINX Agent for the first time on your system, you need to se sudo zypper install nginx-agent ``` -1. Verify the installation: - - ```shell - sudo nginx-agent -v - ``` - -### Install NGINX Agent on Alpine Linux +#### Install NGINX Agent on Alpine Linux 1. Log in to [MyF5 Customer Portal](https://account.f5.com/myf5/) and download your `nginx-repo.crt` and `nginx-repo.key` files. @@ -345,13 +631,7 @@ Before you install NGINX Agent for the first time on your system, you need to se sudo apk add nginx-agent ``` -1. Verify the installation: - - ```shell - sudo nginx-agent -v - ``` - -### Install NGINX Agent on Amazon Linux +#### Install NGINX Agent on Amazon Linux 1. Create the `/etc/ssl/nginx` directory: @@ -393,13 +673,7 @@ Before you install NGINX Agent for the first time on your system, you need to se 1. When prompted to accept the GPG key, verify that the fingerprint matches `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62`, and if so, accept it. -1. Verify the installation: - - ```shell - sudo nginx-agent -v - ``` - -### Install NGINX Agent on FreeBSD +#### Install NGINX Agent on FreeBSD 1. Create the `/etc/ssl/nginx` directory: @@ -445,8 +719,46 @@ Before you install NGINX Agent for the first time on your system, you need to se sudo pkg install nginx-agent ``` -1. Verify the installation: +## GitHub package files - ```shell - sudo nginx-agent -v - ``` +To install NGINX Agent on your system, go to the [GitHub releases page](https://github.com/nginx/agent/releases) and download the latest package supported by your operating system distribution and CPU architecture. + +Use your system's package manager to install the package. Some examples: + +- Debian, Ubuntu, and other distributions using the `dpkg` package manager. + + ```shell + sudo dpkg -i nginx-agent-.deb + ``` + +- RHEL, CentOS RHEL, Amazon Linux, Oracle Linux, and other distributions using the `yum` package manager + + ```shell + sudo yum localinstall nginx-agent-.rpm + ``` + +- RHEL and other distributions using the `rpm` package manager + + ```shell + sudo rpm -i nginx-agent-.rpm + ``` + +- Alpine Linux + + ```shell + sudo apk add nginx-agent-.apk + ``` + +- FreeBSD + + ```shell + sudo pkg add nginx-agent-.pkg + ``` + +## Verify that NGINX Agent is running + +Once you have installed NGINX Agent, you can verify that it is running with the following command: + +```shell +sudo nginx-agent -v +``` \ No newline at end of file diff --git a/site/content/installation-upgrade/installation-github.md b/site/content/installation-upgrade/installation-github.md deleted file mode 100644 index cdc8bd55b..000000000 --- a/site/content/installation-upgrade/installation-github.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "Installation from GitHub release" -weight: 200 -docs: DOC-000 ---- - -## Overview - -Learn how to install NGINX Agent from a GitHub Release. - -## Install NGINX - -NGINX Agent interfaces directly with an NGINX server process installed on the same system. If you don't have it already, follow these steps to install [NGINX Open Source](https://www.nginx.com/resources/wiki/start/topics/tutorials/install/) or [NGINX Plus](https://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-plus/). Once installed, ensure the NGINX instance is running. - -## Install NGINX Agent from package files - -To install NGINX Agent on your system, go to [GitHub Releases](https://github.com/nginx/agent/releases) and download the latest package supported by your OS distribution and CPU architecture. - -Use your system's package manager to install the package. Some examples: - -- Debian, Ubuntu, and other distributions using the `dpkg` package manager. - - ```shell - sudo dpkg -i nginx-agent-.deb - ``` - -- RHEL, CentOS RHEL, Amazon Linux, Oracle Linux, and other distributions using the `yum` package manager - - ```shell - sudo yum localinstall nginx-agent-.rpm - ``` - -- RHEL and other distributions using the `rpm` package manager - - ```shell - sudo rpm -i nginx-agent-.rpm - ``` - -- Alpine Linux - - ```shell - sudo apk add nginx-agent-.apk - ``` - -- FreeBSD - - ```shell - sudo pkg add nginx-agent-.pkg - ``` diff --git a/site/content/installation-upgrade/installation-oss.md b/site/content/installation-upgrade/installation-oss.md deleted file mode 100644 index 68bba28b0..000000000 --- a/site/content/installation-upgrade/installation-oss.md +++ /dev/null @@ -1,348 +0,0 @@ ---- -title: "Installation from NGINX repository" -toc: true -weight: 300 -docs: DOCS-000 ---- - -## Overview - -Learn how to install NGINX Agent from the NGINX Open Source repository. - -## Before you begin - -### Prerequisites - -- NGINX installed. Once installed, ensure it is running. If you don't have it installed already, follow these steps to install [NGINX](https://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-open-source/) -- A [supported operating system and architecture](../technical-specifications/#supported-distributions) -- `root` privilege - -## Configure NGINX OSS Repository for installing NGINX Agent - -Before you install NGINX Agent for the first time on your system, you need to set up the `nginx-agent` packages repository. Afterward, you can install and update NGINX Agent from the repository. - -- [Install NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux](#install-nginx-agent-on-rhel-centos-rocky-linux-almalinux-and-oracle-linux) -- [Install NGINX Agent on Ubuntu](#install-nginx-agent-on-ubuntu) -- [Install NGINX Agent on Debian](#install-nginx-agent-on-debian) -- [Install NGINX Agent on SLES](#install-nginx-agent-on-sles) -- [Install NGINX Agent on Alpine Linux](#install-nginx-agent-on-alpine-linux) -- [Install NGINX Agent on Amazon Linux](#install-nginx-agent-on-amazon-linux) -- [Install NGINX Agent on FreeBSD](#install-nginx-agent-on-freebsd) - -### Install NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux - -1. Install the prerequisites: - - ```shell - sudo yum install yum-utils - ``` - -1. To set up the yum repository, create the file named `/etc/yum.repos.d/nginx-agent.repo` with the following contents: - - ``` - [nginx-agent] - name=nginx agent repo - baseurl=http://packages.nginx.org/nginx-agent/centos/$releasever/$basearch/ - gpgcheck=1 - enabled=1 - gpgkey=https://nginx.org/keys/nginx_signing.key - module_hotfixes=true - ``` - -1. To install `nginx-agent`, run the following command: - - ```shell - sudo yum install nginx-agent - ``` - - When prompted to accept the GPG key, verify that the fingerprint matches `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62`, and if so, accept it. - -### Install NGINX Agent on Ubuntu - -1. Install the prerequisites: - - ```shell - sudo apt install curl gnupg2 ca-certificates lsb-release ubuntu-keyring - ``` - -1. Import an official nginx signing key so apt could verify the packages authenticity. Fetch the key: - - ```shell - curl https://nginx.org/keys/nginx_signing.key | gpg --dearmor \ - | sudo tee /usr/share/keyrings/nginx-archive-keyring.gpg >/dev/null - ``` - -1. Verify that the downloaded file contains the proper key: - - ```shell - gpg --dry-run --quiet --no-keyring --import --import-options import-show /usr/share/keyrings/nginx-archive-keyring.gpg - ``` - - The output should contain the full fingerprint `573BFD6B3D8FBC641079A6ABABF5BD827BD9BF62` as follows: - - ``` - pub rsa2048 2011-08-19 [SC] [expires: 2024-06-14] - 573BFD6B3D8FBC641079A6ABABF5BD827BD9BF62 - uid nginx signing key - ``` - - {{< important >}}If the fingerprint is different, remove the file.{{< /important >}} - -1. Add the nginx agent repository: - - ```shell - echo "deb [signed-by=/usr/share/keyrings/nginx-archive-keyring.gpg] \ - http://packages.nginx.org/nginx-agent/ubuntu/ `lsb_release -cs` agent" \ - | sudo tee /etc/apt/sources.list.d/nginx-agent.list - ``` - -1. To install `nginx-agent`, run the following commands: - - ```shell - sudo apt update - sudo apt install nginx-agent - ``` - -1. Verify the installation: - - ```shell - sudo nginx-agent -v - ``` - - -### Install NGINX Agent on Debian - -1. Install the prerequisites: - - ```shell - sudo apt install curl gnupg2 ca-certificates lsb-release debian-archive-keyring - ``` - -1. Import an official nginx signing key so apt could verify the packages authenticity. Fetch the key: - - ```shell - curl https://nginx.org/keys/nginx_signing.key | gpg --dearmor \ - | sudo tee /usr/share/keyrings/nginx-archive-keyring.gpg >/dev/null - ``` - -1. Verify that the downloaded file contains the proper key: - - ```shell - gpg --dry-run --quiet --no-keyring \ - --import --import-options import-show /usr/share/keyrings/nginx-archive-keyring.gpg - ``` - - The output should contain the full fingerprint `573BFD6B3D8FBC641079A6ABABF5BD827BD9BF62` as follows: - - ``` - pub rsa2048 2011-08-19 [SC] [expires: 2024-06-14] - 573BFD6B3D8FBC641079A6ABABF5BD827BD9BF62 - uid nginx signing key - ``` - - {{< important >}}If the fingerprint is different, remove the file.{{< /important >}} - -1. Add the `nginx-agent` repository: - - ```shell - echo "deb [signed-by=/usr/share/keyrings/nginx-archive-keyring.gpg] \ - http://packages.nginx.org/nginx-agent/debian/ `lsb_release -cs` agent" \ | sudo tee /etc/apt/sources.list.d/nginx-agent.list - ``` - -1. To install `nginx-agent`, run the following commands: - - ```shell - sudo apt update - sudo apt install nginx-agent - ``` - -1. Verify the installation: - - ```shell - sudo nginx-agent -v - ``` - - -### Install NGINX Agent on SLES - -1. Install the prerequisites: - - ```shell - sudo zypper install curl ca-certificates gpg2 gawk - ``` - -1. To set up the zypper repository for `nginx-agent` packages, run the following command: - - ```shell - sudo zypper addrepo --gpgcheck --refresh --check \ - 'http://packages.nginx.org/nginx-agent/sles/$releasever_major' nginx-agent - ``` - -1. Next, import an official NGINX signing key so `zypper`/`rpm` can verify the package's authenticity. Fetch the key: - - ```shell - curl -o /tmp/nginx_signing.key https://nginx.org/keys/nginx_signing.key - ``` - -1. Verify that the downloaded file contains the proper key: - - ```shell - gpg --with-fingerprint --dry-run --quiet --no-keyring --import --import-options import-show /tmp/nginx_signing.key - ``` - -1. The output should contain the full fingerprint `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62` as follows: - - ``` - pub rsa2048 2011-08-19 [SC] [expires: 2024-06-14] - 573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62 - uid nginx signing key - ``` - -1. Finally, import the key to the rpm database: - - ```shell - sudo rpmkeys --import /tmp/nginx_signing.key - ``` - -1. To install `nginx-agent`, run the following command: - - ```shell - sudo zypper install nginx-agent - ``` - -1. Verify the installation: - - ```shell - sudo nginx-agent -v - ``` - -### Install NGINX Agent on Alpine Linux - -1. Install the prerequisites: - - ```shell - sudo apk add openssl curl ca-certificates - ``` - -1. To set up the apk repository for `nginx-agent` packages, run the following command: - - ```shell - printf "%s%s%s\n" \ - "http://packages.nginx.org/nginx-agent/alpine/v" \ - `grep -o -E '^[0-9]+\.[0-9]+' /etc/alpine-release` \ - "/main" \ - | sudo tee -a /etc/apk/repositories - ``` - -1. Next, import an official NGINX signing key so apk can verify the package's authenticity. Fetch the key: - - ```shell - curl -o /tmp/nginx_signing.rsa.pub https://nginx.org/keys/nginx_signing.rsa.pub - ``` - -1. Verify that downloaded file contains the proper key: - - ```shell - openssl rsa -pubin -in /tmp/nginx_signing.rsa.pub -text -noout - ``` - - The output should contain the following modulus: - - ``` - Public-Key: (2048 bit) - Modulus: - 00:fe:14:f6:0a:1a:b8:86:19:fe:cd:ab:02:9f:58: - 2f:37:70:15:74:d6:06:9b:81:55:90:99:96:cc:70: - 5c:de:5b:e8:4c:b2:0c:47:5b:a8:a2:98:3d:11:b1: - f6:7d:a0:46:df:24:23:c6:d0:24:52:67:ba:69:ab: - 9a:4a:6a:66:2c:db:e1:09:f1:0d:b2:b0:e1:47:1f: - 0a:46:ac:0d:82:f3:3c:8d:02:ce:08:43:19:d9:64: - 86:c4:4e:07:12:c0:5b:43:ba:7d:17:8a:a3:f0:3d: - 98:32:b9:75:66:f4:f0:1b:2d:94:5b:7c:1c:e6:f3: - 04:7f:dd:25:b2:82:a6:41:04:b7:50:93:94:c4:7c: - 34:7e:12:7c:bf:33:54:55:47:8c:42:94:40:8e:34: - 5f:54:04:1d:9e:8c:57:48:d4:b0:f8:e4:03:db:3f: - 68:6c:37:fa:62:14:1c:94:d6:de:f2:2b:68:29:17: - 24:6d:f7:b5:b3:18:79:fd:31:5e:7f:4c:be:c0:99: - 13:cc:e2:97:2b:dc:96:9c:9a:d0:a7:c5:77:82:67: - c9:cb:a9:e7:68:4a:e1:c5:ba:1c:32:0e:79:40:6e: - ef:08:d7:a3:b9:5d:1a:df:ce:1a:c7:44:91:4c:d4: - 99:c8:88:69:b3:66:2e:b3:06:f1:f4:22:d7:f2:5f: - ab:6d - Exponent: 65537 (0x10001) - ``` - -1. Finally, move the key to apk trusted keys storage: - - ```shell - sudo mv /tmp/nginx_signing.rsa.pub /etc/apk/keys/ - ``` - -1. To install `nginx-agent`, run the following command: - - ```shell - sudo apk add nginx-agent - ``` - -1. Verify the installation: - - ```shell - sudo nginx-agent -v - ``` - -### Install NGINX Agent on Amazon Linux - -1. Install the prerequisites: - - ```shell - sudo yum install yum-utils procps - ``` - -1. To set up the yum repository for Amazon Linux 2, create the file named `/etc/yum.repos.d/nginx-agent.repo` with the following contents: - ``` - [nginx-agent] - name=nginx agent repo - baseurl=http://packages.nginx.org/nginx-agent/amzn2/$releasever/$basearch/ - gpgcheck=1 - enabled=1 - gpgkey=https://nginx.org/keys/nginx_signing.key - module_hotfixes=true - ``` - -1. To install `nginx-agent`, run the following command: - - ```shell - sudo yum install nginx-agent - ``` - -1. When prompted to accept the GPG key, verify that the fingerprint matches `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62`, and if so, accept it. - -1. Verify the installation: - - ```shell - sudo nginx-agent -v - ``` - -### Install NGINX Agent on FreeBSD - -1. To setup the pkg repository create the file named `/etc/pkg/nginx-agent.conf` with the following content: - - ``` - nginx-agent: { - URL: pkg+http://packages.nginx.org/nginx-agent/freebsd/${ABI}/latest - ENABLED: true - MIRROR_TYPE: SRV - } - ``` - -1. To install `nginx-agent`, run the following command: - - ```shell - sudo pkg install nginx-agent - ``` - -1. Verify the installation: - - ```shell - sudo nginx-agent -v - ``` diff --git a/site/content/installation-upgrade/migrate-v3.md b/site/content/installation-upgrade/migrate-v3.md index 559ead4c1..5aed25100 100644 --- a/site/content/installation-upgrade/migrate-v3.md +++ b/site/content/installation-upgrade/migrate-v3.md @@ -1,6 +1,6 @@ --- title: Migrate from NGINX Agent v2 to v3 -weight: 900 +weight: 600 docs: DOCS-000 --- diff --git a/site/content/installation-upgrade/uninstall.md b/site/content/installation-upgrade/uninstall.md index 2a18a20b1..dc92535fd 100644 --- a/site/content/installation-upgrade/uninstall.md +++ b/site/content/installation-upgrade/uninstall.md @@ -1,7 +1,7 @@ --- -title: "Uninstall NGINX Agent package" +title: "Uninstall NGINX Agent" toc: true -weight: 600 +weight: 400 docs: DOCS-000 --- diff --git a/site/content/installation-upgrade/upgrade.md b/site/content/installation-upgrade/upgrade.md index eccb4612e..b86c6f4a2 100644 --- a/site/content/installation-upgrade/upgrade.md +++ b/site/content/installation-upgrade/upgrade.md @@ -1,7 +1,7 @@ --- -title: "Upgrade NGINX Agent package" +title: "Upgrade NGINX Agent" toc: true -weight: 600 +weight: 300 docs: DOCS-000 --- @@ -38,8 +38,6 @@ To upgrade NGINX Agent, follow these steps: sudo apt-get install -y --only-upgrade nginx-agent -o Dpkg::Options::="--force-confold" ``` - - ## Upgrade NGINX Agent from a version less than v2.31.0 To upgrade NGINX Agent, take the following steps: From 3dce2f10a95f708bbff722fcb219b993dcf8e316 Mon Sep 17 00:00:00 2001 From: Jack Hickey <133868041+nginx-jack@users.noreply.github.com> Date: Tue, 24 Sep 2024 13:43:48 +0100 Subject: [PATCH 13/30] Merge pull request #860 from nginx/staging-auto-deploy Add auto deployment from main to docs staging environment --- .github/workflows/docs-build-push.yml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.github/workflows/docs-build-push.yml b/.github/workflows/docs-build-push.yml index 0469d9b32..b63b2ee3d 100644 --- a/.github/workflows/docs-build-push.yml +++ b/.github/workflows/docs-build-push.yml @@ -17,6 +17,9 @@ on: - "*" paths: - site/** + push: + branches: + - "main" permissions: contents: read @@ -34,6 +37,8 @@ jobs: docs_build_path: "./site" doc_type: "hugo" environment: ${{inputs.environment}} + auto_deploy_branch: "main" + auto_deploy_env: "staging" secrets: AZURE_CREDENTIALS: ${{secrets.AZURE_CREDENTIALS_DOCS}} AZURE_KEY_VAULT: ${{secrets.AZURE_KEY_VAULT_DOCS}} \ No newline at end of file From c9a3b8af9903d724f993bc0c04dcad6c6f0626ac Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Wed, 25 Sep 2024 12:58:34 +0100 Subject: [PATCH 14/30] Add mention of Agent v3 inclusion of OTel, add links --- site/content/about.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/site/content/about.md b/site/content/about.md index 422f84537..5efc7bce6 100644 --- a/site/content/about.md +++ b/site/content/about.md @@ -13,8 +13,15 @@ NGINX Agent is a companion daemon for your NGINX Open Source or NGINX Plus insta - Collection and reporting of real-time NGINX performance and operating system metrics - Notifications of NGINX events +[OpenTelemetry](https://opentelemetry.io/) support comes with NGINX Agent v3, and the ability to [export the metrics data](http://localhost:1313/nginx-agent/export-metrics/) for use in other applications. -{{< img src="grafana-dashboard-example.png" caption="A Grafana dashboard displaying metrics reported by NGINX Agent." alt="A Grafana dashboard displaying metrics reported by NGINX Agent." width="99%">}} +For an overview of the metrics available from NGINX Agent, read the following topics: + +- [OpenTelemetry metrics]({{< relref "/metrics.md" >}}) (Agent v3) +- [Metrics]({{< relref "/v2/metrics.md" >}}) (Agent v2) + + +{{< img src="grafana-dashboard-example.png" caption="A Grafana dashboard displaying metrics reported by NGINX Agent." alt="A Grafana dashboard displaying metrics reported by NGINX Agent.">}} ## How it works @@ -43,7 +50,6 @@ For NGINX Agent to work properly with an NGINX Plus instance, the API needs to b NGINX Agent allows a gRPC connected control system to register a listener for a specific event. The control mechanism is then invoked when NGINX Agent sends an associated system signal. The source of a notification can be either the NGINX instance or NGINX Agent itself. Here's a list of currently supported events: - {{< raw-html>}}
    {{}} {{}} | Event | Description | From c616c94651e404d2ec9d03d6787b2e53c48a1ef1 Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Wed, 25 Sep 2024 13:19:39 +0100 Subject: [PATCH 15/30] Amend placeholder link for migration topic, update config overview --- .../configuration/configuration-overview.md | 212 ++++++++---------- site/layouts/agent-v2-migration/single.html | 2 +- 2 files changed, 98 insertions(+), 116 deletions(-) diff --git a/site/content/configuration/configuration-overview.md b/site/content/configuration/configuration-overview.md index 66d09b3c7..eaae82db0 100644 --- a/site/content/configuration/configuration-overview.md +++ b/site/content/configuration/configuration-overview.md @@ -1,16 +1,11 @@ --- title: "Configuration overview" -draft: false -weight: 100 toc: true -tags: [ "docs" ] -categories: ["configuration"] -doctypes: ["task"] +weight: 100 +docs: "DOCS-1229" --- -## Overview - -The following sections explain how to configure NGINX Agent using configuration files, CLI flags, and environment variables. +This page describes how to configure NGINX Agent using configuration files, CLI (Command line interface) flags, and environment variables. {{}} @@ -24,7 +19,7 @@ The following sections explain how to configure NGINX Agent using configuration {{}} -### Configure with Config Files +## Configuration files The default locations of configuration files for NGINX Agent are `/etc/nginx-agent/nginx-agent.conf` and `/var/lib/nginx-agent/agent-dynamic.conf`. The `agent-dynamic.conf` file default location is different for FreeBSD which is located `/var/db/nginx-agent/agent-dynamic.conf`. These files have comments at the top indicating their purpose. @@ -34,7 +29,7 @@ Examples of the configuration files are provided below: example nginx-agent.conf {{}} -In the following example `nginx-agent.conf` file, you can change the `server.host` and `server.grpcPort` to connect to the control/management plane. +In the following example `nginx-agent.conf` file, you can change the `server.host` and `server.grpcPort` to connect to the control plane. {{}} ```nginx {hl_lines=[13]} @@ -52,6 +47,12 @@ server: # host of the control plane host: grpcPort: 443 + backoff: # note: default values are prepopulated + initial_interval: 100ms # Add the appropriate duration value here, e.g., "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour + randomization_factor: 0.10 # Add the appropriate float value here, e.g., 0.10 + multiplier: 1.5 # Add the appropriate float value here, e.g., 1.5 + max_interval: 1m # Add the appropriate duration value here, e.g., "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour + max_elapsed_time: 0 # Add the appropriate duration value here, e.g., "0" for indefinite "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour # tls options tls: # enable tls in the nginx-agent setup for grpcs @@ -73,7 +74,7 @@ nginx: # data plane status message / 'heartbeat' dataplane: status: - # poll interval for dataplane status - the frequency the agent will query the dataplane for changes + # poll interval for dataplane status - the frequency the NGINX Agent will query the dataplane for changes poll_interval: 30s # report interval for dataplane status - the maximum duration to wait before syncing dataplane information if no updates have been observed report_interval: 24h @@ -84,6 +85,12 @@ metrics: report_interval: 1m collection_interval: 15s mode: aggregated + backoff: # note: default values are prepopulated + initial_interval: 100ms # Add the appropriate duration value here, e.g., "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour + randomization_factor: 0.10 # Add the appropriate float value here, e.g., 0.10 + multiplier: 1.5 # Add the appropriate float value here, e.g., 1.5 + max_interval: 1m # Add the appropriate duration value here, e.g., "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour + max_elapsed_time: 0 # Add the appropriate duration value here, e.g., "0" for indefinite "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour # OSS NGINX default config path # path to aux file dirs can also be added @@ -124,134 +131,109 @@ Default location in FreeBSD environments: `/var/db/nginx-agent/agent-dynamic.con # overwrite the tag values in this file. # # The agent configuration values that API calls can modify are as follows: -# - tags +# tags: +# - dev +# - qa # # The agent configuration value that the agent install script can modify are as follows: -# - instance_group +# instance_group: my-instance-group -instance_group: devenv-group +instance_group: my-instance-group tags: - - devenv - - test + - dev + - qa ``` +## CLI flags and environment variables -### NGINX Agent CLI Flags & Usage {#nginx-agent-cli-flags-usage} +This section details the CLI flags and corresponding environment variables used to configure the NGINX Agent. -This section displays the configurable options for NGINX Agent that can be set with CLI flags. See the CLI flags and their uses in the figure below: +### CLI flags -
    - NGINX Agent CLI flags & usage - -```text -Usage: - nginx-agent [flags] - nginx-agent [command] - -Available Commands: - completion Generate completion script. - help Help about any command - -Flags: - --api-cert string The cert used by the Agent API. - --api-host string The host used by the Agent API. (default "127.0.0.1") - --api-key string The key used by the Agent API. - --api-port int The desired port to use for nginx-agent to expose for HTTP traffic. - --config-dirs string Defines the paths that you want to grant nginx-agent read/write access to. This key is formatted as a string and follows Unix PATH format. (default "/etc/nginx:/usr/local/etc/nginx:/usr/share/nginx/modules:/etc/nms") - --dataplane-report-interval duration The amount of time the agent will report on the dataplane. After this period of time it will send a snapshot of the dataplane information. (default 24h0m0s) - --dataplane-status-poll-interval duration The frequency the agent will check the dataplane for changes. Used as a "heartbeat" to keep the gRPC connections alive. (default 30s) - --display-name string The instance's 'name' value. - --dynamic-config-path string Defines the path of the Agent dynamic config file. (default "/var/lib/nginx-agent/agent-dynamic.conf") - --features strings A comma-separated list of features enabled for the agent. (default [registration,nginx-config-async,nginx-ssl-config,nginx-counting,metrics,dataplane-status,process-watcher,file-watcher,activity-events,agent-api]) - -h, --help help for nginx-agent - --ignore-directives strings A comma-separated list of ignoring directives which contain sensitive info. - --instance-group string The instance's 'group' value. - --log-level string The desired verbosity level for logging messages from nginx-agent. Available options, in order of severity from highest to lowest, are: panic, fatal, error, info, debug, and trace. (default "info") - --log-path string The path to output log messages to. If the default path doesn't exist, log messages are output to stdout/stderr. - --metrics-bulk-size int The amount of metrics reports collected before sending the data back to the server. (default 20) - --metrics-collection-interval duration Sets the interval, in seconds, at which metrics are collected. (default 15s) - --metrics-mode string Sets the desired metrics collection mode: streaming or aggregation. (default "aggregated") - --metrics-report-interval duration The polling period specified for a single set of metrics being collected. (default 1m0s) - --nginx-config-reload-monitoring-period duration The duration NGINX Agent will monitor error logs after a NGINX reload (default 10s) - --nginx-exclude-logs string One or more NGINX access log paths that you want to exclude from metrics collection. This key is formatted as a string and multiple values should be provided as a comma-separated list. - --nginx-socket string The NGINX Plus counting unix socket location. (default "unix:/var/run/nginx-agent/nginx.sock") - --nginx-treat-warnings-as-errors On nginx -t, treat warnings as failures on configuration application. - --queue-size int The size of the NGINX Agent internal queue. - --server-command string The name of the command server sent in the tls configuration. - --server-grpcport int The desired GRPC port to use for nginx-agent traffic. - --server-host string The IP address of the server host. IPv4 addresses and hostnames are supported. - --server-metrics string The name of the metrics server sent in the tls configuration. - --server-token string An authentication token that grants nginx-agent access to the commander and metrics services. Auto-generated by default. (default "e202f883-54c6-4702-be15-3ba6e507879a") - --tags strings A comma-separated list of tags to add to the current instance or machine, to be used for inventory purposes. - --tls-ca string The path to the CA certificate file to use for TLS. - --tls-cert string The path to the certificate file to use for TLS. - --tls-enable Enables TLS for secure communications. - --tls-key string The path to the certificate key file to use for TLS. - --tls-skip-verify Only intended for demonstration, sets InsecureSkipVerify for gRPC TLS credentials - -v, --version version for nginx-agent - -Use "nginx-agent [command] --help" for more information about a command. +```sh +nginx-agent [flags] ``` -
    +### Environment variables -#### NGINX Agent Config Dirs Option +```sh +export ENV_VARIABLE_NAME="value" +nginx-agent +``` + +### Flag and environment arguments + +{{< warning >}} + +Before version 2.35.0, the environment variables were prefixed with `NMS_` instead of `NGINX_AGENT_`. + +If you are upgrading from an older version, update your configuration accordingly. + +{{< /warning >}} + +{{}} +| CLI flag | Environment variable | Description | +|---------------------------------------------|--------------------------------------|-----------------------------------------------------------------------------| +| `--api-cert` | `NGINX_AGENT_API_CERT` | Specifies the certificate used by the Agent API. | +| `--api-host` | `NGINX_AGENT_API_HOST` | Sets the host used by the Agent API. Default: *127.0.0.1* | +| `--api-key` | `NGINX_AGENT_API_KEY` | Specifies the key used by the Agent API. | +| `--api-port` | `NGINX_AGENT_API_PORT` | Sets the port for exposing nginx-agent to HTTP traffic. | +| `--config-dirs` | `NGINX_AGENT_CONFIG_DIRS` | Defines directories NGINX Agent can read/write. Default: *"/etc/nginx:/usr/local/etc/nginx:/usr/share/nginx/modules:/etc/nms"* | +| `--dataplane-report-interval` | `NGINX_AGENT_DATAPLANE_REPORT_INTERVAL` | Sets the interval for dataplane reporting. Default: *24h0m0s* | +| `--dataplane-status-poll-interval` | `NGINX_AGENT_DATAPLANE_STATUS_POLL_INTERVAL` | Sets the interval for polling dataplane status. Default: *30s* | +| `--display-name` | `NGINX_AGENT_DISPLAY_NAME` | Sets the instance's display name. | +| `--dynamic-config-path` | `NGINX_AGENT_DYNAMIC_CONFIG_PATH` | Specifies the path of the Agent dynamic config file. Default: *"/var/lib/nginx-agent/agent-dynamic.conf"* | +| `--features` | `NGINX_AGENT_FEATURES` | Specifies a comma-separated list of features enabled for the agent. Default: *[registration, nginx-config-async, nginx-ssl-config, nginx-counting, metrics, dataplane-status, process-watcher, file-watcher, activity-events, agent-api]* | +| `--ignore-directives` | | Specifies a comma-separated list of directives to ignore for sensitive info.| +| `--instance-group` | `NGINX_AGENT_INSTANCE_GROUP` | Sets the instance's group value. | +| `--log-level` | `NGINX_AGENT_LOG_LEVEL` | Sets the logging level (e.g., panic, fatal, error, info, debug, trace). Default: *info* | +| `--log-path` | `NGINX_AGENT_LOG_PATH` | Specifies the path to output log messages. | +| `--metrics-bulk-size` | `NGINX_AGENT_METRICS_BULK_SIZE` | Specifies the number of metrics reports collected before sending data. Default: *20* | +| `--metrics-collection-interval` | `NGINX_AGENT_METRICS_COLLECTION_INTERVAL` | Sets the interval for metrics collection. Default: *15s* | +| `--metrics-mode` | `NGINX_AGENT_METRICS_MODE` | Sets the metrics collection mode: streaming or aggregation. Default: *aggregated* | +| `--metrics-report-interval` | `NGINX_AGENT_METRICS_REPORT_INTERVAL` | Sets the interval for reporting collected metrics. Default: *1m0s* | +| `--nginx-config-reload-monitoring-period` | | Sets the duration to monitor error logs after an NGINX reload. Default: *10s* | +| `--nginx-exclude-logs` | `NGINX_AGENT_NGINX_EXCLUDE_LOGS` | Specifies paths of NGINX access logs to exclude from metrics collection. | +| `--nginx-socket` | `NGINX_AGENT_NGINX_SOCKET` | Specifies the location of the NGINX Plus counting Unix socket. Default: *unix:/var/run/nginx-agent/nginx.sock* | +| `--nginx-treat-warnings-as-errors` | `NGINX_AGENT_NGINX_TREAT_WARNINGS_AS_ERRORS` | Treats warnings as failures on configuration application. | +| `--queue-size` | `NGINX_AGENT_QUEUE_SIZE` | Specifies the size of the NGINX Agent internal queue. | +| `--server-command` | | Specifies the name of the command server sent in the TLS configuration. | +| `--server-grpcport` | `NGINX_AGENT_SERVER_GRPCPORT` | Sets the desired GRPC port for NGINX Agent traffic. | +| `--server-host` | `NGINX_AGENT_SERVER_HOST` | Specifies the IP address of the server host. | +| `--server-metrics` | | Specifies the name of the metrics server sent in the TLS configuration. | +| `--server-token` | `NGINX_AGENT_SERVER_TOKEN` | Sets the authentication token for accessing the commander and metrics services. Default: *e202f883-54c6-4702-be15-3ba6e507879a* | +| `--tags` | `NGINX_AGENT_TAGS` | Specifies a comma-separated list of tags for the instance or machine. | +| `--tls-ca` | `NGINX_AGENT_TLS_CA` | Specifies the path to the CA certificate file for TLS. | +| `--tls-cert` | `NGINX_AGENT_TLS_CERT` | Specifies the path to the certificate file for TLS. | +| `--tls-enable` | `NGINX_AGENT_TLS_ENABLE` | Enables TLS for secure communications. | +| `--tls-key` | `NGINX_AGENT_TLS_KEY` | Specifies the path to the certificate key file for TLS. | +| `--tls-skip-verify` | `NGINX_AGENT_TLS_SKIP_VERIFY` | Insecurely skips verification for gRPC TLS credentials. | +{{}} + +
    + +{{}} +Use the `--config-dirs` command-line option, or the `config_dirs` key in the `nginx-agent.conf` file, to identify the directories NGINX Agent can read from or write to. This setting also defines the location to which you can upload config files when using a control plane. + +NGINX Agent cannot write to directories outside the specified location when updating a config and cannot upload files to directories outside of the configured location. -Use the `--config-dirs` command-line option, or the `config_dirs` key in the `nginx-agent.conf` file, to identify the directories NGINX Agent can read from or write to. This setting also defines the location to which you can upload config files when using a control/management plane. NGINX Agent cannot write to directories outside the specified location when updating a config and cannot upload files to directories outside of the configured location. NGINX Agent follows NGINX configuration directives to file paths outside the designated directories and reads certificates' metadata. NGINX Agent uses the following directives: - [`ssl_certificate`](https://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_certificate) -#### NGINX Agent Dynamic Config Path Option +{{}} -Use the `--dynamic-config-path` command-line option to set the location of the dynamic config file. This setting also requires you to move your dynamic config to the new path, or create a new dynamic config file at the specified location. +{{}} Use the `--dynamic-config-path` command-line option to set the location of the dynamic config file. This setting also requires you to move your dynamic config to the new path, or create a new dynamic config file at the specified location. Default location in Linux environments: `/var/lib/nginx-agent/agent-dynamic.conf` Default location in FreeBSD environments: `/var/db/nginx-agent/agent-dynamic.conf` -### NGINX Agent Environment Variables - -This section displays the configurable options for NGINX Agent that can be set with environment variables. A list of the configurable environment variables can be seen below: - -
    - NGINX Agent Environment Variables - -```text -- NMS_INSTANCE_GROUP -- NMS_DISPLAY_NAME -- NMS_FEATURES -- NMS_LOG_LEVEL -- NMS_LOG_PATH -- NMS_PATH -- NMS_METRICS_COLLECTION_INTERVAL -- NMS_METRICS_MODE -- NMS_METRICS_BULK_SIZE -- NMS_METRICS_REPORT_INTERVAL -- NMS_NGINX_EXCLUDE_LOGS -- NMS_NGINX_SOCKET -- NMS_NGINX_TREAT_WARNINGS_AS_ERRORS -- NMS_SERVER_GRPCPORT -- NMS_SERVER_HOST -- NMS_SERVER_TOKEN -- NMS_SERVER_COMMAND -- NMS_SERVER_METRICS -- NMS_TAGS -- NMS_TLS_CA -- NMS_TLS_CERT -- NMS_TLS_ENABLE -- NMS_TLS_KEY -- NMS_TLS_SKIP_VERIFY -- NMS_CONFIG_DIRS -- NMS_QUEUE_SIZE -- NMS_DATAPLANE_REPORT_INTERVAL -- NMS_DATAPLANE_STATUS_POLL_INTERVAL -``` -
    +{{    }} -### NGINX Agent Log Rotation +## Log rotation By default, NGINX Agent rotates logs daily using logrotate with the following configuration: @@ -281,6 +263,6 @@ By default, NGINX Agent rotates logs daily using logrotate with the following co ``` -If you need to make changes to the default configuration you can update the file here `/etc/logrotate.d/nginx-agent` +If you need to change the default configuration, update the file at `/etc/logrotate.d/nginx-agent`. -For more detail on logrotate configuration see [Logrotate Configuration Options](https://linux.die.net/man/8/logrotate) +For more details on logrotate configuration, see [Logrotate Configuration Options](https://linux.die.net/man/8/logrotate). \ No newline at end of file diff --git a/site/layouts/agent-v2-migration/single.html b/site/layouts/agent-v2-migration/single.html index 63877b632..e91863080 100644 --- a/site/layouts/agent-v2-migration/single.html +++ b/site/layouts/agent-v2-migration/single.html @@ -15,7 +15,7 @@
    NGINX Agent v3 is available!

    - This documentation is for NGINX Agent v2. We suggest reading the Migrate from NGINX Agent v2 to v3 topic to learn the differences between the two versions, and learn how to upgrade your instances. + This documentation is for NGINX Agent v2. We suggest reading the Migrate from NGINX Agent v2 to v3 topic to learn the differences between the two versions, and learn how to upgrade your instances.
    From f5de81bccda4cc6d15c5170de68410deb8af7fe5 Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Wed, 25 Sep 2024 14:08:42 +0100 Subject: [PATCH 16/30] Create new pages, change IA and update page frontmatter --- .../configure-nginx-agent-group.md | 9 +-- .../configuration/connect-management-plane.md | 6 +- .../configuration/enable-interfaces.md | 61 ++++++++++++++++ .../configuration/encrypt-communication.md | 5 +- .../contribute/dev-environment-setup.md | 9 +-- .../start-mock-interface.md} | 72 +------------------ site/content/export-metrics.md | 2 +- .../container-environments/_index.md | 2 +- site/content/installation-upgrade/install.md | 14 ++++ .../installation-upgrade/migrate-v3.md | 4 +- .../content/installation-upgrade/uninstall.md | 2 +- site/content/installation-upgrade/upgrade.md | 2 +- 12 files changed, 93 insertions(+), 95 deletions(-) create mode 100644 site/content/configuration/enable-interfaces.md rename site/content/{installation-upgrade/getting-started.md => contribute/start-mock-interface.md} (71%) diff --git a/site/content/configuration/configure-nginx-agent-group.md b/site/content/configuration/configure-nginx-agent-group.md index 9aa87c9a0..9f51dac78 100644 --- a/site/content/configuration/configure-nginx-agent-group.md +++ b/site/content/configuration/configure-nginx-agent-group.md @@ -1,11 +1,8 @@ --- -title: "Add NGINX Users to nginx-agent group" -draft: false -weight: 300 +title: "Add users to nginx-agent group" toc: true -tags: [ "docs" ] -categories: ["configuration"] -doctypes: ["task"] +weight: 300 +docs: DOCS-000 --- ## Overview diff --git a/site/content/configuration/connect-management-plane.md b/site/content/configuration/connect-management-plane.md index c11c39c9a..488c1a3dd 100644 --- a/site/content/configuration/connect-management-plane.md +++ b/site/content/configuration/connect-management-plane.md @@ -1,10 +1,8 @@ --- title: "Connect to management plane" -weight: 400 toc: true -tags: [ "docs" ] -categories: ["configuration"] -doctypes: ["task"] +weight: 500 +docs: DOCS-000 --- ## Overview diff --git a/site/content/configuration/enable-interfaces.md b/site/content/configuration/enable-interfaces.md new file mode 100644 index 000000000..1eb0f05d2 --- /dev/null +++ b/site/content/configuration/enable-interfaces.md @@ -0,0 +1,61 @@ +--- +title: Enable gRPC and REST interfaces +toc: true +weight: 200 +docs: DOCS-000 +--- + +This document describes how to enable the gRPC and REST interfaces for NGINX Agent. + +## NGINX Agent settings + +If it doesn't already exist, create the `/etc/nginx-agent/` directory and copy the `nginx-agent.conf` file into it from the project root directory. + +```shell +sudo mkdir /etc/nginx-agent +sudo cp /nginx-agent.conf /etc/nginx-agent/ +``` + +Create the `agent-dynamic.conf` file, which is required for NGINX Agent to run. + +In Linux environments: +```shell +sudo touch /var/lib/nginx-agent/agent-dynamic.conf +``` + +In FreeBSD environments: +```shell +sudo touch /var/db/nginx-agent/agent-dynamic.conf +``` + +## Enable the gRPC interface + +Add the the following settings to `/etc/nginx-agent/nginx-agent.conf`: + +```yaml +server: + host: 127.0.0.1 # mock control plane host + grpcPort: 54789 # mock control plane gRPC port + +# gRPC TLS options - DISABLING TLS IS NOT RECOMMENDED FOR PRODUCTION +tls: + enable: false + skip_verify: true +``` + +For more information, see [Agent Protocol Definitions and Documentation](https://github.com/nginx/agent/tree/main/docs/proto/README.md). + +## Enable the REST interface + +The NGINX Agent REST interface can be exposed by validating the following lines in the `/etc/nginx-agent/nginx-agent.conf` file are present: + +```yaml +api: + # Set API address to allow remote management + host: 127.0.0.1 + # Set this value to a secure port number to prevent information leaks + port: 8038 + # REST TLS parameters + cert: ".crt" + key: ".key" +``` \ No newline at end of file diff --git a/site/content/configuration/encrypt-communication.md b/site/content/configuration/encrypt-communication.md index 3ff8b8e3c..1520d614d 100644 --- a/site/content/configuration/encrypt-communication.md +++ b/site/content/configuration/encrypt-communication.md @@ -1,9 +1,8 @@ --- title: Encrypt communication -tags: -- docs toc: true -weight: 200 +weight: 400 +docs: DOCS-000 --- ## Overview diff --git a/site/content/contribute/dev-environment-setup.md b/site/content/contribute/dev-environment-setup.md index 2fdbb67ae..e96de7370 100644 --- a/site/content/contribute/dev-environment-setup.md +++ b/site/content/contribute/dev-environment-setup.md @@ -1,11 +1,8 @@ --- -title: "Development environment Setup" -draft: false -weight: 200 +title: "Development environment setup" toc: true -tags: [ "docs" ] -categories: ["development"] -doctypes: ["task"] +weight: 200 +docs: DOCS-000 --- ## Overview diff --git a/site/content/installation-upgrade/getting-started.md b/site/content/contribute/start-mock-interface.md similarity index 71% rename from site/content/installation-upgrade/getting-started.md rename to site/content/contribute/start-mock-interface.md index 84f473a09..13f03a056 100644 --- a/site/content/installation-upgrade/getting-started.md +++ b/site/content/contribute/start-mock-interface.md @@ -1,7 +1,6 @@ --- -title: "Getting started" -toc: true -weight: 200 +title: Start mock control plane interface +weight: 100 docs: DOCS-000 --- @@ -37,59 +36,6 @@ INFO[0000] http listening at 54790 # mock control plane port INFO[0000] grpc listening at 54789 # grpc control plane port which NGINX Agent will report to ``` -## NGINX Agent settings - -If it doesn't already exist, create the `/etc/nginx-agent/` directory and copy the `nginx-agent.conf` file into it from the project root directory. - -```shell -sudo mkdir /etc/nginx-agent -sudo cp /nginx-agent.conf /etc/nginx-agent/ -``` - -Create the `agent-dynamic.conf` file, which is required for NGINX Agent to run. - -In Linux environments: -```shell -sudo touch /var/lib/nginx-agent/agent-dynamic.conf -``` - -In FreeBSD environments: -```shell -sudo touch /var/db/nginx-agent/agent-dynamic.conf -``` - -### Enable the gRPC interface - -Add the the following settings to `/etc/nginx-agent/nginx-agent.conf`: - -```yaml -server: - host: 127.0.0.1 # mock control plane host - grpcPort: 54789 # mock control plane gRPC port - -# gRPC TLS options - DISABLING TLS IS NOT RECOMMENDED FOR PRODUCTION -tls: - enable: false - skip_verify: true -``` - -For more information, see [Agent Protocol Definitions and Documentation](https://github.com/nginx/agent/tree/main/docs/proto/README.md). - -### Enable the REST interface - -The NGINX Agent REST interface can be exposed by validating the following lines in the `/etc/nginx-agent/nginx-agent.conf` file are present: - -```yaml -api: - # Set API address to allow remote management - host: 127.0.0.1 - # Set this value to a secure port number to prevent information leaks - port: 8038 - # REST TLS parameters - cert: ".crt" - key: ".key" -``` - The mock control plane can use either gRPC or REST protocols to communicate with NGINX Agent. ## Launch Swagger UI @@ -144,20 +90,6 @@ Open a web browser to view the mock control plane at [http://localhost:54790](ht For more NGINX Agent use cases, refer to the [NGINX Agent SDK examples](https://github.com/nginx/agent/tree/main/sdk/examples). -## systemd environments - -To start NGINX Agent on `systemd` systems, run the following command: - -```shell -sudo systemctl start nginx-agent -``` - -To enable NGINX Agent to start on boot, run the following command: - -```shell -sudo systemctl enable nginx-agent -``` - ## Logs NGINX Agent uses formatted log files to collect metrics. Expanding log formats and instance counts will also increase the size of the NGINX Agent log files. We recommend adding a separate partition for `/var/log/nginx-agent`. diff --git a/site/content/export-metrics.md b/site/content/export-metrics.md index d96433f8c..0045a68ff 100644 --- a/site/content/export-metrics.md +++ b/site/content/export-metrics.md @@ -22,7 +22,7 @@ docs: DOCS-000 To begin this task, you will require the following: -- A [working NGINX Agent instance]({{< ref "/installation-upgrade/getting-started.md" >}}). +- A [working NGINX Agent instance]({{< ref "/installation-upgrade/install.md" >}}). - - diff --git a/site/content/installation-upgrade/container-environments/_index.md b/site/content/installation-upgrade/container-environments/_index.md index 77393ca9b..bd7ec74ba 100644 --- a/site/content/installation-upgrade/container-environments/_index.md +++ b/site/content/installation-upgrade/container-environments/_index.md @@ -1,6 +1,6 @@ --- title: "Container environments" -weight: 500 +weight: 400 --- Learn how to build and run NGINX Agent docker images. \ No newline at end of file diff --git a/site/content/installation-upgrade/install.md b/site/content/installation-upgrade/install.md index 6b777f011..b79283b77 100644 --- a/site/content/installation-upgrade/install.md +++ b/site/content/installation-upgrade/install.md @@ -755,6 +755,20 @@ Use your system's package manager to install the package. Some examples: sudo pkg add nginx-agent-.pkg ``` +## systemd environments + +To start NGINX Agent on `systemd` systems, run the following command: + +```shell +sudo systemctl start nginx-agent +``` + +To enable NGINX Agent to start on boot, run the following command: + +```shell +sudo systemctl enable nginx-agent +``` + ## Verify that NGINX Agent is running Once you have installed NGINX Agent, you can verify that it is running with the following command: diff --git a/site/content/installation-upgrade/migrate-v3.md b/site/content/installation-upgrade/migrate-v3.md index 5aed25100..6f50a9f6d 100644 --- a/site/content/installation-upgrade/migrate-v3.md +++ b/site/content/installation-upgrade/migrate-v3.md @@ -1,6 +1,6 @@ --- title: Migrate from NGINX Agent v2 to v3 -weight: 600 +weight: 500 docs: DOCS-000 --- @@ -22,7 +22,7 @@ docs: DOCS-000 To begin this task, you will require the following: -- A [working NGINX Agent instance]({{< ref "/installation-upgrade/getting-started.md" >}}). +- A [working NGINX Agent instance]({{< ref "/installation-upgrade/install.md" >}}). - - diff --git a/site/content/installation-upgrade/uninstall.md b/site/content/installation-upgrade/uninstall.md index dc92535fd..2eb9f17fa 100644 --- a/site/content/installation-upgrade/uninstall.md +++ b/site/content/installation-upgrade/uninstall.md @@ -1,7 +1,7 @@ --- title: "Uninstall NGINX Agent" toc: true -weight: 400 +weight: 300 docs: DOCS-000 --- diff --git a/site/content/installation-upgrade/upgrade.md b/site/content/installation-upgrade/upgrade.md index b86c6f4a2..857f3c555 100644 --- a/site/content/installation-upgrade/upgrade.md +++ b/site/content/installation-upgrade/upgrade.md @@ -1,7 +1,7 @@ --- title: "Upgrade NGINX Agent" toc: true -weight: 300 +weight: 200 docs: DOCS-000 --- From a65e99940dd2fa91be9098041cf91d85563f7f43 Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Wed, 25 Sep 2024 16:32:43 +0100 Subject: [PATCH 17/30] Rename Configuration section, split getting started, update examples --- .../contribute/dev-environment-setup.md | 46 ++++++++--------- .../contribute/start-mock-interface.md | 51 ++++++------------- .../{configuration => how-to}/_index.md | 2 +- .../configuration-overview.md | 26 +++++++++- .../configure-agent-group.md} | 24 +++++---- .../connect-management-plane.md | 8 +-- .../enable-interfaces.md | 10 ++-- .../encrypt-communication.md | 18 +++---- site/content/{ => how-to}/export-metrics.md | 4 +- .../container-environments/docker-images.md | 31 ++++------- .../container-environments/docker-support.md | 6 +-- .../content/installation-upgrade/uninstall.md | 28 +++++----- .../container-environments/docker-images.md | 2 +- .../installation-upgrade/getting-started.md | 4 +- 14 files changed, 128 insertions(+), 132 deletions(-) rename site/content/{configuration => how-to}/_index.md (70%) rename site/content/{configuration => how-to}/configuration-overview.md (94%) rename site/content/{configuration/configure-nginx-agent-group.md => how-to/configure-agent-group.md} (91%) rename site/content/{configuration => how-to}/connect-management-plane.md (98%) rename site/content/{configuration => how-to}/enable-interfaces.md (86%) rename site/content/{configuration => how-to}/encrypt-communication.md (97%) rename site/content/{ => how-to}/export-metrics.md (98%) diff --git a/site/content/contribute/dev-environment-setup.md b/site/content/contribute/dev-environment-setup.md index e96de7370..3682dae72 100644 --- a/site/content/contribute/dev-environment-setup.md +++ b/site/content/contribute/dev-environment-setup.md @@ -7,55 +7,55 @@ docs: DOCS-000 ## Overview -Learn how to setup a Development Environment for NGINX Agent. +This page describes how to configure a development environment for NGINX Agent. -## Select an Operating System +While most Linux or FreeBSD operating systems can be used to contribute to the NGINX Agent project, the following steps have been designed for Ubuntu. -While most Linux or FreeBSD operating systems can be used to contribute to the NGINX Agent project, the following steps have been designed for Ubuntu. Ubuntu is packaged with most libraries required to build and run NGINX Agent, and is the recommended platform for NGINX Agent development. +Ubuntu is the recommended operating system for development, as it comes with most packages requires to build and run NGINX Agent. -## Install NGINX +## Before you begin -Follow the steps in the [Installation]({{< relref "/installation-upgrade/" >}}) section to download, install, and run NGINX and NGINX Agent. +To begin this task, you will require the following: -## Clone the NGINX Agent Repository +- A [working NGINX Agent instance]({{< ref "/installation-upgrade/install.md" >}}). +- A [Go installation](https://go.dev/dl/) of version 1.22.2 or newer. +- A [Protocol Buffer Compiler](https://grpc.io/docs/protoc-installation/) installation. -Using your preferred method, clone the NGINX Agent repository into your development directory. See [Cloning a GitHub Repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) for additional help. +You will also need a copy of the NGINX Agent repository, which you can clone using `git`: -## Installing Prerequisite Packages +```shell +git clone git@github.com:nginx/agent.git +``` + +Read [Cloning a repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) for more information + +Follow the steps in the [Installation]({{< relref "/installation-upgrade/install.md" >}}) topic to install NGINX Agent. + +## Install prerequisite packages Depending on the operating system distribution, it may be necessary to install the following packages in order to build NGINX Agent. Change to the NGINX Agent source directory: -```bash +```shell cd /agent ``` Install Make: -```bash +```shell sudo apt install make ``` -NGINX Agent is written in Go. You may [download Go](https://go.dev/doc/install) and follow installation instructions on the same page or run: -```bash -sudo apt install golang-go -``` - -Install Protoc: -```bash -sudo apt install -y protobuf-compiler -``` - Install NGINX Agent tools and dependencies: Before starting development on NGINX Agent, it is important to download and install the necessary tool and dependencies required by NGINX Agent. You can do this by running the following `make` command: -```bash +```shell make install-tools deps ``` -## Building NGINX Agent from Source Code +## Build NGINX Agent from source code Run the following commands to build and run NGINX Agent: -```bash +```shell make build sudo make run ``` diff --git a/site/content/contribute/start-mock-interface.md b/site/content/contribute/start-mock-interface.md index 13f03a056..dd2964b28 100644 --- a/site/content/contribute/start-mock-interface.md +++ b/site/content/contribute/start-mock-interface.md @@ -1,28 +1,29 @@ --- title: Start mock control plane interface -weight: 100 +toc: true +weight: 300 docs: DOCS-000 --- -## Overview +This document describes how to configure and run NGINX Agent using a mock interface ("control plane") for NGINX Agent to report to. -This document describes how to configure and run NGINX Agent using a mock interface ("control plane") for NGINX Agent to report to. +The mock interface is useful when developing NGINX Agent, as it allows you to view what metrics are being reported. -## Install NGINX +## Before you begin -Follow the [Install NGINX Agent]({{< relref "/installation-upgrade/" >}}) topic to download and install NGINX Agent. +To begin this task, you will require the following: -## Clone the NGINX Agent repository +- A [working NGINX Agent instance]({{< ref "/installation-upgrade/install.md" >}}). +- A [Go installation](https://go.dev/dl/) of version 1.22.2 or newer. +- A [go-swagger](https://goswagger.io/go-swagger/install/) installation. + +You will also need a copy of the NGINX Agent repository, which you can clone using `git`: ```shell git clone git@github.com:nginx/agent.git ``` -Read [Cloning a GitHub Repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) for more information - -## Install Go - -NGINX Agent and the Mock Control Plane are written in Go. Go 1.22.2 or higher is required to build and run either application from the source code directory. You can [download Go from the official website](https://go.dev/dl/). +Read [Cloning a repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) for more information ## Start the gRPC mock control plane @@ -38,9 +39,9 @@ INFO[0000] grpc listening at 54789 # grpc control plane port which NGINX Agent w The mock control plane can use either gRPC or REST protocols to communicate with NGINX Agent. -## Launch Swagger UI +To enable them, view the [Enable gRPC and REST interfaces]({{< relref "/how-to/enable-interfaces.md" >}}) topic. -Swagger UI requires goswagger be installed. See [instructions for installing goswagger](https://goswagger.io/install.html) for additional help. +## Launch Swagger UI To launch the Swagger UI for the REST interface run the following command: @@ -88,26 +89,4 @@ Open a web browser to view the mock control plane at [http://localhost:54790](ht - **configs/raw** - shows the actual configuration as it would live on the data plane - **metrics** - shows a buffer of metrics sent to the management plane (similar to what will be sent back in the REST API) -For more NGINX Agent use cases, refer to the [NGINX Agent SDK examples](https://github.com/nginx/agent/tree/main/sdk/examples). - -## Logs - -NGINX Agent uses formatted log files to collect metrics. Expanding log formats and instance counts will also increase the size of the NGINX Agent log files. We recommend adding a separate partition for `/var/log/nginx-agent`. - -{{< important >}} -Without log rotation or storage on a separate partition, log files could use up all the free drive space and cause your system to become unresponsive to certain services. - -For more information, see [NGINX Agent Log Rotation]({{< relref "configuration/configuration-overview.md#nginx-agent-log-rotation" >}}). -{{< /important >}} - -## Extensions - -An extension is a piece of code, not critical to the main functionality that NGINX agent is responsible for. This generally falls outside the remit of managing NGINX Configuration and reporting NGINX metrics. - -To enable an extension, it must be added to the extensions list in the `/etc/nginx-agent/nginx-agent.conf`. -Here is an example of enabling the advanced metrics extension: - -```yaml -extensions: - - advanced-metrics -``` \ No newline at end of file +For more NGINX Agent use cases, refer to the [NGINX Agent SDK examples](https://github.com/nginx/agent/tree/main/sdk/examples). \ No newline at end of file diff --git a/site/content/configuration/_index.md b/site/content/how-to/_index.md similarity index 70% rename from site/content/configuration/_index.md rename to site/content/how-to/_index.md index d11c90b07..3f01dc82b 100644 --- a/site/content/configuration/_index.md +++ b/site/content/how-to/_index.md @@ -1,5 +1,5 @@ --- -title: "Configuration" +title: "How-to guides" weight: 500 --- diff --git a/site/content/configuration/configuration-overview.md b/site/content/how-to/configuration-overview.md similarity index 94% rename from site/content/configuration/configuration-overview.md rename to site/content/how-to/configuration-overview.md index eaae82db0..243dee533 100644 --- a/site/content/configuration/configuration-overview.md +++ b/site/content/how-to/configuration-overview.md @@ -233,7 +233,15 @@ Default location in FreeBSD environments: `/var/db/nginx-agent/agent-dynamic.con {{}} -## Log rotation +## Logs + +NGINX Agent uses formatted log files to collect metrics. Expanding log formats and instance counts will also increase the size of the NGINX Agent log files. + +We recommend adding a separate partition for `/var/log/nginx-agent`. + +{{< important >}} +Without log rotation or storage on a separate partition, log files could use up all the free drive space and cause your system to become unresponsive to certain services. +{{< /important >}} By default, NGINX Agent rotates logs daily using logrotate with the following configuration: @@ -265,4 +273,18 @@ By default, NGINX Agent rotates logs daily using logrotate with the following co If you need to change the default configuration, update the file at `/etc/logrotate.d/nginx-agent`. -For more details on logrotate configuration, see [Logrotate Configuration Options](https://linux.die.net/man/8/logrotate). \ No newline at end of file +For more details on logrotate configuration, see [Logrotate Configuration Options](https://linux.die.net/man/8/logrotate). + + +## Extensions + +An extension is noncritical code to the main functionality of NGINX Agent. They generally cover functionality outside of managing NGINX configuration and reporting metrics. + +To enable an extension, it must be added to the extensions list in the `/etc/nginx-agent/nginx-agent.conf`. + +This example enables the advanced metrics extension: + +```yaml +extensions: + - advanced-metrics +``` \ No newline at end of file diff --git a/site/content/configuration/configure-nginx-agent-group.md b/site/content/how-to/configure-agent-group.md similarity index 91% rename from site/content/configuration/configure-nginx-agent-group.md rename to site/content/how-to/configure-agent-group.md index 9f51dac78..10f6407e2 100644 --- a/site/content/configuration/configure-nginx-agent-group.md +++ b/site/content/how-to/configure-agent-group.md @@ -1,7 +1,7 @@ --- title: "Add users to nginx-agent group" toc: true -weight: 300 +weight: 400 docs: DOCS-000 --- @@ -13,8 +13,9 @@ If you change the NGINX username after installing the NGINX Agent, you'll need t A failure to update the `nginx-agent` group when the NGINX username changes may result in non-compliance errors for NGINX Plus. +--- -## NGINX Socket +## NGINX socket NGINX Agent creates a socket in the default location `/var/run/nginx-agent/nginx.sock`. You can customize this location by editing the `nginx-agent.conf` file and setting the path similar to the following example: @@ -26,57 +27,58 @@ nginx: The socket server starts when the NGINX socket configuration is enabled; the socket configuration is enabled by default. +--- -## Add NGINX Users to nginx-agent Group +## Add NGINX Users to nginx-agent group To manually add NGINX users to the `nginx-agent` group, take the following steps: 1. Verify the `nginx-agent` group exists: - ```bash + ```shell sudo getent group | grep nginx-agent ``` The output looks similar to the following example: - ```bash + ```shell nginx-agent:x:1001:root,nginx ``` If the group doesn't exist, create it by running the following command: - ```bash + ```shell sudo groupadd nginx-agent ``` 2. Verify the ownership of `/var/run/nginx-agent` directory: - ```bash + ```shell ls -l /var/run/nginx-agent ``` The output looks similar to the following: - ```bash + ```shell total 0 srwxrwxr-x 1 root nginx-agent 0 Jun 13 10:51 nginx.sockvv ``` If the group ownership is not `nginx-agent`, change the ownership by running the following command: - ```bash + ```shell sudo chown :nginx-agent /var/run/nginx-agent ``` 3. To add NGINX user(s) to the `nginx-agent` group, run the following command: - ```bash + ```shell sudo usermod -a -G nginx-agent ``` For example to add the `nginx` user, take the following step: - ```bash + ```shell sudo usermod -a -G nginx-agent nginx ``` diff --git a/site/content/configuration/connect-management-plane.md b/site/content/how-to/connect-management-plane.md similarity index 98% rename from site/content/configuration/connect-management-plane.md rename to site/content/how-to/connect-management-plane.md index 488c1a3dd..0ed2f09a7 100644 --- a/site/content/configuration/connect-management-plane.md +++ b/site/content/how-to/connect-management-plane.md @@ -1,7 +1,7 @@ --- title: "Connect to management plane" toc: true -weight: 500 +weight: 600 docs: DOCS-000 --- @@ -50,7 +50,7 @@ To establish a mTLS connection between the NGINX Agent and the management plane ``` 2. Restart the NGINX Agent service: - ```bash + ```shell sudo systemctl restart nginx-agent ``` @@ -84,7 +84,7 @@ To establish a TLS connection between the NGINX Agent and the management plane s 2. Restart the NGINX Agent service: - ```bash + ```shell sudo systemctl restart nginx-agent ``` @@ -109,6 +109,6 @@ To establish an insecure connection between the NGINX Agent and the management p 2. Restart the NGINX Agent service: - ```bash + ```shell sudo systemctl restart nginx-agent ``` diff --git a/site/content/configuration/enable-interfaces.md b/site/content/how-to/enable-interfaces.md similarity index 86% rename from site/content/configuration/enable-interfaces.md rename to site/content/how-to/enable-interfaces.md index 1eb0f05d2..2183062fb 100644 --- a/site/content/configuration/enable-interfaces.md +++ b/site/content/how-to/enable-interfaces.md @@ -1,5 +1,5 @@ --- -title: Enable gRPC and REST interfaces +title: "Enable gRPC and REST interfaces" toc: true weight: 200 docs: DOCS-000 @@ -7,9 +7,9 @@ docs: DOCS-000 This document describes how to enable the gRPC and REST interfaces for NGINX Agent. -## NGINX Agent settings +## Before you begin -If it doesn't already exist, create the `/etc/nginx-agent/` directory and copy the `nginx-agent.conf` file into it from the project root directory. +If it doesn't already exist, create the directory `/etc/nginx-agent/`and copy the `nginx-agent.conf` file into it from the project root directory. ```shell sudo mkdir /etc/nginx-agent @@ -28,6 +28,8 @@ In FreeBSD environments: sudo touch /var/db/nginx-agent/agent-dynamic.conf ``` +--- + ## Enable the gRPC interface Add the the following settings to `/etc/nginx-agent/nginx-agent.conf`: @@ -45,6 +47,8 @@ tls: For more information, see [Agent Protocol Definitions and Documentation](https://github.com/nginx/agent/tree/main/docs/proto/README.md). +--- + ## Enable the REST interface The NGINX Agent REST interface can be exposed by validating the following lines in the `/etc/nginx-agent/nginx-agent.conf` file are present: diff --git a/site/content/configuration/encrypt-communication.md b/site/content/how-to/encrypt-communication.md similarity index 97% rename from site/content/configuration/encrypt-communication.md rename to site/content/how-to/encrypt-communication.md index 1520d614d..f48e08349 100644 --- a/site/content/configuration/encrypt-communication.md +++ b/site/content/how-to/encrypt-communication.md @@ -1,7 +1,7 @@ --- title: Encrypt communication toc: true -weight: 400 +weight: 500 docs: DOCS-000 --- @@ -39,7 +39,7 @@ The `cert-sni-name` value should match the SubjectAltName of the server certific To enable mTLS for the NGINX Agent from the command line, run the following command: -```bash +```shell nginx-agent --tls-cert "path-to-cert" --tls-key "path-to-key" --tls-ca "path-to-ca-cert" --tls-enable ``` @@ -47,7 +47,7 @@ nginx-agent --tls-cert "path-to-cert" --tls-key "path-to-key" --tls-ca "path-to- To enable mTLS for NGINX Agent using environment variables, run the following commands: -```bash +```shell NMS_TLS_CA="my-env-ca" NMS_TLS_KEY="my-env-key" NMS_TLS_CERT="my-env-cert" @@ -66,7 +66,7 @@ To enable server-side TLS you must have TLS enabled. See the following examples You can edit the `/etc/nginx-agent/nginx-agent.conf` file to enable server-side TLS. Make the following changes: -```bash +```shell tls: enable: true skip_verify: false @@ -76,7 +76,7 @@ tls: To enable server-side TLS from the command line, run the following command: -```bash +```shell nginx-agent --tls-enable ``` @@ -84,7 +84,7 @@ nginx-agent --tls-enable To enable server-side TLS using environment variables, run the following commands: -```bash +```shell NMS_TLS_ENABLE=true ``` @@ -98,7 +98,7 @@ NMS_TLS_ENABLE=true To enable server-side TLS with a self-signed certificate, you must have TLS enabled and set `skip_verify` to `true`, which disables hostname validation. Setting `skip_verify` can be done done only by updating the configuration file. See the following example: -```bash +```shell tls: enable: true skip_verify: true @@ -112,7 +112,7 @@ To enable insecure mode, you simply need to set `tls:enable` to `false`. Setting You can edit the `/etc/nginx-agent/nginx-agent.conf` file to enable insecure mode. Make the following changes: -```bash +```shell tls: enable: false ``` @@ -121,6 +121,6 @@ tls: To enable insecure mode using environment variables, run the following commands: -```bash +```shell NMS_TLS_ENABLE=false ``` diff --git a/site/content/export-metrics.md b/site/content/how-to/export-metrics.md similarity index 98% rename from site/content/export-metrics.md rename to site/content/how-to/export-metrics.md index 0045a68ff..896619480 100644 --- a/site/content/export-metrics.md +++ b/site/content/how-to/export-metrics.md @@ -1,6 +1,6 @@ --- title: "Export metrics data" -weight: 600 +weight: 300 docs: DOCS-000 --- @@ -26,12 +26,12 @@ To begin this task, you will require the following: - - - --- ## Export metrics data + --- ## See also diff --git a/site/content/installation-upgrade/container-environments/docker-images.md b/site/content/installation-upgrade/container-environments/docker-images.md index 22f76645c..56f622522 100644 --- a/site/content/installation-upgrade/container-environments/docker-images.md +++ b/site/content/installation-upgrade/container-environments/docker-images.md @@ -158,47 +158,36 @@ $ docker build -t nginx-agent . \ Here is an example of how to run the NGINX Agent container using Docker: -```console +```shell docker run --name nginx-agent -d nginx-agent ``` -{{}}To learn more about the configuration options, refer to the NGINX Agent [Configuration Overview]({{< relref "/configuration/configuration-overview" >}}).{{}} +{{< note >}} To learn more about the configuration options, refer to the [Configuration overview]({{< relref "/how-to/configuration-overview" >}}) topic. {{}} + +--- ### Enable the gRPC interface -To connect your NGINX Agent container to your NGINX One or NGINX Instance Manager instance, you must enable the gRPC interface. To do this, you must edit the NGINX Agent configuration file, *nginx-agent.conf*. For example: +To connect your NGINX Agent container to your NGINX One or NGINX Instance Manager instance, you must enable the gRPC interface. -```yaml -erver: - host: 127.0.0.1 # mock control plane host - grpcPort: 54789 # mock control plane gRPC port +The configuration required is explained in the [Enable the gRPC interface]({{< relref "/how-to/enable-interfaces.md#enable-the-grpc-interface" >}}) -# gRPC TLS options - DISABLING TLS IS NOT RECOMMENDED FOR PRODUCTION -tls: - enable: false - skip_verify: true -``` +--- ### Enable the REST interface -If your control plane requires REST API, you can expose NGINX Agent's REST API by editing the NGINX Agent configuration file, *nginx-agent.conf*. For example: - -```yaml -api: - host: 0.0.0.0 - port: 8038 -``` +If your control plane requires a REST API, you can [Enable the REST interface]({{< relref "/how-to/enable-interfaces.md#enable-the-rest-interfacee" >}}) for NGINX Agent. Once you have updated the *nginx-agent.conf* file, you can run the container with the updated **nginx-agent.conf** mounted and the port **8038** exposed with the following command: -```console +```shell docker run --name nginx-agent -d \ --mount type=bind,source="$(pwd)"/nginx-agent.conf,target=/etc/nginx-agent/nginx-agent.conf,readonly \ -p 127.0.0.1:8038:8038/tcp \ nginx-agent ``` -
    +--- ## Build the NGINX Agent images for specific OS targets diff --git a/site/content/installation-upgrade/container-environments/docker-support.md b/site/content/installation-upgrade/container-environments/docker-support.md index be0605ab5..28433512c 100644 --- a/site/content/installation-upgrade/container-environments/docker-support.md +++ b/site/content/installation-upgrade/container-environments/docker-support.md @@ -58,7 +58,7 @@ If no memory limit is set when starting the Docker container, then the memory li If a warning message similar to the following example is seen in the NGINX Agent logs, the swap memory limit for the Docker container is greater than the swap memory for the Docker host system: -```bash +```shell Swap memory limit specified for the container, ... is greater than the host system swap memory ... ``` @@ -66,7 +66,7 @@ The `system.swap.total` metric for the container matches the total swap memory f If a warning message similar to the following example is seen in the NGINX Agent logs, the Docker host system does not have cgroup swap limit capabilities enabled. To enable these capabilities, follow the steps below. -```bash +```shell Unable to collect Swap metrics because the file ... was not found ``` @@ -74,7 +74,7 @@ Unable to collect Swap metrics because the file ... was not found Run the following command to see if the cgroup swap limit capabilities are enabled: -```bash +```shell $ docker info | grep swap WARNING: No swap limit support ``` diff --git a/site/content/installation-upgrade/uninstall.md b/site/content/installation-upgrade/uninstall.md index 2eb9f17fa..4018b3bdf 100644 --- a/site/content/installation-upgrade/uninstall.md +++ b/site/content/installation-upgrade/uninstall.md @@ -35,13 +35,13 @@ Complete the following steps on each host where you've installed NGINX Agent: 1. Stop NGINX Agent: - ```bash + ```shell sudo systemctl stop nginx-agent ``` 1. To uninstall NGINX Agent, run the following command: - ```bash + ```shell sudo yum remove nginx-agent ``` @@ -51,13 +51,13 @@ Complete the following steps on each host where you've installed NGINX Agent: 1. Stop NGINX Agent: - ```bash + ```shell sudo systemctl stop nginx-agent ``` 1. To uninstall NGINX Agent, run the following command: - ```bash + ```shell sudo apt-get remove nginx-agent ``` @@ -69,13 +69,13 @@ Complete the following steps on each host where you've installed NGINX Agent: 1. Stop NGINX Agent: - ```bash + ```shell sudo systemctl stop nginx-agent ``` 1. To uninstall NGINX Agent, run the following command: - ```bash + ```shell sudo apt-get remove nginx-agent ``` @@ -87,13 +87,13 @@ Complete the following steps on each host where you've installed NGINX Agent: 1. Stop NGINX agent: - ```bash + ```shell sudo systemctl stop nginx-agent ``` 1. To uninstall NGINX agent, run the following command: - ```bash + ```shell sudo zypper remove nginx-agent ``` @@ -103,13 +103,13 @@ Complete the following steps on each host where you've installed NGINX agent: 1. Stop NGINX agent: - ```bash + ```shell sudo rc-service nginx-agent stop ``` 1. To uninstall NGINX agent, run the following command: - ```bash + ```shell sudo apk del nginx-agent ``` @@ -119,13 +119,13 @@ Complete the following steps on each host where you've installed NGINX agent: 1. Stop NGINX agent: - ```bash + ```shell sudo systemctl stop nginx-agent ``` 1. To uninstall NGINX agent, run the following command: - ```bash + ```shell sudo yum remove nginx-agent ``` @@ -135,12 +135,12 @@ Complete the following steps on each host where you've installed NGINX agent: 1. Stop NGINX agent: - ```bash + ```shell sudo service nginx-agent stop ``` 1. To uninstall NGINX agent, run the following command: - ```bash + ```shell sudo pkg delete nginx-agent ``` diff --git a/site/content/v2/installation-upgrade/container-environments/docker-images.md b/site/content/v2/installation-upgrade/container-environments/docker-images.md index cb164f60a..749bb7128 100644 --- a/site/content/v2/installation-upgrade/container-environments/docker-images.md +++ b/site/content/v2/installation-upgrade/container-environments/docker-images.md @@ -163,7 +163,7 @@ Here is an example of how to run the NGINX Agent container using Docker: docker run --name nginx-agent -d nginx-agent ``` -{{}}To learn more about the configuration options, refer to the NGINX Agent [Configuration Overview]({{< relref "/configuration/configuration-overview" >}}).{{}} +{{}}To learn more about the configuration options, refer to the NGINX Agent [Configuration Overview]({{< relref "/how-to/configuration-overview.md" >}}).{{}} ### Enable the gRPC interface diff --git a/site/content/v2/installation-upgrade/getting-started.md b/site/content/v2/installation-upgrade/getting-started.md index ebbacbdf3..2d2a32205 100644 --- a/site/content/v2/installation-upgrade/getting-started.md +++ b/site/content/v2/installation-upgrade/getting-started.md @@ -177,5 +177,5 @@ NGINX Agent uses formatted log files to collect metrics. Expanding log formats a {{< important >}} Without log rotation or storage on a separate partition, log files could use up all the free drive space and cause your system to become unresponsive to certain services. -For more information, see [NGINX Agent Log Rotation]({{< relref "configuration/configuration-overview.md#nginx-agent-log-rotation" >}}). -{{< /important >}} +For more information, see [NGINX Agent Log Rotation]({{< relref "/how-to/configuration-overview.md#nginx-agent-log-rotation" >}}). +{{< /important >}} \ No newline at end of file From 6fc0246d9ad31997f01d398e8928a086e9b4146d Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Wed, 25 Sep 2024 17:06:19 +0100 Subject: [PATCH 18/30] Add guidance towards configuring interfaces to install document --- site/content/about.md | 20 ++++++++++++++++++-- site/content/how-to/configure-agent-group.md | 2 ++ site/content/installation-upgrade/install.md | 8 +++++++- 3 files changed, 27 insertions(+), 3 deletions(-) diff --git a/site/content/about.md b/site/content/about.md index 5efc7bce6..7b48e51c5 100644 --- a/site/content/about.md +++ b/site/content/about.md @@ -5,6 +5,8 @@ toc: true docs: DOCS-000 --- +This page provides a brief overview of what NGINX Agent is, and how it works. + ## Overview NGINX Agent is a companion daemon for your NGINX Open Source or NGINX Plus instance. It enables: @@ -13,7 +15,7 @@ NGINX Agent is a companion daemon for your NGINX Open Source or NGINX Plus insta - Collection and reporting of real-time NGINX performance and operating system metrics - Notifications of NGINX events -[OpenTelemetry](https://opentelemetry.io/) support comes with NGINX Agent v3, and the ability to [export the metrics data](http://localhost:1313/nginx-agent/export-metrics/) for use in other applications. +[OpenTelemetry](https://opentelemetry.io/) support comes with NGINX Agent v3, and the ability to [export the metrics data]({{< relref "/how-to/export-metrics.md" >}}) for use in other applications. For an overview of the metrics available from NGINX Agent, read the following topics: @@ -23,9 +25,13 @@ For an overview of the metrics available from NGINX Agent, read the following to {{< img src="grafana-dashboard-example.png" caption="A Grafana dashboard displaying metrics reported by NGINX Agent." alt="A Grafana dashboard displaying metrics reported by NGINX Agent.">}} +--- + ## How it works -NGINX Agent runs as a companion process on a system running NGINX. It provides gRPC and REST interfaces for configuration management and metrics collection from the NGINX process and operating system. NGINX Agent enables remote interaction with NGINX using common Linux tools and unlocks the ability to build sophisticated monitoring and control systems that can manage large collections of NGINX instances. +NGINX Agent runs as a companion process on a system running NGINX. It provides gRPC and REST interfaces for configuration management and metrics collection from the NGINX process and operating system. + +NGINX Agent enables remote interaction with NGINX using common Linux tools and unlocks the ability to build sophisticated monitoring and control systems that can manage large collections of NGINX instances. {{< img src="agent-flow.png" caption="How Agent works" alt="How NGINX Agent works" width="99%">}} @@ -34,18 +40,28 @@ NGINX Agent runs as a companion process on a system running NGINX. It provides g NGINX Agent provides an API interface for submission of updated configuration files. Upon receipt of a new file, it checks the output of `nginx -V` to determine the location of existing configurations. It then validates the new configuration with `nginx -t` before applying it via a signal HUP to the NGINX master process. +For additional information, view the [Configuration overview]({{< relref "/how-to/configuration-overview.md" >}}) topic. + +--- + ## Collecting metrics NGINX Agent interfaces with NGINX process information and parses NGINX logs to calculate and report metrics. When interfacing with NGINX Plus, NGINX Agent pulls relevant information from the NGINX Plus API. Reported metrics may be aggregated by [Prometheus](https://prometheus.io/) and visualized with tools like [Grafana](https://grafana.com/). +--- + ### NGINX Open Source When running alongside an open source instance of NGINX, NGINX Agent requires that NGINX Access and Error logs are turned on and contain all default variables. +--- + ### NGINX Plus For NGINX Agent to work properly with an NGINX Plus instance, the API needs to be configured in that instance's nginx.conf. View the [Instance Metrics Overview](https://docs.nginx.com/nginx-management-suite/nim/about/overview-metrics/) topic for more details. Once NGINX Plus is configured with the `/api/` endpoint, the Agent will automatically use it on startup. +--- + ## Event notifications NGINX Agent allows a gRPC connected control system to register a listener for a specific event. The control mechanism is then invoked when NGINX Agent sends an associated system signal. The source of a notification can be either the NGINX instance or NGINX Agent itself. Here's a list of currently supported events: diff --git a/site/content/how-to/configure-agent-group.md b/site/content/how-to/configure-agent-group.md index 10f6407e2..c4e43d3d4 100644 --- a/site/content/how-to/configure-agent-group.md +++ b/site/content/how-to/configure-agent-group.md @@ -5,6 +5,8 @@ weight: 400 docs: DOCS-000 --- +This page describes how the NGINX Agent process interacts with the NGINX user on a system, and how to add users to the NGINX Agent group. + ## Overview During installation, NGINX Agent detects the NGINX user (typically `nginx`) for the master and worker processes and adds this user to a group called `nginx-agent`. diff --git a/site/content/installation-upgrade/install.md b/site/content/installation-upgrade/install.md index b79283b77..83aee2757 100644 --- a/site/content/installation-upgrade/install.md +++ b/site/content/installation-upgrade/install.md @@ -775,4 +775,10 @@ Once you have installed NGINX Agent, you can verify that it is running with the ```shell sudo nginx-agent -v -``` \ No newline at end of file +``` + +## Enable interfaces + +Once NGINX Agent is successfully running, you can enable the required interfaces, which is described in the [Enable gRPC and REST interfaces]({{< relref "/how-to/enable-interfaces.md" >}}) topic. + +You may also be interested in the [Start mock control plane interface]({{< relref "/contribute/start-mock-interface.md" >}}) topic for development work. \ No newline at end of file From 2a9aaf508d41d7c194e3f8652ec286217722f094 Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Thu, 26 Sep 2024 11:50:11 +0100 Subject: [PATCH 19/30] Add Support page --- site/content/changelog.md | 2 +- site/content/contribute/_index.md | 2 +- site/content/support.md | 15 +++++++++++++++ 3 files changed, 17 insertions(+), 2 deletions(-) create mode 100644 site/content/support.md diff --git a/site/content/changelog.md b/site/content/changelog.md index 114c6d28b..07f23553f 100644 --- a/site/content/changelog.md +++ b/site/content/changelog.md @@ -1,6 +1,6 @@ --- title: "Changelog" -weight: 800 +weight: 700 toc: true --- diff --git a/site/content/contribute/_index.md b/site/content/contribute/_index.md index 08f789713..9eebf5403 100644 --- a/site/content/contribute/_index.md +++ b/site/content/contribute/_index.md @@ -1,6 +1,6 @@ --- title: "Contribute" -weight: "700" +weight: 600 --- Learn about the NGINX Agent community and how to contribute to the project. \ No newline at end of file diff --git a/site/content/support.md b/site/content/support.md new file mode 100644 index 000000000..0c7fff1bf --- /dev/null +++ b/site/content/support.md @@ -0,0 +1,15 @@ +--- +title: Support +weight: 800 +docs: DOCS-000 +--- + +## Support policy +F5 NGINX Agent adheres to the support policy detailed in the following knowledge base article: [K000140156](https://my.f5.com/manage/s/article/K000140156). + +## Contact F5 Support +For questions and/or assistance with installing, troubleshooting, or using NGINX Agent, contact Support via the [MyF5 Customer Portal](https://account.f5.com/myf5). + +## Community support +- If you experience issues with NGINX Agent, please [open an issue in GitHub](https://github.com/nginx/agent/issues/new). +- If you have any suggestions or feature requests, please [open an idea in GitHub discussions](https://github.com/nginx/agent/discussions). \ No newline at end of file From 99a18caa8981da264861fe006e7d1a21c0c1cae2 Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Thu, 26 Sep 2024 15:51:18 +0100 Subject: [PATCH 20/30] Add F5 prefix to first product mention on pages, clean frontmatter --- site/content/about.md | 2 +- site/content/contribute/community.md | 9 ++++----- site/content/contribute/dev-environment-setup.md | 2 +- site/content/contribute/start-mock-interface.md | 2 +- site/content/how-to/configuration-overview.md | 4 ++-- site/content/how-to/configure-agent-group.md | 2 +- site/content/how-to/connect-management-plane.md | 2 +- site/content/how-to/enable-interfaces.md | 2 +- site/content/how-to/encrypt-communication.md | 4 ++-- site/content/how-to/export-metrics.md | 2 ++ .../container-environments/docker-images.md | 10 +++------- .../container-environments/docker-support.md | 10 +++------- site/content/installation-upgrade/install.md | 2 +- site/content/installation-upgrade/migrate-v3.md | 2 ++ site/content/installation-upgrade/uninstall.md | 3 +-- site/content/installation-upgrade/upgrade.md | 2 +- site/content/metrics.md | 2 +- site/content/technical-specifications.md | 9 +++------ 18 files changed, 31 insertions(+), 40 deletions(-) diff --git a/site/content/about.md b/site/content/about.md index 7b48e51c5..02778fc1d 100644 --- a/site/content/about.md +++ b/site/content/about.md @@ -5,7 +5,7 @@ toc: true docs: DOCS-000 --- -This page provides a brief overview of what NGINX Agent is, and how it works. +This page provides a brief overview of what F5 NGINX Agent is, and how it works. ## Overview diff --git a/site/content/contribute/community.md b/site/content/contribute/community.md index 4eea3d22a..3fbf8f161 100644 --- a/site/content/contribute/community.md +++ b/site/content/contribute/community.md @@ -1,13 +1,12 @@ --- title: "Community and contribution" -draft: false -weight: 100 toc: true -tags: [ "docs" ] -categories: ["configuration"] -doctypes: ["task"] +weight: 100 +docs: DOCS-000 --- +This topic describes the various ways you can get involved with the F5 NGINX Agent project. + # Community - Our [Slack channel #nginx-agent](https://nginxcommunity.slack.com/), is the go-to place to start asking questions and sharing your thoughts. diff --git a/site/content/contribute/dev-environment-setup.md b/site/content/contribute/dev-environment-setup.md index 3682dae72..17cada7f6 100644 --- a/site/content/contribute/dev-environment-setup.md +++ b/site/content/contribute/dev-environment-setup.md @@ -7,7 +7,7 @@ docs: DOCS-000 ## Overview -This page describes how to configure a development environment for NGINX Agent. +This page describes how to configure a development environment for F5 NGINX Agent. While most Linux or FreeBSD operating systems can be used to contribute to the NGINX Agent project, the following steps have been designed for Ubuntu. diff --git a/site/content/contribute/start-mock-interface.md b/site/content/contribute/start-mock-interface.md index dd2964b28..36457bca1 100644 --- a/site/content/contribute/start-mock-interface.md +++ b/site/content/contribute/start-mock-interface.md @@ -5,7 +5,7 @@ weight: 300 docs: DOCS-000 --- -This document describes how to configure and run NGINX Agent using a mock interface ("control plane") for NGINX Agent to report to. +This document describes how to configure and run F5 NGINX Agent using a mock interface ("control plane") for NGINX Agent to report to. The mock interface is useful when developing NGINX Agent, as it allows you to view what metrics are being reported. diff --git a/site/content/how-to/configuration-overview.md b/site/content/how-to/configuration-overview.md index 243dee533..26c2a41b2 100644 --- a/site/content/how-to/configuration-overview.md +++ b/site/content/how-to/configuration-overview.md @@ -2,10 +2,10 @@ title: "Configuration overview" toc: true weight: 100 -docs: "DOCS-1229" +docs: DOCS-1229 --- -This page describes how to configure NGINX Agent using configuration files, CLI (Command line interface) flags, and environment variables. +This page describes how to configure F5 NGINX Agent using configuration files, CLI (Command line interface) flags, and environment variables. {{}} diff --git a/site/content/how-to/configure-agent-group.md b/site/content/how-to/configure-agent-group.md index c4e43d3d4..dbfd3c6dd 100644 --- a/site/content/how-to/configure-agent-group.md +++ b/site/content/how-to/configure-agent-group.md @@ -5,7 +5,7 @@ weight: 400 docs: DOCS-000 --- -This page describes how the NGINX Agent process interacts with the NGINX user on a system, and how to add users to the NGINX Agent group. +This page describes how the F5 NGINX Agent process interacts with the NGINX user on a system, and how to add users to the NGINX Agent group. ## Overview diff --git a/site/content/how-to/connect-management-plane.md b/site/content/how-to/connect-management-plane.md index 0ed2f09a7..c0919d65e 100644 --- a/site/content/how-to/connect-management-plane.md +++ b/site/content/how-to/connect-management-plane.md @@ -7,7 +7,7 @@ docs: DOCS-000 ## Overview -To monitor and manage all your NGINX Agent instances from a central management plane server, you first need to connect your instances and the server. You can configure the connection by making the required changes to the NGINX Agent configuration file. +To monitor and manage all your F5 NGINX Agent instances from a central management plane server, you first need to connect your instances and the server. You can configure the connection by making the required changes to the NGINX Agent configuration file. There are three types of connections you can establish between the NGINX Agent and the management plane server: diff --git a/site/content/how-to/enable-interfaces.md b/site/content/how-to/enable-interfaces.md index 2183062fb..a9447f4d7 100644 --- a/site/content/how-to/enable-interfaces.md +++ b/site/content/how-to/enable-interfaces.md @@ -5,7 +5,7 @@ weight: 200 docs: DOCS-000 --- -This document describes how to enable the gRPC and REST interfaces for NGINX Agent. +This document describes how to enable the gRPC and REST interfaces for F5 NGINX Agent. ## Before you begin diff --git a/site/content/how-to/encrypt-communication.md b/site/content/how-to/encrypt-communication.md index f48e08349..00876ffc4 100644 --- a/site/content/how-to/encrypt-communication.md +++ b/site/content/how-to/encrypt-communication.md @@ -1,5 +1,5 @@ --- -title: Encrypt communication +title: "Encrypt communication" toc: true weight: 500 docs: DOCS-000 @@ -7,7 +7,7 @@ docs: DOCS-000 ## Overview -Follow the steps in this guide to encrypt communication between NGINX Agent and Instance Manager with TLS. +Follow the steps in this guide to encrypt communication between F5 NGINX Agent and Instance Manager with TLS. ## Before You Begin diff --git a/site/content/how-to/export-metrics.md b/site/content/how-to/export-metrics.md index 896619480..a686921c6 100644 --- a/site/content/how-to/export-metrics.md +++ b/site/content/how-to/export-metrics.md @@ -4,6 +4,8 @@ weight: 300 docs: DOCS-000 --- +This document describes how to export the metrics data from F5 NGINX Agent. + [//]: # "These are Markdown comments to guide you through document structure." [//]: # "Remove them as you go, as well as unnecessary sections for this use case." diff --git a/site/content/installation-upgrade/container-environments/docker-images.md b/site/content/installation-upgrade/container-environments/docker-images.md index 56f622522..28db5a6bd 100644 --- a/site/content/installation-upgrade/container-environments/docker-images.md +++ b/site/content/installation-upgrade/container-environments/docker-images.md @@ -1,22 +1,18 @@ --- title: "Build container images" -draft: false -weight: 100 toc: true -tags: [ "docs" ] -categories: ["configuration"] -doctypes: ["task"] +weight: 100 +docs: DOCS-000 --- ## Overview -NGINX Agent is a companion daemon for NGINX Open Source or NGINX Plus instances and must run in the same container to work. The NGINX Agent GitHub repository includes [Dockerfiles](https://github.com/nginx/agent/tree/main/scripts/docker) that you can use to build custom container images that bundle NGINX Agent with NGINX or NGINX Plus. +F5 NGINX Agent is a companion daemon for NGINX Open Source or NGINX Plus instances and must run in the same container to work. The NGINX Agent GitHub repository includes [Dockerfiles](https://github.com/nginx/agent/tree/main/scripts/docker) that you can use to build custom container images that bundle NGINX Agent with NGINX or NGINX Plus. If you want to use NGINX Agent with NGINX Plus, you need to purchase an NGINX Plus license. Contact your F5 Sales representative for assistance. See the requirements and supported operating systems in the [NGINX Agent Technical Specifications]({{< relref "technical-specifications.md" >}}) topic. - ## Set up your environment ### Install a container engine diff --git a/site/content/installation-upgrade/container-environments/docker-support.md b/site/content/installation-upgrade/container-environments/docker-support.md index 28433512c..558b08118 100644 --- a/site/content/installation-upgrade/container-environments/docker-support.md +++ b/site/content/installation-upgrade/container-environments/docker-support.md @@ -1,17 +1,13 @@ --- -title: Container support and troubleshooting -categories: -- installation -draft: false -tags: -- docs +title: "Container support and troubleshooting" toc: true weight: 200 +docs: DOCS-000 --- ## Overview -The NGINX Agent repository includes [Dockerfiles](https://github.com/nginx/agent/tree/main/scripts/docker) that can be used to [build custom container images]({{< relref "installation-upgrade/container-environments/docker-images.md" >}}). Images are created with an NGINX Open Source or NGINX Plus instance and are available for various operating systems. +The F5 NGINX Agent repository includes [Dockerfiles](https://github.com/nginx/agent/tree/main/scripts/docker) that can be used to [build custom container images]({{< relref "installation-upgrade/container-environments/docker-images.md" >}}). Images are created with an NGINX Open Source or NGINX Plus instance and are available for various operating systems. See the [Technical Specifications]({{< relref "/technical-specifications.md#container-support" >}}) for a list of supported operationg systems. diff --git a/site/content/installation-upgrade/install.md b/site/content/installation-upgrade/install.md index 83aee2757..95f651468 100644 --- a/site/content/installation-upgrade/install.md +++ b/site/content/installation-upgrade/install.md @@ -5,7 +5,7 @@ weight: 100 docs: DOCS-000 --- -This document describes the three main ways to install NGINX agent: +This document describes the three main ways to install F5 NGINX agent: - Using the NGINX Open Source repository - Using the NGINX Plus repository diff --git a/site/content/installation-upgrade/migrate-v3.md b/site/content/installation-upgrade/migrate-v3.md index 6f50a9f6d..f77206fef 100644 --- a/site/content/installation-upgrade/migrate-v3.md +++ b/site/content/installation-upgrade/migrate-v3.md @@ -4,6 +4,8 @@ weight: 500 docs: DOCS-000 --- +This topic describes how to migrate from F5 NGINX Agent v2 to NGINX Agent v3. + [//]: # "These are Markdown comments to guide you through document structure." [//]: # "Remove them as you go, as well as unnecessary sections for this use case." diff --git a/site/content/installation-upgrade/uninstall.md b/site/content/installation-upgrade/uninstall.md index 4018b3bdf..7fe869d58 100644 --- a/site/content/installation-upgrade/uninstall.md +++ b/site/content/installation-upgrade/uninstall.md @@ -7,8 +7,7 @@ docs: DOCS-000 ## Overview -Learn how to uninstall NGINX Agent from your system. - +Learn how to uninstall F5 NGINX Agent from your system. ## Before you begin diff --git a/site/content/installation-upgrade/upgrade.md b/site/content/installation-upgrade/upgrade.md index 857f3c555..55898a2bb 100644 --- a/site/content/installation-upgrade/upgrade.md +++ b/site/content/installation-upgrade/upgrade.md @@ -7,7 +7,7 @@ docs: DOCS-000 ## Overview -Learn how to upgrade NGINX Agent. +Learn how to upgrade F5 NGINX Agent. ## Upgrade NGINX Agent from version v2.31.0 or greater diff --git a/site/content/metrics.md b/site/content/metrics.md index e612adc3b..179f413b9 100644 --- a/site/content/metrics.md +++ b/site/content/metrics.md @@ -1,5 +1,5 @@ --- title: OpenTelemetry metrics -docs: DOCS-000 weight: 300 +docs: DOCS-000 --- \ No newline at end of file diff --git a/site/content/technical-specifications.md b/site/content/technical-specifications.md index e5de80187..6262c196c 100644 --- a/site/content/technical-specifications.md +++ b/site/content/technical-specifications.md @@ -1,16 +1,13 @@ --- title: "Technical specifications" -draft: false -weight: 200 toc: true -tags: [ "docs" ] -categories: ["development"] -doctypes: ["task"] +weight: 200 +docs: DOCS-000 --- ## Overview -This document provides technical specifications for NGINX Agent. It includes information on supported distributions, deployment environments, NGINX versions, sizing recommendations, and logging. +This document provides technical specifications for F5 NGINX Agent. It includes information on supported distributions, deployment environments, NGINX versions, sizing recommendations, and logging. ## Supported distributions From 89aca0560535978ca8b455135fccd8c2d4749e38 Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Thu, 26 Sep 2024 16:46:34 +0100 Subject: [PATCH 21/30] Clarify text, add links between relevant topics --- site/content/contribute/start-mock-interface.md | 10 ++++------ site/content/how-to/enable-interfaces.md | 8 +++++++- 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/site/content/contribute/start-mock-interface.md b/site/content/contribute/start-mock-interface.md index 36457bca1..baf343006 100644 --- a/site/content/contribute/start-mock-interface.md +++ b/site/content/contribute/start-mock-interface.md @@ -23,7 +23,7 @@ You will also need a copy of the NGINX Agent repository, which you can clone usi git clone git@github.com:nginx/agent.git ``` -Read [Cloning a repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) for more information +Read [Cloning a repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) for more information. ## Start the gRPC mock control plane @@ -31,8 +31,8 @@ Start the mock control plane by running the following command from the `agent` s ```shell go run sdk/examples/server.go - -# Command Output +``` +```text INFO[0000] http listening at 54790 # mock control plane port INFO[0000] grpc listening at 54789 # grpc control plane port which NGINX Agent will report to ``` @@ -49,9 +49,7 @@ To launch the Swagger UI for the REST interface run the following command: make launch-swagger-ui ``` -## Apply new NGINX Agent configuration - -Start or restart NGINX Agent to apply the new configuration. +## Start NGINX Agent Open another terminal window and start NGINX Agent. Issue the following command from the `agent` source code root directory. diff --git a/site/content/how-to/enable-interfaces.md b/site/content/how-to/enable-interfaces.md index a9447f4d7..70c9331c4 100644 --- a/site/content/how-to/enable-interfaces.md +++ b/site/content/how-to/enable-interfaces.md @@ -62,4 +62,10 @@ api: # REST TLS parameters cert: ".crt" key: ".key" -``` \ No newline at end of file +``` + +## Start NGINX Agent + +To apply the new configuration, NGINX Agent must be started or restarted. + +You may want to view the [Start mock control plane interface]({{< relref "/contribute/start-mock-interface.md" >}}) topic to test NGINX Agent, or view the [Configuration overview]({{< relref "/how-to/configuration-overview.md" >}}) for more options. \ No newline at end of file From 8ae30fcf8bc218f6f4b54ca1cc54133e1a2ae317 Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Thu, 26 Sep 2024 16:54:01 +0100 Subject: [PATCH 22/30] Add missing horizontal line break --- site/content/how-to/enable-interfaces.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/site/content/how-to/enable-interfaces.md b/site/content/how-to/enable-interfaces.md index 70c9331c4..c73557165 100644 --- a/site/content/how-to/enable-interfaces.md +++ b/site/content/how-to/enable-interfaces.md @@ -64,6 +64,8 @@ api: key: ".key" ``` +--- + ## Start NGINX Agent To apply the new configuration, NGINX Agent must be started or restarted. From ffa9ca2771fd06c0fb64851cfd61061fc9d3e811 Mon Sep 17 00:00:00 2001 From: Jack Hickey Date: Thu, 26 Sep 2024 14:19:48 +0100 Subject: [PATCH 23/30] Add hugo version check and theme update to Makefile Update README.md with correct make target behaviors Add hugo-entrypoint to allow extra commands when docker starts Update hugo theme version in go.mod --- site/go.mod | 4 +-- site/go.sum | 4 +-- site/hugo-entrypoint.sh | 4 +++ site/makefile | 64 +++++++++++++++++++++++++++++++++++++++++ 4 files changed, 72 insertions(+), 4 deletions(-) create mode 100755 site/hugo-entrypoint.sh create mode 100644 site/makefile diff --git a/site/go.mod b/site/go.mod index b1614296c..b7ac6b63a 100644 --- a/site/go.mod +++ b/site/go.mod @@ -1,5 +1,5 @@ module github.com/nginx/agent/site -go 1.18 +go 1.22.0 -require github.com/nginxinc/nginx-hugo-theme v0.41.14 // indirect +require github.com/nginxinc/nginx-hugo-theme v0.41.19 // indirect diff --git a/site/go.sum b/site/go.sum index 1cbbb6618..5dbffbf03 100644 --- a/site/go.sum +++ b/site/go.sum @@ -1,2 +1,2 @@ -github.com/nginxinc/nginx-hugo-theme v0.41.14 h1:OraNB01CdMJXufPddvIVt6qn6Mj38Z/XCVIWBgVtuY0= -github.com/nginxinc/nginx-hugo-theme v0.41.14/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M= +github.com/nginxinc/nginx-hugo-theme v0.41.19 h1:CyZOhU8q0p3nQ+ZTFRx7c/Dq9rxV1mShADIHz0vDoHo= +github.com/nginxinc/nginx-hugo-theme v0.41.19/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M= diff --git a/site/hugo-entrypoint.sh b/site/hugo-entrypoint.sh new file mode 100755 index 000000000..dc7212352 --- /dev/null +++ b/site/hugo-entrypoint.sh @@ -0,0 +1,4 @@ +#!/bin/sh + +hugo mod get -u github.com/nginxinc/nginx-hugo-theme +hugo $* diff --git a/site/makefile b/site/makefile new file mode 100644 index 000000000..bb62ce8b6 --- /dev/null +++ b/site/makefile @@ -0,0 +1,64 @@ +HUGO?=hugo +HUGO_VERSION?=$(shell hugo version 2>/dev/null | awk '{print $$2}' | cut -d '.' -f 2) +HUGO_IMG?=hugomods/hugo:std-go-git-0.134.3 + +THEME_MODULE = github.com/nginxinc/nginx-hugo-theme + +ifeq ($(shell [ $(HUGO_VERSION) -gt 133 2>/dev/null ] && echo true || echo false), true) + $(info Hugo is available and has a version greater than 133. Proceeding with build.) +else + $(warning Hugo is not available or using a version less than 134. Attempting to use docker. HUGO_VERSION=$(HUGO_VERSION)) + HUGO=docker run --rm -it -v ${CURDIR}:/src -p 1313:1313 ${HUGO_IMG} /src/hugo-entrypoint.sh + ifeq (, $(shell docker version 2> /dev/null)) + $(error Hugo (>0.134) or Docker are required to build the local previews.) + endif +endif + +MARKDOWNLINT?=markdownlint +MARKDOWNLINT_IMG?=ghcr.io/igorshubovych/markdownlint-cli:latest + +ifeq (, $(shell ${MARKDOWNLINT} version 2> /dev/null)) +ifeq (, $(shell docker version 2> /dev/null)) +else + MARKDOWNLINT=docker run --rm -i -v ${CURDIR}:/src --workdir /src ${MARKDOWNLINT_IMG} +endif +endif + +MARKDOWNLINKCHECK?=markdown-link-check +MARKDOWNLINKCHECK_IMG?=ghcr.io/tcort/markdown-link-check:stable + +ifeq (, $(shell ${MARKDOWNLINKCHECK} --version 2> /dev/null)) +ifeq (, $(shell docker version 2> /dev/null)) +else + MARKDOWNLINKCHECK=docker run --rm -it -v ${CURDIR}:/docs --workdir /docs ${MARKDOWNLINKCHECK_IMG} +endif +endif + + +.PHONY: docs docs-draft docs-local clean hugo-get hugo-tidy lint-markdown link-check + +docs: + ${HUGO} + +watch: + ${HUGO} --bind 0.0.0.0 -p 1313 server --disableFastRender + +drafts: + ${HUGO} --bind 0.0.0.0 -p 1313 server -D --disableFastRender + +clean: + [ -d "public" ] && rm -rf "public" + +hugo-get: + hugo mod get -u github.com/nginxinc/nginx-hugo-theme + +hugo-tidy: + hugo mod tidy + +hugo-update: hugo-get hugo-tidy + +lint-markdown: + ${MARKDOWNLINT} -c .markdownlint.yaml -- content + +link-check: + ${MARKDOWNLINKCHECK} $(shell find content -name '*.md') From c62155bd7b57baf14c6c85f4e4bcb3c620be8a6a Mon Sep 17 00:00:00 2001 From: Jack Hickey <133868041+nginx-jack@users.noreply.github.com> Date: Mon, 7 Oct 2024 11:29:08 +0100 Subject: [PATCH 24/30] Delete site/Makefile --- site/Makefile | 67 --------------------------------------------------- 1 file changed, 67 deletions(-) delete mode 100644 site/Makefile diff --git a/site/Makefile b/site/Makefile deleted file mode 100644 index 6b980f156..000000000 --- a/site/Makefile +++ /dev/null @@ -1,67 +0,0 @@ -HUGO?=hugo -HUGO_IMG?=hugomods/hugo:0.115.3 - -THEME_MODULE = github.com/nginxinc/nginx-hugo-theme -THEME_VERSION = 0.41.14 - -ifeq (, $(shell ${HUGO} version 2> /dev/null)) -ifeq (, $(shell docker version 2> /dev/null)) - $(error Docker and Hugo are not installed. Hugo (<0.91) or Docker are required to build the local preview.) -else - HUGO=docker run --rm -it -v ${CURDIR}:/src -p 1313:1313 ${HUGO_IMG} hugo --bind 0.0.0.0 -p 1313 -endif -endif - -MARKDOWNLINT?=markdownlint -MARKDOWNLINT_IMG?=ghcr.io/igorshubovych/markdownlint-cli:latest - -ifeq (, $(shell ${MARKDOWNLINT} version 2> /dev/null)) -ifeq (, $(shell docker version 2> /dev/null)) -ifneq (, $(shell $(NETLIFY) "true")) - $(error Docker and markdownlint are not installed. markdownlint or Docker are required to lint.) -endif -else - MARKDOWNLINT=docker run --rm -i -v ${CURDIR}:/src --workdir /src ${MARKDOWNLINT_IMG} -endif -endif - -MARKDOWNLINKCHECK?=markdown-link-check -MARKDOWNLINKCHECK_IMG?=ghcr.io/tcort/markdown-link-check:stable - -ifeq (, $(shell ${MARKDOWNLINKCHECK} --version 2> /dev/null)) -ifeq (, $(shell docker version 2> /dev/null)) -ifneq (, $(shell $(NETLIFY) "true")) - $(error Docker and markdown-link-check are not installed. markdown-link-check or Docker are required to check links.) -endif -else - MARKDOWNLINKCHECK=docker run --rm -it -v ${CURDIR}:/docs --workdir /docs ${MARKDOWNLINKCHECK_IMG} -endif -endif - -.PHONY: docs docs-draft docs-local clean hugo-get hugo-tidy lint-markdown link-check - -docs: - ${HUGO} - -watch: - ${HUGO} --bind 0.0.0.0 -p 1313 server --disableFastRender - -drafts: - ${HUGO} --bind 0.0.0.0 -p 1313 server -D --disableFastRender - -clean: - [ -d "public" ] && rm -rf "public" - -hugo-get: - hugo mod get $(THEME_MODULE)@v$(THEME_VERSION) - -hugo-tidy: - hugo mod tidy - -hugo-update: hugo-get hugo-tidy - -lint-markdown: - ${MARKDOWNLINT} -c .markdownlint.yaml -- content - -link-check: - ${MARKDOWNLINKCHECK} $(shell find content -name '*.md') \ No newline at end of file From fe23135159035318d5af71f47b5e86610086c78e Mon Sep 17 00:00:00 2001 From: Jack Hickey Date: Wed, 2 Oct 2024 13:46:02 +0100 Subject: [PATCH 25/30] Change casing of makefile to Makefile --- site/{makefile => Makefile} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename site/{makefile => Makefile} (100%) diff --git a/site/makefile b/site/Makefile similarity index 100% rename from site/makefile rename to site/Makefile From d8fafd0549c1473cfcf03cf08c5915891f7a0f07 Mon Sep 17 00:00:00 2001 From: Jack Hickey Date: Wed, 2 Oct 2024 16:58:00 +0100 Subject: [PATCH 26/30] enableGitInfo config and docs-action bump --- .github/workflows/docs-build-push.yml | 2 +- site/config/_default/config.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs-build-push.yml b/.github/workflows/docs-build-push.yml index b63b2ee3d..19aa1aa47 100644 --- a/.github/workflows/docs-build-push.yml +++ b/.github/workflows/docs-build-push.yml @@ -26,7 +26,7 @@ permissions: jobs: call-docs-build-push: - uses: nginxinc/docs-actions/.github/workflows/docs-build-push.yml@f88844356d32c94be057b60033b3a933bebabf77 # v1.0.5 + uses: nginxinc/docs-actions/.github/workflows/docs-build-push.yml@69843fb5d009e99750e50c23e90c23a899e4637e # v1.0.6 permissions: pull-requests: write # needed to write preview url comment to PR contents: read diff --git a/site/config/_default/config.toml b/site/config/_default/config.toml index beef81917..b7949266e 100644 --- a/site/config/_default/config.toml +++ b/site/config/_default/config.toml @@ -1,5 +1,5 @@ title = "NGINX Agent" -enableGitInfo = false +enableGitInfo = true baseURL = "/" publishDir = "public/nginx-agent" staticDir = ["static"] From 3775b7993bb48e4031c6383697699108031cd013 Mon Sep 17 00:00:00 2001 From: Jack Hickey Date: Mon, 7 Oct 2024 15:18:36 +0100 Subject: [PATCH 27/30] Fix docs docker failing without git context --- site/config/docker/config.toml | 1 + site/go.mod | 2 +- site/go.sum | 2 ++ site/hugo-entrypoint.sh | 2 +- 4 files changed, 5 insertions(+), 2 deletions(-) create mode 100644 site/config/docker/config.toml diff --git a/site/config/docker/config.toml b/site/config/docker/config.toml new file mode 100644 index 000000000..b9a32bfef --- /dev/null +++ b/site/config/docker/config.toml @@ -0,0 +1 @@ +enableGitInfo = false \ No newline at end of file diff --git a/site/go.mod b/site/go.mod index b7ac6b63a..2d812c2a6 100644 --- a/site/go.mod +++ b/site/go.mod @@ -2,4 +2,4 @@ module github.com/nginx/agent/site go 1.22.0 -require github.com/nginxinc/nginx-hugo-theme v0.41.19 // indirect +require github.com/nginxinc/nginx-hugo-theme v0.41.20 // indirect diff --git a/site/go.sum b/site/go.sum index 5dbffbf03..9b49cab4b 100644 --- a/site/go.sum +++ b/site/go.sum @@ -1,2 +1,4 @@ github.com/nginxinc/nginx-hugo-theme v0.41.19 h1:CyZOhU8q0p3nQ+ZTFRx7c/Dq9rxV1mShADIHz0vDoHo= github.com/nginxinc/nginx-hugo-theme v0.41.19/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M= +github.com/nginxinc/nginx-hugo-theme v0.41.20 h1:6BJGRGdHW17OpkC4qbcHARo9TRrJPFrALBjFltwedf8= +github.com/nginxinc/nginx-hugo-theme v0.41.20/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M= diff --git a/site/hugo-entrypoint.sh b/site/hugo-entrypoint.sh index dc7212352..7462155cd 100755 --- a/site/hugo-entrypoint.sh +++ b/site/hugo-entrypoint.sh @@ -1,4 +1,4 @@ #!/bin/sh hugo mod get -u github.com/nginxinc/nginx-hugo-theme -hugo $* +hugo --environment docker $* From bb55b2acb97d7680ef1f91f5f735411e47554770 Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Wed, 9 Oct 2024 12:23:17 +0100 Subject: [PATCH 28/30] feat: Fix issues caused by merge resolution, remove gerund filenames --- .../contribute/dev-environment-setup.md | 4 +- .../contribute/start-mock-interface.md | 2 +- site/content/how-to/export-metrics.md | 2 +- .../_index.md | 0 .../container-environments/_index.md | 0 .../container-environments/docker-images.md | 0 .../container-environments/docker-support.md | 2 +- .../install.md | 0 .../migrate-v3.md | 2 +- .../uninstall.md | 0 .../upgrade.md | 0 .../installation-upgrade/getting-started.md | 180 ------------------ .../container-environments/docker-support.md | 2 +- 13 files changed, 7 insertions(+), 187 deletions(-) rename site/content/{installation-upgrade => install-upgrade}/_index.md (100%) rename site/content/{installation-upgrade => install-upgrade}/container-environments/_index.md (100%) rename site/content/{installation-upgrade => install-upgrade}/container-environments/docker-images.md (100%) rename site/content/{installation-upgrade => install-upgrade}/container-environments/docker-support.md (92%) rename site/content/{installation-upgrade => install-upgrade}/install.md (100%) rename site/content/{installation-upgrade => install-upgrade}/migrate-v3.md (92%) rename site/content/{installation-upgrade => install-upgrade}/uninstall.md (100%) rename site/content/{installation-upgrade => install-upgrade}/upgrade.md (100%) delete mode 100644 site/content/installation-upgrade/getting-started.md diff --git a/site/content/contribute/dev-environment-setup.md b/site/content/contribute/dev-environment-setup.md index 17cada7f6..d56c064cb 100644 --- a/site/content/contribute/dev-environment-setup.md +++ b/site/content/contribute/dev-environment-setup.md @@ -17,7 +17,7 @@ Ubuntu is the recommended operating system for development, as it comes with mos To begin this task, you will require the following: -- A [working NGINX Agent instance]({{< ref "/installation-upgrade/install.md" >}}). +- A [working NGINX Agent instance]({{< ref "/install-upgrade/install.md" >}}). - A [Go installation](https://go.dev/dl/) of version 1.22.2 or newer. - A [Protocol Buffer Compiler](https://grpc.io/docs/protoc-installation/) installation. @@ -29,7 +29,7 @@ git clone git@github.com:nginx/agent.git Read [Cloning a repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) for more information -Follow the steps in the [Installation]({{< relref "/installation-upgrade/install.md" >}}) topic to install NGINX Agent. +Follow the steps in the [Installation]({{< relref "/install-upgrade/install.md" >}}) topic to install NGINX Agent. ## Install prerequisite packages Depending on the operating system distribution, it may be necessary to install the following packages in order to build NGINX Agent. diff --git a/site/content/contribute/start-mock-interface.md b/site/content/contribute/start-mock-interface.md index baf343006..2c148de78 100644 --- a/site/content/contribute/start-mock-interface.md +++ b/site/content/contribute/start-mock-interface.md @@ -13,7 +13,7 @@ The mock interface is useful when developing NGINX Agent, as it allows you to vi To begin this task, you will require the following: -- A [working NGINX Agent instance]({{< ref "/installation-upgrade/install.md" >}}). +- A [working NGINX Agent instance]({{< ref "/install-upgrade/install.md" >}}). - A [Go installation](https://go.dev/dl/) of version 1.22.2 or newer. - A [go-swagger](https://goswagger.io/go-swagger/install/) installation. diff --git a/site/content/how-to/export-metrics.md b/site/content/how-to/export-metrics.md index a686921c6..7bbd3a687 100644 --- a/site/content/how-to/export-metrics.md +++ b/site/content/how-to/export-metrics.md @@ -24,7 +24,7 @@ This document describes how to export the metrics data from F5 NGINX Agent. To begin this task, you will require the following: -- A [working NGINX Agent instance]({{< ref "/installation-upgrade/install.md" >}}). +- A [working NGINX Agent instance]({{< ref "/install-upgrade/install.md" >}}). - - diff --git a/site/content/installation-upgrade/_index.md b/site/content/install-upgrade/_index.md similarity index 100% rename from site/content/installation-upgrade/_index.md rename to site/content/install-upgrade/_index.md diff --git a/site/content/installation-upgrade/container-environments/_index.md b/site/content/install-upgrade/container-environments/_index.md similarity index 100% rename from site/content/installation-upgrade/container-environments/_index.md rename to site/content/install-upgrade/container-environments/_index.md diff --git a/site/content/installation-upgrade/container-environments/docker-images.md b/site/content/install-upgrade/container-environments/docker-images.md similarity index 100% rename from site/content/installation-upgrade/container-environments/docker-images.md rename to site/content/install-upgrade/container-environments/docker-images.md diff --git a/site/content/installation-upgrade/container-environments/docker-support.md b/site/content/install-upgrade/container-environments/docker-support.md similarity index 92% rename from site/content/installation-upgrade/container-environments/docker-support.md rename to site/content/install-upgrade/container-environments/docker-support.md index 558b08118..f6e41ad6f 100644 --- a/site/content/installation-upgrade/container-environments/docker-support.md +++ b/site/content/install-upgrade/container-environments/docker-support.md @@ -7,7 +7,7 @@ docs: DOCS-000 ## Overview -The F5 NGINX Agent repository includes [Dockerfiles](https://github.com/nginx/agent/tree/main/scripts/docker) that can be used to [build custom container images]({{< relref "installation-upgrade/container-environments/docker-images.md" >}}). Images are created with an NGINX Open Source or NGINX Plus instance and are available for various operating systems. +The F5 NGINX Agent repository includes [Dockerfiles](https://github.com/nginx/agent/tree/main/scripts/docker) that can be used to [build custom container images]({{< relref "/install-upgrade/container-environments/docker-images.md" >}}). Images are created with an NGINX Open Source or NGINX Plus instance and are available for various operating systems. See the [Technical Specifications]({{< relref "/technical-specifications.md#container-support" >}}) for a list of supported operationg systems. diff --git a/site/content/installation-upgrade/install.md b/site/content/install-upgrade/install.md similarity index 100% rename from site/content/installation-upgrade/install.md rename to site/content/install-upgrade/install.md diff --git a/site/content/installation-upgrade/migrate-v3.md b/site/content/install-upgrade/migrate-v3.md similarity index 92% rename from site/content/installation-upgrade/migrate-v3.md rename to site/content/install-upgrade/migrate-v3.md index f77206fef..fe9a0533f 100644 --- a/site/content/installation-upgrade/migrate-v3.md +++ b/site/content/install-upgrade/migrate-v3.md @@ -24,7 +24,7 @@ This topic describes how to migrate from F5 NGINX Agent v2 to NGINX Agent v3. To begin this task, you will require the following: -- A [working NGINX Agent instance]({{< ref "/installation-upgrade/install.md" >}}). +- A [working NGINX Agent instance]({{< ref "/install-upgrade/install.md" >}}). - - diff --git a/site/content/installation-upgrade/uninstall.md b/site/content/install-upgrade/uninstall.md similarity index 100% rename from site/content/installation-upgrade/uninstall.md rename to site/content/install-upgrade/uninstall.md diff --git a/site/content/installation-upgrade/upgrade.md b/site/content/install-upgrade/upgrade.md similarity index 100% rename from site/content/installation-upgrade/upgrade.md rename to site/content/install-upgrade/upgrade.md diff --git a/site/content/installation-upgrade/getting-started.md b/site/content/installation-upgrade/getting-started.md deleted file mode 100644 index e3be8c809..000000000 --- a/site/content/installation-upgrade/getting-started.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -title: "Getting started" -draft: false -weight: 100 -toc: true -tags: [ "docs" ] -categories: ["configuration"] -doctypes: ["task"] ---- - -## Overview - -Follow these steps to configure and run NGINX Agent and a mock interface ("control plane") to which NGINX Agent will report. - -## Install NGINX - -Follow the steps in the [Installation]({{< relref "/installation-upgrade/installation-github.md" >}}) section to download, install, and run NGINX. - -## Clone the NGINX Agent Repository - -Using your preferred method, clone the NGINX Agent repository into your development directory. See [Cloning a GitHub Repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) for additional help. - -## Install Go - -NGINX Agent and the Mock Control Plane are written in Go. Go 1.23.0 or higher is required to build and run either application from the source code directory. You can [download Go from the official website](https://go.dev/dl/). - -## Start the gRPC Mock Control Plane - -Start the mock control plane by running the following command from the `agent` source code root directory: - -```shell -go run sdk/examples/server.go - -# Command Output -INFO[0000] http listening at 54790 # mock control plane port -INFO[0000] grpc listening at 54789 # grpc control plane port which NGINX Agent will report to -``` - -## NGINX Agent Settings - -If it doesn't already exist, create the `/etc/nginx-agent/` directory and copy the `nginx-agent.conf` file into it from the project root directory. - -```shell -sudo mkdir /etc/nginx-agent -sudo cp /nginx-agent.conf /etc/nginx-agent/ -``` - -Create the `agent-dynamic.conf` file, which is required for NGINX Agent to run. - -In Linux environments: -```shell -sudo touch /var/lib/nginx-agent/agent-dynamic.conf -``` - -In FreeBSD environments: -```shell -sudo touch /var/db/nginx-agent/agent-dynamic.conf -``` - -### Enable the gRPC interface - -Add the the following settings to `/etc/nginx-agent/nginx-agent.conf`: - -```yaml -server: - host: 127.0.0.1 # mock control plane host - grpcPort: 54789 # mock control plane gRPC port - -# gRPC TLS options - DISABLING TLS IS NOT RECOMMENDED FOR PRODUCTION -tls: - enable: false - skip_verify: true -``` - -For more information, see [Agent Protocol Definitions and Documentation](https://github.com/nginx/agent/tree/main/docs/proto/README.md). - -### Enable the REST interface - -The NGINX Agent REST interface can be exposed by validating the following lines in the `/etc/nginx-agent/nginx-agent.conf` file are present: - -```yaml -api: - # Set API address to allow remote management - host: 127.0.0.1 - # Set this value to a secure port number to prevent information leaks - port: 8038 - # REST TLS parameters - cert: ".crt" - key: ".key" -``` - -The mock control plane can use either gRPC or REST protocols to communicate with NGINX Agent. - -## Launch Swagger UI - -Swagger UI requires goswagger be installed. See [instructions for installing goswagger](https://goswagger.io/install.html) for additional help. - -To launch the Swagger UI for the REST interface run the following command: - -```shell -make launch-swagger-ui -``` - -## Extensions - -An extension is a piece of code, not critical to the main functionality that NGINX agent is responsible for. This generally falls outside the remit of managing NGINX Configuration and reporting NGINX metrics. - -To enable an extension, it must be added to the extensions list in the `/etc/nginx-agent/nginx-agent.conf`. -Here is an example of enabling the advanced metrics extension: - -```yaml -extensions: - - advanced-metrics -``` - -## Start NGINX Agent - -If already running, restart NGINX Agent to apply the new configuration. Alternatively, if NGINX Agent is not running, you may run it from the source code root directory. - -Open another terminal window and start NGINX Agent. Issue the following command from the `agent` source code root directory. - -```shell -sudo make run - -# Command Output snippet -WARN[0000] Log level is info -INFO[0000] setting displayName to XXX -INFO[0000] NGINX Agent at with pid 12345, clientID=XXXXXX-XXXXXX-XXXXXX-XXXXXX-XXXXXX name=XXX -INFO[0000] NginxBinary initializing -INFO[0000] Commander initializing -INFO[0000] Comms initializing -INFO[0000] OneTimeRegistration initializing -INFO[0000] Registering XXXXXX-XXXXXX-XXXXXX-XXXXXX-XXXXXX -INFO[0000] Metrics initializing -INFO[0000] MetricsThrottle initializing -INFO[0000] DataPlaneStatus initializing -INFO[0000] MetricsThrottle waiting for report ready -INFO[0000] Metrics waiting for handshake to be completed -INFO[0000] ProcessWatcher initializing -INFO[0000] Extensions initializing -INFO[0000] FileWatcher initializing -INFO[0000] FileWatchThrottle initializing -INFO[0001] Events initializing -INFO[0001] OneTimeRegistration completed -``` - -Open a web browser to view the mock control plane at [http://localhost:54790](http://localhost:54790). The following links will be shown in the web interface: - -- **registered** - shows registration information of the data plane -- **nginxes** - lists the nginx instances on the data plane -- **configs** - shows the protobuf payload for NGINX configuration sent to the management plane -- **configs/chunked** - shows the split-up payloads sent to the management plane -- **configs/raw** - shows the actual configuration as it would live on the data plane -- **metrics** - shows a buffer of metrics sent to the management plane (similar to what will be sent back in the REST API) - -For more NGINX Agent use cases, refer to the [NGINX Agent SDK examples](https://github.com/nginx/agent/tree/main/sdk/examples). - -## Start and Enable Start on Boot - -To start NGINX Agent on `systemd` systems, run the following command: - -```shell -sudo systemctl start nginx-agent -``` - -To enable NGINX Agent to start on boot, run the following command: - -```shell -sudo systemctl enable nginx-agent -``` - -## Logs - -NGINX Agent uses formatted log files to collect metrics. Expanding log formats and instance counts will also increase the size of the NGINX Agent log files. We recommend adding a separate partition for `/var/log/nginx-agent`. - -{{< important >}} -Without log rotation or storage on a separate partition, log files could use up all the free drive space and cause your system to become unresponsive to certain services. - -For more information, see [NGINX Agent Log Rotation]({{< relref "configuration/configuration-overview.md#nginx-agent-log-rotation" >}}). -{{< /important >}} diff --git a/site/content/v2/installation-upgrade/container-environments/docker-support.md b/site/content/v2/installation-upgrade/container-environments/docker-support.md index 7123d9ee1..7736fa951 100644 --- a/site/content/v2/installation-upgrade/container-environments/docker-support.md +++ b/site/content/v2/installation-upgrade/container-environments/docker-support.md @@ -12,7 +12,7 @@ docs: "DOCS-909" ## Overview -The NGINX Agent repository includes [Dockerfiles](https://github.com/nginx/agent/tree/main/scripts/docker) that can be used to [build custom container images]({{< relref "installation-upgrade/container-environments/docker-images.md" >}}). Images are created with an NGINX Open Source or NGINX Plus instance and are available for various operating systems. +The NGINX Agent repository includes [Dockerfiles](https://github.com/nginx/agent/tree/main/scripts/docker) that can be used to [build custom container images]({{< relref "/v2/installation-upgrade/container-environments/docker-images.md" >}}). Images are created with an NGINX Open Source or NGINX Plus instance and are available for various operating systems. See the [Technical Specifications]({{< relref "/technical-specifications.md#container-support" >}}) for a list of supported operationg systems. From e62e55594eeae60f2fa9d4f9fc8fece8fe782c0b Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Wed, 9 Oct 2024 12:38:08 +0100 Subject: [PATCH 29/30] feat: Add a link to logging configuration from technical specifications --- site/content/technical-specifications.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/site/content/technical-specifications.md b/site/content/technical-specifications.md index 6262c196c..fac11fbdc 100644 --- a/site/content/technical-specifications.md +++ b/site/content/technical-specifications.md @@ -53,4 +53,8 @@ Minimum system sizing recommendations for NGINX Agent: ## Logging -NGINX Agent utilizes log files and formats to collect metrics. Increasing the log formats and instance counts will result in increased log file sizes. To prevent system storage issues due to a growing log directory, it is recommended to add a separate partition for `/var/log/nginx-agent` and enable [log rotation](http://nginx.org/en/docs/control.html#logs). \ No newline at end of file +NGINX Agent utilizes log files and formats to collect metrics. Increasing the log formats and instance counts will result in increased log file sizes. + +To prevent system storage issues due to a growing log directory, it is recommended to add a separate partition for `/var/log/nginx-agent` and enable [log rotation](http://nginx.org/en/docs/control.html#logs). + +More information is available in the [Configuration overview]({{< ref "/how-to/configuration-overview.md#logs" >}}) \ No newline at end of file From 1deb4d0eb8aa792b11237aff546114afdaa0ad84 Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Fri, 11 Oct 2024 15:40:29 +0100 Subject: [PATCH 30/30] Update Agent v2 changelog up to v2.38.0 --- site/content/v2/changelog.md | 221 ++++++++++++++++++++++------------- 1 file changed, 137 insertions(+), 84 deletions(-) diff --git a/site/content/v2/changelog.md b/site/content/v2/changelog.md index d4c587926..3885df663 100644 --- a/site/content/v2/changelog.md +++ b/site/content/v2/changelog.md @@ -10,202 +10,255 @@ docs: "DOCS-1093" See the list of supported Operating Systems and architectures in the [Technical Specifications]({{< relref "./technical-specifications.md" >}}). --- -## Release [v2.32.2](https//github.com/nginx/agent/releases/tag/v2.32.2) - -### 🌟 Highlights - -- This release fixes an issue where certain container runtimes were reporting as bare-metal hosts. - -### πŸš€ Features - -This release introduces the following new features: - -- feat: improve docker docs by [@Jcahilltorre](https://github.com/Jcahilltorre) in [#587](https://github.com/nginx/agent/pull/587) +## Release [v2.38.0](https://github.com/nginx/agent/releases/tag/v2.38.0) ### πŸ› Bug Fixes In this release we have resolved the following issues: -- Fix install-tools by [@Dean-Coakley](https://github.com/Dean-Coakley) in [#581](https://github.com/nginx/agent/pull/581) +- Fix broken URLS in docs by [@nginx-aoife](https://github.com/nginx-aoife) in [#796](https://github.com/nginx/agent/pull/796) +- fix name of deprecated flag by [@aphralG](https://github.com/aphralG) in [#811](https://github.com/nginx/agent/pull/811) +- Fix make image targets by [@dhurley](https://github.com/dhurley) in [#812](https://github.com/nginx/agent/pull/812) +- Fix debian oss image by [@dhurley](https://github.com/dhurley) in [#819](https://github.com/nginx/agent/pull/819) ### πŸ“ Documentation We have made the following updates to the documentation: -- change log updated for last release by [@oliveromahony](https://github.com/oliveromahony) in [#583](https://github.com/nginx/agent/pull/583) -- Restore agent container information from nms docs by [@jputrino](https://github.com/jputrino) in [#584](https://github.com/nginx/agent/pull/584) -- fix: add additional container checks during instance registration by [@mattdesmarais](https://github.com/mattdesmarais) in [#592](https://github.com/nginx/agent/pull/592) +- docs: update GPG keys by [@Jcahilltorre](https://github.com/Jcahilltorre) in [#776](https://github.com/nginx/agent/pull/776) +- Add new docker images to v2 pipeline for integration testing by [@oliveromahony](https://github.com/oliveromahony) in [#756](https://github.com/nginx/agent/pull/756) +- Update website changelog for v2.37.0 by [@ADubhlaoich](https://github.com/ADubhlaoich) in [#790](https://github.com/nginx/agent/pull/790) +- Pass on custom error log path at the time of validating config by [@achawla2012](https://github.com/achawla2012) in [#774](https://github.com/nginx/agent/pull/774) +- Remove blocking calls in metrics framework by [@oliveromahony](https://github.com/oliveromahony) in [#788](https://github.com/nginx/agent/pull/788) +- Update broken URL in installation-plus.md by [@nginx-aoife](https://github.com/nginx-aoife) in [#808](https://github.com/nginx/agent/pull/808) + +### πŸ”¨ Maintenance + +We have made the following maintenance-related minor changes: + +- add new plus docker images to v2 pipeline by [@aphralG](https://github.com/aphralG) in [#779](https://github.com/nginx/agent/pull/779) +- Add MaxRecvMsgSize and MaxSendMsgSize to client and server options by [@oliveromahony](https://github.com/oliveromahony) in [#795](https://github.com/nginx/agent/pull/795) +- added leak tests for agent v2 by [@oliveromahony](https://github.com/oliveromahony) in [#807](https://github.com/nginx/agent/pull/807) --- -## Release [v2.32.1](https//github.com/nginx/agent/releases/tag/v2.32.1) +## Release [v2.37.0](https://github.com/nginx/agent/releases/tag/v2.37.0) ### πŸš€ Features This release introduces the following new features: -- feat: Agent Docs IA refactor by [@Jcahilltorre](https://github.com/Jcahilltorre) in [#548](https://github.com/nginx/agent/pull/548) -- feat: move NMS agent docs by [@Jcahilltorre](https://github.com/Jcahilltorre) in [#553](https://github.com/nginx/agent/pull/553) -- feat: import changelog from github by [@Jcahilltorre](https://github.com/Jcahilltorre) in [#570](https://github.com/nginx/agent/pull/570) +- feat: Update the changelog by [@ADubhlaoich](https://github.com/ADubhlaoich) in [#753](https://github.com/nginx/agent/pull/753) ### πŸ› Bug Fixes In this release we have resolved the following issues: -- fix runners and bump go version by [@oliveromahony](https://github.com/oliveromahony) in [#550](https://github.com/nginx/agent/pull/550) -- Fix artifact name by [@oliveromahony](https://github.com/oliveromahony) in [#558](https://github.com/nginx/agent/pull/558) -- fix: add missing catalog entry by [@Jcahilltorre](https://github.com/Jcahilltorre) in [#572](https://github.com/nginx/agent/pull/572) +- Prevent writing outside allowed directories list from a config payload with actions by [@oliveromahony](https://github.com/oliveromahony) in [#766](https://github.com/nginx/agent/pull/766) +- The letter v is now always prepended to output of -v by [@olli-holmala](https://github.com/olli-holmala) in [#751](https://github.com/nginx/agent/pull/751) +- Fix backoff to drop Metrics Reports from buffer after max_elapsed_time has been reached by [@oliveromahony](https://github.com/oliveromahony) in [#752](https://github.com/nginx/agent/pull/752) +- Fix Post Install Script Issues by [@spencerugbo](https://github.com/spencerugbo) in [#739](https://github.com/nginx/agent/pull/739) +- docs: fix github links in changelog by [@Jcahilltorre](https://github.com/Jcahilltorre) in [#770](https://github.com/nginx/agent/pull/770) +- Fix post install script for when no nginx instance is installed by [@dhurley](https://github.com/dhurley) in [#773](https://github.com/nginx/agent/pull/773) ### πŸ“ Documentation We have made the following updates to the documentation: -- Runc bump by [@oliveromahony](https://github.com/oliveromahony) in [#565](https://github.com/nginx/agent/pull/565) +- Upgrade prometheus exporter version to latest by [@oliveromahony](https://github.com/oliveromahony) in [#749](https://github.com/nginx/agent/pull/749) +- Add badges for Go version, release, license, contributions, and Slack… by [@oCHRISo](https://github.com/oCHRISo) in [#763](https://github.com/nginx/agent/pull/763) +- Add instructions for Amazon Linux 2023 by [@nginx-seanmoloney](https://github.com/nginx-seanmoloney) in [#759](https://github.com/nginx/agent/pull/759) +- Add docs-build-push github workflow by [@nginx-jack](https://github.com/nginx-jack) in [#765](https://github.com/nginx/agent/pull/765) ### πŸ”¨ Maintenance We have made the following maintenance-related minor changes: -- bump vulnerable version of buildkit by [@oliveromahony](https://github.com/oliveromahony) in [#564](https://github.com/nginx/agent/pull/564) +- Increase timeout period for collecting metrics by [@oliveromahony](https://github.com/oliveromahony) in [#755](https://github.com/nginx/agent/pull/755) --- -## Release [v2.32.0](https//github.com/nginx/agent/releases/tag/v2.32.0) +## Release [v2.36.1](https://github.com/nginx/agent/releases/tag/v2.36.1) -### πŸš€ Features +### 🌟 Highlights -This release introduces the following new features: +- Upgrade crossplane version to prevent Agent from rolling back in the case of valid NGINX configurations by [@oliveromahony](https://github.com/oliveromahony) in [#746](https://github.com/nginx/agent/pull/746) + +### πŸ”¨ Maintenance -- feat: added the new OS support for NGINX R31 by [@oliveromahony](https://github.com/oliveromahony) in [#538](https://github.com/nginx/agent/pull/538) +We have made the following maintenance-related minor changes: + +- Added version regex to parse the logs to see if matches vsemvar format by [@oliveromahony](https://github.com/oliveromahony) in [#747](https://github.com/nginx/agent/pull/747) --- -## Release [v2.31.2](https//github.com/nginx/agent/releases/tag/v2.31.2) +## Release [v2.36.0](https://github.com/nginx/agent/releases/tag/v2.36.0) ### πŸ› Bug Fixes In this release we have resolved the following issues: -- chore: rename hugo folder to site, fix product naming by [@Jcahilltorre](https://github.com/Jcahilltorre) in [#527](https://github.com/nginx/agent/pull/527) +- Fix incorrect bold tag in heading by [@nginx-seanmoloney](https://github.com/nginx-seanmoloney) in [#715](https://github.com/nginx/agent/pull/715) +- URL fix for building docker image in README.md by [@y82](https://github.com/y82) in [#720](https://github.com/nginx/agent/pull/720) +- Fix for version by [@oliveromahony](https://github.com/oliveromahony) in [#732](https://github.com/nginx/agent/pull/732) ### πŸ“ Documentation We have made the following updates to the documentation: -- Update upgrade documentation by [@dhurley](https://github.com/dhurley) in [#526](https://github.com/nginx/agent/pull/526) -- Bump the versions of containerd and go-git dependencies by [@dhurley](https://github.com/dhurley) in [#533](https://github.com/nginx/agent/pull/533) -- updated dependencies by [@oliveromahony](https://github.com/oliveromahony) in [#536](https://github.com/nginx/agent/pull/536) - -### πŸ”¨ Maintenance - -We have made the following maintenance-related minor changes: - -- Bump crypto dependency from 0.14.0 to 0.17.0 by [@dhurley](https://github.com/dhurley) in [#532](https://github.com/nginx/agent/pull/532) +- More flexible container images for the official images by [@oliveromahony](https://github.com/oliveromahony) in [#729](https://github.com/nginx/agent/pull/729) +- Update configuration examples by [@nginx-seanmoloney](https://github.com/nginx-seanmoloney) in [#731](https://github.com/nginx/agent/pull/731) +- updated github.com/rs/cors version by [@oliveromahony](https://github.com/oliveromahony) in [#735](https://github.com/nginx/agent/pull/735) +- docs: update changelog by [@Jcahilltorre](https://github.com/Jcahilltorre) in [#736](https://github.com/nginx/agent/pull/736) +- Upgrade crossplane by [@oliveromahony](https://github.com/oliveromahony) in [#737](https://github.com/nginx/agent/pull/737) --- -## Release [v2.31.1](https//github.com/nginx/agent/releases/tag/v2.31.1) +## Release [v2.35.1](https://github.com/nginx/agent/releases/tag/v2.35.1) ### πŸ› Bug Fixes In this release we have resolved the following issues: -- Fix permissions for log file and dynamic config directory by [@aphralG](https://github.com/aphralG) in [#517](https://github.com/nginx/agent/pull/517) -- Fix server example in sdk to have timeout by [@aphralG](https://github.com/aphralG) in [#518](https://github.com/nginx/agent/pull/518) +- fix: add deduplication for the same ssl cert metadata by [@mattdesmarais](https://github.com/mattdesmarais) [@oliveromahony](https://github.com/oliveromahony) in [#716](https://github.com/nginx/agent/pull/716) +- Fix release workflow by [@dhurley](https://github.com/dhurley) in [#724](https://github.com/nginx/agent/pull/724) ### πŸ“ Documentation We have made the following updates to the documentation: -- Update SELinux Readme by [@aphralG](https://github.com/aphralG) in [#522](https://github.com/nginx/agent/pull/522) +- Update environment variables from NMS to NGINX_AGENT by [@spencerugbo](https://github.com/spencerugbo) in [#710](https://github.com/nginx/agent/pull/710) +- Update the flag & environment table callouts by [@ADubhlaoich](https://github.com/ADubhlaoich) in [#712](https://github.com/nginx/agent/pull/712) +- updated golang version to 1.22 by [@oliveromahony](https://github.com/oliveromahony) in [#717](https://github.com/nginx/agent/pull/717) ### πŸ”¨ Maintenance We have made the following maintenance-related minor changes: -- Replace mockgen by [@oliveromahony](https://github.com/oliveromahony) in [#524](https://github.com/nginx/agent/pull/524) -- Restrict config apply directory permissions by [@Dean-Coakley](https://github.com/Dean-Coakley) in [#519](https://github.com/nginx/agent/pull/519) -- Restrict NAP file/dir permissions by [@Dean-Coakley](https://github.com/Dean-Coakley) in [#516](https://github.com/nginx/agent/pull/516) +- More detailed test for env variables migration by [@oliveromahony](https://github.com/oliveromahony) in [#709](https://github.com/nginx/agent/pull/709) --- -## Release [v2.31.0](https//github.com/nginx/agent/releases/tag/v2.31.0) +## Release [v2.35.0](https://github.com/nginx/agent/releases/tag/v2.35.0) + +### 🌟 Highlights + +- R32 operating system support parity by [@oliveromahony](https://github.com/oliveromahony) in [#708](https://github.com/nginx/agent/pull/708) ### πŸ› Bug Fixes In this release we have resolved the following issues: -- Fix otelcontrib version by [@oliveromahony](https://github.com/oliveromahony) in [#504](https://github.com/nginx/agent/pull/504) -- Fix user agent request header to have the correct agent version by [@dhurley](https://github.com/dhurley) in [#498](https://github.com/nginx/agent/pull/498) -- Fix alpine plus dockerfile on alpine>=3.17 by [@Dean-Coakley](https://github.com/Dean-Coakley) in [#511](https://github.com/nginx/agent/pull/511) -- fix: avoid stopping nginx-agent service on package upgrade by [@defanator](https://github.com/defanator) in [#352](https://github.com/nginx/agent/pull/352) -- Fix SELinux Policy by [@aphralG](https://github.com/aphralG) in [#520](https://github.com/nginx/agent/pull/520) +- Change environment prefix from nms to nginx_agent by [@spencerugbo](https://github.com/spencerugbo) in [#706](https://github.com/nginx/agent/pull/706) ### πŸ“ Documentation We have made the following updates to the documentation: -- Add CLI arg to set dynamic config path by [@Dean-Coakley](https://github.com/Dean-Coakley) in [#490](https://github.com/nginx/agent/pull/490) - -### πŸ”¨ Maintenance - -We have made the following maintenance-related minor changes: - -- crossplane version bump by [@oliveromahony](https://github.com/oliveromahony) in [#512](https://github.com/nginx/agent/pull/512) -- Add commander retry lock by [@dhurley](https://github.com/dhurley) in [#502](https://github.com/nginx/agent/pull/502) -- Bump otel dependency version and fix github workflow for dependabot PRs by [@dhurley](https://github.com/dhurley) in [#515](https://github.com/nginx/agent/pull/515) +- Consolidated CLI flag and Env Var sections by [@travisamartin](https://github.com/travisamartin) in [#701](https://github.com/nginx/agent/pull/701) +- Add Ubuntu Noble 24.04 LTS support by [@Dean-Coakley](https://github.com/Dean-Coakley) in [#682](https://github.com/nginx/agent/pull/682) --- -## Release [v2.30.3](https//github.com/nginx/agent/releases/tag/v2.30.3) +## Release [v2.34.1](https://github.com/nginx/agent/releases/tag/v2.34.1) ### πŸ› Bug Fixes In this release we have resolved the following issues: -- Fix dependabot issues by [@oliveromahony](https://github.com/oliveromahony) in [#503](https://github.com/nginx/agent/pull/503) +- Fix metrics reporter retry logic by [@dhurley](https://github.com/dhurley) in [#700](https://github.com/nginx/agent/pull/700) + +### πŸ“ Documentation + +We have made the following updates to the documentation: + +- Update changelog for release 2.34 by [@ADubhlaoich](https://github.com/ADubhlaoich) in [#693](https://github.com/nginx/agent/pull/693) --- -## Release [v2.30.1](https//github.com/nginx/agent/releases/tag/v2.30.1) +## Release [v2.34.0](https://github.com/nginx/agent/releases/tag/v2.34.0) + +### 🌟 Highlights + +- Bump the version of net package in golang by [@oliveromahony](https://github.com/oliveromahony) in [#645](https://github.com/nginx/agent/pull/645) + +- Add health check endpoint by [@dhurley](https://github.com/dhurley) in [#665](https://github.com/nginx/agent/pull/665) + +- Add pending health status by [@dhurley](https://github.com/dhurley) in [#672](https://github.com/nginx/agent/pull/672) ### πŸ› Bug Fixes In this release we have resolved the following issues: -- fix: Tolerate additional fields in App Protect yaml files by [@edarzins](https://github.com/edarzins) in [#494](https://github.com/nginx/agent/pull/494) +- fix: fix titles case by [@Jcahilltorre](https://github.com/Jcahilltorre) in [#674](https://github.com/nginx/agent/pull/674) +- Fix oracle linux integration test by [@dhurley](https://github.com/dhurley) in [#676](https://github.com/nginx/agent/pull/676) + +### πŸ“ Documentation + +We have made the following updates to the documentation: + +- chore: add 2.33.0 changelog by [@Jcahilltorre](https://github.com/Jcahilltorre) in [#622](https://github.com/nginx/agent/pull/622) +- Change environment variable list to table with CLI references by [@ADubhlaoich](https://github.com/ADubhlaoich) in [#689](https://github.com/nginx/agent/pull/689) +- Add health checks documentation by [@dhurley](https://github.com/dhurley) in [#673](https://github.com/nginx/agent/pull/673) ### πŸ”¨ Maintenance We have made the following maintenance-related minor changes: -- Update nginx-plus-go-client to stop 404 errors in NGINX access logs by [@dhurley](https://github.com/dhurley) in [#495](https://github.com/nginx/agent/pull/495) +- Keep looking for master process by [@spencerugbo](https://github.com/spencerugbo) in [#617](https://github.com/nginx/agent/pull/617) +- Bump docker dependency to version v24.0.9 by [@dhurley](https://github.com/dhurley) in [#626](https://github.com/nginx/agent/pull/626) +- Bump the version of github.com/opencontainers/runc dependency by [@dhurley](https://github.com/dhurley) in [#657](https://github.com/nginx/agent/pull/657) +- Remove unnecessary freebsd logic for finding process executable by [@dhurley](https://github.com/dhurley) in [#668](https://github.com/nginx/agent/pull/668) +- Add additional checks in chunking functionality by [@dhurley](https://github.com/dhurley) in [#671](https://github.com/nginx/agent/pull/671) --- -## Release [v2.30.0](https//github.com/nginx/agent/releases/tag/v2.30.0) +## Release [v2.33.0](https://github.com/nginx/agent/releases/tag/v2.33.0) + +### πŸš€ Features + +This release introduces the following new features: + +- feat: Add Support for NAP 5 by [@edarzins](https://github.com/edarzins) in [#604](https://github.com/nginx/agent/pull/604) ### πŸ› Bug Fixes In this release we have resolved the following issues: -- Fix version for forked repo by [@dhurley](https://github.com/dhurley) in [#468](https://github.com/nginx/agent/pull/468) -- Fix integration tests by [@aphralG](https://github.com/aphralG) in [#478](https://github.com/nginx/agent/pull/478) -- Fix config apply by [@oliveromahony](https://github.com/oliveromahony) in [#480](https://github.com/nginx/agent/pull/480) -- deprecate system.mem.used.all metric by [@aphralG](https://github.com/aphralG) in [#485](https://github.com/nginx/agent/pull/485) +- Fix nfpm.yaml for apk packages by [@dhurley](https://github.com/dhurley) in [#597](https://github.com/nginx/agent/pull/597) +- fix unit test by [@oliveromahony](https://github.com/oliveromahony) in [#607](https://github.com/nginx/agent/pull/607) +- Fix user workflow performance tests by [@dhurley](https://github.com/dhurley) in [#612](https://github.com/nginx/agent/pull/612) +- fix Advanced Metrics by [@aphralG](https://github.com/aphralG) in [#598](https://github.com/nginx/agent/pull/598) ### πŸ“ Documentation We have made the following updates to the documentation: -- Update CLI flags documentation by [@Dean-Coakley](https://github.com/Dean-Coakley) in [#476](https://github.com/nginx/agent/pull/476) -- Update NGINX plugin to read NGINX config on startup by [@dhurley](https://github.com/dhurley) in [#489](https://github.com/nginx/agent/pull/489) +- chore: Add the 2.32.2 Changelog to the docs website by [@Jcahilltorre](https://github.com/Jcahilltorre) in [#601](https://github.com/nginx/agent/pull/601) ### πŸ”¨ Maintenance We have made the following maintenance-related minor changes: -- Update file watcher to ignore .swx files by [@dhurley](https://github.com/dhurley) in [#466](https://github.com/nginx/agent/pull/466) -- Check Simplemetrics is not empty by [@aphralG](https://github.com/aphralG) in [#474](https://github.com/nginx/agent/pull/474) -- Add error log if duplicate NGINX IDs are found by [@dhurley](https://github.com/dhurley) in [#477](https://github.com/nginx/agent/pull/477) -- Add tests for additional SSL directives and key algorithms. [#276](https://github.com/nginx/agent/issues/276) by [@arsenalzp](https://github.com/arsenalzp) in [#469](https://github.com/nginx/agent/pull/469) -- call underlying os.Hostname instead of the entire hostInfo gopsutil call by [@oliveromahony](https://github.com/oliveromahony) in [#479](https://github.com/nginx/agent/pull/479) -- Add grpc integration tests by [@dhurley](https://github.com/dhurley) in [#475](https://github.com/nginx/agent/pull/475) -- remove error log causing failures by [@aphralG](https://github.com/aphralG) in [#488](https://github.com/nginx/agent/pull/488) -- Use singleflight for caching environment.go calls by [@oliveromahony](https://github.com/oliveromahony) in [#481](https://github.com/nginx/agent/pull/481) -- Reduce the number of times env.Processes gets called by [@dhurley](https://github.com/dhurley) in [#482](https://github.com/nginx/agent/pull/482) -- add additional check to nginxProcesses by [@aphralG](https://github.com/aphralG) in [#483](https://github.com/nginx/agent/pull/483) -- profile.cgo by [@oliveromahony](https://github.com/oliveromahony) in [#493](https://github.com/nginx/agent/pull/493) +- Bump the version of protobuf by [@oliveromahony](https://github.com/oliveromahony) in [#602](https://github.com/nginx/agent/pull/602) +- replace duplicate isContainer call by [@oliveromahony](https://github.com/oliveromahony) in [#596](https://github.com/nginx/agent/pull/596) +- Add logging to NGINX API http requests by [@dhurley](https://github.com/dhurley) in [#605](https://github.com/nginx/agent/pull/605) + +--- +## Release [v2.32.2](https://github.com/nginx/agent/releases/tag/v2.32.2) + +### 🌟 Highlights + +- This release fixes an issue where certain container runtimes were reporting as bare-metal hosts. + +### πŸš€ Features + +This release introduces the following new features: +- feat: improve docker docs by [@Jcahilltorre](https://github.com/Jcahilltorre) in [#587](https://github.com/nginx/agent/pull/587) + +### πŸ› Bug Fixes + +In this release we have resolved the following issues: + +- Fix install-tools by [@Dean-Coakley](https://github.com/Dean-Coakley) in [#581](https://github.com/nginx/agent/pull/581) + +### πŸ“ Documentation + +We have made the following updates to the documentation: + +- change log updated for last release by [@oliveromahony](https://github.com/oliveromahony) in [#583](https://github.com/nginx/agent/pull/583) +- Restore agent container information from nms docs by [@jputrino](https://github.com/jputrino) in [#584](https://github.com/nginx/agent/pull/584) +- fix: add additional container checks during instance registration by [@mattdesmarais](https://github.com/mattdesmarais) in [#592](https://github.com/nginx/agent/pull/592)