https://github.com/nginx/agent

NGINX Agent provides an administrative entry point to remotely manage, configure and collect metrics and events from NGINX instances
https://github.com/nginx/agent

agent api good-first-issue metrics metrics-gathering monitoring-tool nginx nginx-configuration nginx-server observability

Last synced: 5 days ago
JSON representation

NGINX Agent provides an administrative entry point to remotely manage, configure and collect metrics and events from NGINX instances

• Host: GitHub
• URL: https://github.com/nginx/agent
• Owner: nginx
• License: apache-2.0
• Created: 2022-07-19T15:30:43.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2026-01-19T21:31:45.000Z (7 days ago)
• Last Synced: 2026-01-19T23:19:36.691Z (7 days ago)
• Topics: agent, api, good-first-issue, metrics, metrics-gathering, monitoring-tool, nginx, nginx-configuration, nginx-server, observability
• Language: Go
• Homepage: https://docs.nginx.com/nginx-agent/
• Size: 77.4 MB
• Stars: 343
• Watchers: 33
• Forks: 105
• Open Issues: 27
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

          
![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/nginx/agent)

![GitHub Release](https://img.shields.io/github/v/release/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)

![coverage](https://raw.githubusercontent.com/nginx/agent/badges/.badges/v3/coverage.svg)

# F5 NGINX Agent 

F5 NGINX Agent is a companion application designed to efficiently manage NGINX instances. Key features include: 

- Remote management: Easily control and configure NGINX instances remotely.  

- Real-time metrics: Monitor and analyze performance data for NGINX and the underlying operating system.

Discover more advanced features and capabilities by visiting [Try NGINX One: Free Enterprise Trial](https://www.f5.com/trials/nginx-one). 

## Installation

You can install **NGINX Agent** using one of the following methods:

1. **Official documentation**  

   Follow the step-by-step guide to add and configure instances:  

   [How to add an instance](https://docs.nginx.com/nginx-one/how-to/nginx-configs/add-instance/)

2. **GitHub releases**  

   Download the latest binaries or packages directly from the GitHub releases page:  

   [NGINX Agent GitHub releases](https://github.com/nginx/agent/releases)  

3. **Installation and upgrade guide**  

   Access detailed instructions to install or upgrade NGINX Agent from the official NGINX documentation:  

   [NGINX Agent Installation Guide](https://docs.nginx.com/nginx-agent/installation-upgrade/)

## Useful links

* [v2 - Official NGINX Agent documentation](https://docs.nginx.com/nginx-agent/)

* [v3 - Official NGINX Agent documentation](https://docs.nginx.com/nginx-one-console/agent/)

* [F5 Support](https://my.f5.com/manage/s/)

## Community 

If you have any questions please reach out using the [NGINX Community](https://community.nginx.org/)