Skip to content

Commit

Permalink
fix(Infrastructure): NGINX should always be all-caps (#18245)
Browse files Browse the repository at this point in the history
  • Loading branch information
paperclypse authored Aug 2, 2024
1 parent ae6a0fd commit a334f24
Showing 1 changed file with 23 additions and 23 deletions.
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: New Relic Nginx integration buildpack for VMware Tanzu
title: New Relic NGINX integration buildpack for VMware Tanzu
tags:
- Integrations
- Cloudfoundry
- Tanzu
- Nginx
- NGINX
- Infrastrucure
metaDescription: Use our integration to gain increased visibility into the performance of your VMware Tanzu environment.
freshnessValidatedDate: 2024-07-30
Expand All @@ -15,23 +15,23 @@ redirects:
import integrationsNginxIntegrationBuildpackforVMwareTanzu from 'images/integrations_screenshot-full_Nginx-Integration-Buildpack-for-VMware-Tanzu.webp'


Streamline NGINX monitoring and troubleshooting with the New Relic Nginx integration buildpack for VMware Tanzu. By automatically collecting and sending detailed inventory and performance metrics to the New Relic platform, you gain invaluable insights into connections, client requests, and overall server health. Correlate this data with VMware Tanzu infrastructure metrics from the [New Relic Firehose Nozzle](/docs/infrastructure/host-integrations/host-integrations-list/cloudfoundry-integrations/vmware-tanzu-firehose-nozzle-integration/) for comprehensive environment visibility and rapid issue resolution.
Streamline NGINX monitoring and troubleshooting with the New Relic NGINX integration buildpack for VMware Tanzu. By automatically collecting and sending detailed inventory and performance metrics to the New Relic platform, you gain invaluable insights into connections, client requests, and overall server health. Correlate this data with VMware Tanzu infrastructure metrics from the [New Relic Firehose Nozzle](/docs/infrastructure/host-integrations/host-integrations-list/cloudfoundry-integrations/vmware-tanzu-firehose-nozzle-integration/) for comprehensive environment visibility and rapid issue resolution.

## Requirements and compatibility [#requirements-compatibility]

This product has been tested and is compatible with VMware Tanzu OpsManager versions up to and including v3.0 and Tanzu Application Service 5.0 and 6.0.

The New Relic Nginx integration buildpack for VMware Tanzu requires the following:
The New Relic NGINX integration buildpack for VMware Tanzu requires the following:

* CF CLI: Version 6.38 or later is needed as this buildpack is installed as a multi-buildpack in the app manifest.
* Nginx buildpack: This buildpack must be installed on top of the [`nginx_buildpack`](https://support.broadcom.com/group/ecx/productdownloads?subfamily=NGINX%20Buildpack).
* New Relic account and license key: An active New Relic account with a license key is required. This key is used to bind Nginx servers to the New Relic infrastructure agent, which transmits metrics to the New Relic platform.
* NGINX buildpack: This buildpack must be installed on top of the [`nginx_buildpack`](https://support.broadcom.com/group/ecx/productdownloads?subfamily=NGINX%20Buildpack).
* New Relic account and license key: An active New Relic account with a license key is required. This key is used to bind NGINX servers to the New Relic infrastructure agent, which transmits metrics to the New Relic platform.

For general information about adding multiple buildpacks to manifests, see [Cloud Foundry documentation: Pushing an app with multiple buildpacks](https://docs.cloudfoundry.org/buildpacks/use-multiple-buildpacks.html).

### Version and support information [#version-and-support]

The following table provides version support information about the New Relic Nginx integration buildpack for VMware Tanzu.
The following table provides version support information about the New Relic NGINX integration buildpack for VMware Tanzu.

<table>
<thead>
Expand All @@ -51,7 +51,7 @@ The following table provides version support information about the New Relic Ngi
</tr>
<tr>
<td>Software component version</td>
<td>New Relic Nginx integration buildpack for VMware Tanzu 1.0.1</td>
<td>New Relic NGINX integration buildpack for VMware Tanzu 1.0.1</td>
</tr>
<tr>
<td>Compatible Ops Manager version(s)</td>
Expand All @@ -74,7 +74,7 @@ The following table provides version support information about the New Relic Ngi

## Installation and configuration [#install-and-configure]

This section describes how to install and configure the New Relic Nginx integration buildpack for VMware Tanzu.
This section describes how to install and configure the New Relic NGINX integration buildpack for VMware Tanzu.

You can install the buildpacks either as a tile in Ops Manager or individually using the CF CLI.

Expand All @@ -98,10 +98,10 @@ You can install the buildpacks either as a tile in Ops Manager or individually u
Navigate to the Ops Manager Installation Dashboard and click **Import a Product** to upload the product file.
</Step>
<Step>
Under the **Import a Product** button, click the **+** sign next to the version number of **New Relic Nginx Buildpack for Tanzu** to add the tile to your staging area.
Under the **Import a Product** button, click the **+** sign next to the version number of **New Relic NGINX Buildpack for Tanzu** to add the tile to your staging area.
</Step>
<Step>
Click the newly added **New Relic Nginx Buildpack for Tanzu** tile.
Click the newly added **New Relic NGINX Buildpack for Tanzu** tile.
</Step>
<Step>
1. Install and configure the tile in Ops Manager. You can accept the default values to install both buildpacks in your PCF foundation or select the checkbox for any buildpacks you wish to install under **Tile Configuration > New Relic Buildpack Selection**.
Expand Down Expand Up @@ -266,13 +266,13 @@ The buildpacks in this tile are pre-built and ready for use in Cloud Foundry. Ho

* [`buildpack.yml`](https://docs.cloudfoundry.org/buildpacks/nginx/index.html):
* Contains configuration for the buildpack.
* Action required: Update the Nginx version information to ensure compatibility with the latest version of the Nginx buildpack.
* Action required: Update the NGINX version information to ensure compatibility with the latest version of the NGINX buildpack.

* `manifest.yml`:
* Defines the application-related configurations and metadata.
* Action required: Update this file with the correct application information and ensure the buildpack order is correctly specified. This is crucial for the proper deployment of your application.
* New Relic license key: This integration requires a [license key](/docs/apis/intro-apis/new-relic-api-keys/#license-key). You can set it in the `manifest.yml` file using the environment variable `NEW_RELIC_LICENSE_KEY: <ingest_key_value>`. Alternatively, the license key can be obtained from the New Relic service broker by binding the application.
* Status port: Based on your Nginx configuration, the status port information is required. The default port value is `8080`, which can be set using the environment variable `STATUS_PORT: 8080`.
* Status port: Based on your NGINX configuration, the status port information is required. The default port value is `8080`, which can be set using the environment variable `STATUS_PORT: 8080`.
* Note: Additional [environmental variables](/docs/infrastructure/install-infrastructure-agent/configuration/infrastructure-agent-configuration-settings/) can be set as per your requirements.
* The `nginx_buildpack` must be installed before `newrelic_nginx_buildpack`.
* Example: `cf push my_app -b nginx_buildpack -b newrelic_nginx_buildpack`
Expand All @@ -281,21 +281,21 @@ The buildpacks in this tile are pre-built and ready for use in Cloud Foundry. Ho
* [nginx_buildpack documentation](https://docs.cloudfoundry.org/buildpacks/nginx/index.html)

* [`mime.types`](https://docs.cloudfoundry.org/buildpacks/nginx/index.html):
* Specifies MIME types required by the Nginx buildpack.
* Note: Required by the Nginx buildpack for serving different file types with appropriate MIME types.
* Specifies MIME types required by the NGINX buildpack.
* Note: Required by the NGINX buildpack for serving different file types with appropriate MIME types.

* [`nginx.conf`](https://docs.cloudfoundry.org/buildpacks/nginx/index.html):
* A primary template configuration file for Nginx.
* Note: Required by the Nginx buildpack to configure how Nginx serves the application. Ensure that `location /nginx_status` in `nginx.conf` matches the `STATUS_URL` in `nginx-config.yml`.
* A primary template configuration file for NGINX.
* Note: Required by the NGINX buildpack to configure how NGINX serves the application. Ensure that `location /nginx_status` in `nginx.conf` matches the `STATUS_URL` in `nginx-config.yml`.

* [`nginx-config.yml`](/install/nginx/):
* This template contains configuration settings for New Relic Nginx integration.
* Action required: Refer to the [New Relic Nginx documentation](/install/nginx/) to understand various configuration options and adjust settings as necessary.
* This template contains configuration settings for New Relic NGINX integration.
* Action required: Refer to the [New Relic NGINX documentation](/install/nginx/) to understand various configuration options and adjust settings as necessary.
* Note: Ensure that the `location /nginx_status` in `nginx.conf` matches the `STATUS_URL` in `nginx-config.yml`.

* `public`:
* Contains static files that Nginx will serve.
* Note: The `index.html` file is crucial as the default file served by Nginx.
* Contains static files that NGINX will serve.
* Note: The `index.html` file is crucial as the default file served by NGINX.

Additional notes:

Expand Down Expand Up @@ -347,7 +347,7 @@ To integrate your application with the [New Relic Broker Service](/docs/infrastr

## Monitoring with New Relic [#monitoring-with-New-Relic]

Once the application is successfully pushed, the Nginx integration will start sending NGINX metrics to New Relic.
Once the application is successfully pushed, the NGINX integration will start sending NGINX metrics to New Relic.

To install the dashboard, [follow these UI instructions](https://one.newrelic.com/catalog-pack-details?state=952adb8f-8cd8-17ec-a55e-2a470ff27b54). Make sure you skip the installation and directly install the dashboard.

Expand All @@ -360,7 +360,7 @@ To install the dashboard, [follow these UI instructions](https://one.newrelic.co
You may also explore data further under **All entities > On Hosts > NGINX Servers**.

<Callout variant="important">
The cached version of this integration buildpack contains New Relic infrastructure agent `1.53.0` and New Relic Nginx integration `3.4.6`.
The cached version of this integration buildpack contains New Relic infrastructure agent `1.53.0` and New Relic NGINX integration `3.4.6`.
</Callout>

## Leave us feedback [#feedback]
Expand Down

0 comments on commit a334f24

Please sign in to comment.