Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

On-host Apache: Fix logic that allows mixture of Linux and Window instructions #18972

Open
wants to merge 7 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/install/apache/appInfo.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
componentType: appInfoConfig
headingText: Choose your framework
headingText: Select your environment
---
7 changes: 6 additions & 1 deletion src/install/apache/install-infra.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,9 @@ componentType: default
headingText: Install the infrastructure agent
---

To use the Apache integration, you need to also [install the infrastructure agent](/docs/infrastructure/install-infrastructure-agent/get-started/install-infrastructure-agent-new-relic/) on the same host. The infrastructure agent monitors the host itself, while the integration you'll install in the next step extends your monitoring with specific data such as database and instance metrics.
To use the Apache integration, you need our infrastructure agent on the same host. The infrastructure agent monitors the host itself, while the Apache integration extends monitoring to your Apache instance.

If you haven't already installed the infrastructure agent:

1. Open the [infrastructure agent](/docs/infrastructure/install-infrastructure-agent/get-started/install-infrastructure-agent-new-relic/) instructions in a new tab and complete that installation.
2. After you've installed in the infrastructure agent, return to this tab and complete the remaining steps to install and configure the Apache integration.
26 changes: 2 additions & 24 deletions src/install/apache/intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,30 +5,8 @@ componentType: default

Our Apache integration reports data from your Apache web server to the New Relic platform. You can view dashboards of your Apache metric data, create alert policies, and create your own custom queries and charts.

To get the most out of this page, select the installation method that fits your environment. You need a [New Relic account](https://newrelic.com/signup) before starting the installation process.
## Start our interactive instructions

<Callout variant="tip">
**Use guided install to quickly see your data in the UI**
First, make sure you have a [New Relic account](https://newrelic.com/signup). Then, select your environment to get customized instructions to install the Apache monitoring integration (the default steps below show a Linux installation with Apt).

The guided install is a single CLI command you can run to monitor your instance. It's a good option for small organizations, or for anyone who wants to test out New Relic.

<ButtonGroup>
<ButtonLink
role="button"
to="https://one.newrelic.com/marketplace/install-data-source?state=45bfc665-2948-40d2-898e-f289e8cae631"
variant="primary"
>
Guided install
</ButtonLink>

<ButtonLink
role="button"
to="https://one.eu.newrelic.com/marketplace/install-data-source?state=45bfc665-2948-40d2-898e-f289e8cae631"
variant="primary"
>
EU guided install
</ButtonLink>
</ButtonGroup>

For a more permanent and scalable solution, we recommend the standard manual install of the agent: keep reading for how to do that.
</Callout>
14 changes: 0 additions & 14 deletions src/install/apache/linux/install-tarball.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,4 @@ To install an integration from a tarball:
2. Unpack the tarball file according to our [integration file structure and placement rules](/docs/integrations/integrations-sdk/getting-started/integration-file-structure-activation), so the agent is able to find the definitions, configurations, and executables of the integration.
3. Place the binary that contains the definition file inside `newrelic-integrations` or `custom-integrations` in the [agent directory](/docs/infrastructure/install-configure-manage-infrastructure/linux-installation/tarball-manual-install-infrastructure-linux#agent-directory).
4. Place the integration's config file under the [plugin directory](/docs/infrastructure/install-configure-manage-infrastructure/linux-installation/tarball-manual-install-infrastructure-linux#configure-plugin).
5. Follow the JMX tool instructions below.

### Use of the New Relic JMX tool [#nrjmx]

Download the JMX tool from [our repository](https://download.newrelic.com/infrastructure_agent/binaries/linux/noarch/) and unpack it.

<Callout variant="important">
`nrjmx` requires Java 8 or higher.
</Callout>

For JMX integration version 2.3.3 or higher and Cassandra integration version 2.3.0 or higher, the `nrjmx` tool is included as a dependency. For this reason, when using a package manager, the `nrjmx` tool doesn't have to be installed manually.

If you have `nrjmx` already installed and install `nri-jmx`, our JMX tool keeps the already-installed version. If you don't have `nrjmx` already installed, it gets the latest `nrjmx` release.

By default, the `nrjmx` location is `/usr/bin/nrjmx/*`. To install in a different location, set the new path in the `NR_JMX_TOOL` environment variable.
46 changes: 23 additions & 23 deletions src/install/apache/whatsNext.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The Apache integration collects both metrics and inventory information. This tab

<tbody>
<tr>
<td>
<td class="children-nowrap">
`STATUS_URL`
</td>

Expand All @@ -48,7 +48,7 @@ The Apache integration collects both metrics and inventory information. This tab
</tr>

<tr>
<td>
<td class="children-nowrap">
[`REMOTE_MONITORING`](/docs/remote-monitoring-host-integrations)
</td>

Expand All @@ -70,7 +70,7 @@ The Apache integration collects both metrics and inventory information. This tab
}

<tr>
<td>
<td class="children-nowrap">
`BINARY_PATH`
</td>

Expand All @@ -92,7 +92,7 @@ The Apache integration collects both metrics and inventory information. This tab
}

<tr>
<td>
<td class="children-nowrap">
`CA_BUNDLE_FILE`
</td>

Expand All @@ -114,7 +114,7 @@ The Apache integration collects both metrics and inventory information. This tab
}

<tr>
<td>
<td class="children-nowrap">
`CA_BUNDLE_DIR`
</td>

Expand All @@ -136,7 +136,7 @@ The Apache integration collects both metrics and inventory information. This tab
}

<tr>
<td>
<td class="children-nowrap">
`VALIDATE_CERTS`
</td>

Expand All @@ -162,7 +162,7 @@ The Apache integration collects both metrics and inventory information. This tab
}

<tr>
<td>
<td class="children-nowrap">
`METRICS`
</td>

Expand All @@ -182,7 +182,7 @@ The Apache integration collects both metrics and inventory information. This tab
}

<tr>
<td>
<td class="children-nowrap">
`INVENTORY`
</td>

Expand Down Expand Up @@ -432,7 +432,7 @@ The Apache integration collects the following metric data attributes. Each metri

<tbody>
<tr>
<td>
<td class="children-nowrap">
`net.bytesPerSecond`
</td>

Expand All @@ -442,7 +442,7 @@ The Apache integration collects the following metric data attributes. Each metri
</tr>

<tr>
<td>
<td class="children-nowrap">
`net.requestsPerSecond`
</td>

Expand All @@ -452,7 +452,7 @@ The Apache integration collects the following metric data attributes. Each metri
</tr>

<tr>
<td>
<td class="children-nowrap">
`server.busyWorkers`
</td>

Expand All @@ -462,7 +462,7 @@ The Apache integration collects the following metric data attributes. Each metri
</tr>

<tr>
<td>
<td class="children-nowrap">
`server.idleWorkers`
</td>

Expand All @@ -472,7 +472,7 @@ The Apache integration collects the following metric data attributes. Each metri
</tr>

<tr>
<td>
<td class="children-nowrap">
`server.scoreboard.closingWorkers`
</td>

Expand All @@ -482,7 +482,7 @@ The Apache integration collects the following metric data attributes. Each metri
</tr>

<tr>
<td>
<td class="children-nowrap">
`server.scoreboard.dnsLookupWorkers`
</td>

Expand All @@ -492,7 +492,7 @@ The Apache integration collects the following metric data attributes. Each metri
</tr>

<tr>
<td>
<td class="children-nowrap">
`server.scoreboard.finishingWorkers`
</td>

Expand All @@ -502,7 +502,7 @@ The Apache integration collects the following metric data attributes. Each metri
</tr>

<tr>
<td>
<td class="children-nowrap">
`server.scoreboard.idleCleanupWorkers`
</td>

Expand All @@ -512,7 +512,7 @@ The Apache integration collects the following metric data attributes. Each metri
</tr>

<tr>
<td>
<td class="children-nowrap">
`server.scoreboard.keepAliveWorkers`
</td>

Expand All @@ -522,7 +522,7 @@ The Apache integration collects the following metric data attributes. Each metri
</tr>

<tr>
<td>
<td class="children-nowrap">
`server.scoreboard.loggingWorkers`
</td>

Expand All @@ -532,7 +532,7 @@ The Apache integration collects the following metric data attributes. Each metri
</tr>

<tr>
<td>
<td class="children-nowrap">
`server.scoreboard.readingWorkers`
</td>

Expand All @@ -542,7 +542,7 @@ The Apache integration collects the following metric data attributes. Each metri
</tr>

<tr>
<td>
<td class="children-nowrap">
`server.scoreboard.startingWorkers`
</td>

Expand All @@ -552,7 +552,7 @@ The Apache integration collects the following metric data attributes. Each metri
</tr>

<tr>
<td>
<td class="children-nowrap">
`server.scoreboard.totalWorkers`
</td>

Expand All @@ -562,7 +562,7 @@ The Apache integration collects the following metric data attributes. Each metri
</tr>

<tr>
<td>
<td class="children-nowrap">
`server.scoreboard.writingWorkers`
</td>

Expand Down Expand Up @@ -596,7 +596,7 @@ Besides the standard attributes collected by the infrastructure agent, the integ

<tbody>
<tr>
<td>
<td class="children-nowrap">
`software.version`
</td>

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
componentType: default
headingText: Configure the integration
headingText: Configure the integration
---

1. In the Integrations directory, `C:\Program Files\New Relic\newrelic-infra\integrations.d\`, create a copy of the sample configuration file by running:
Expand Down
51 changes: 28 additions & 23 deletions src/install/config/apache.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,14 @@ redirects:
- /docs/apache-integration-new-relic-infrastructure
- /docs/infrastructure/host-integrations/host-integrations-list/apache-monitoring-integration-new-relic-infrastructure
- /docs/infrastructure/host-integrations/host-integrations-list/apache-monitoring-integration


# -----------------------------------------------------------------
# Create the buttons for the question you want to ask:
# -----------------------------------------------------------------
appInfo:
- optionType: dropdown1
label: ''
placeholder: 'Select your environment'
options:
- value: 'linux'
displayName: 'Linux'
logo: 'linux'
recommendedGuided: true
- value: 'windows'
displayName: 'Windows'
logo: 'windows'
recommendedGuided: true
- optionType: deployment
label: "Choose your install path"
label: ""
placeholder: "Choose one:"
options:
- value: "msi"
Expand All @@ -46,10 +39,21 @@ appInfo:
recommendedGuided: true
logo: 'linux'

# ----------------------------------------------------
# Ask the first question and then provide instructions
# ----------------------------------------------------
steps:
# Step 1: Ask the user what kind of deployment--not their OS
- filePath: 'src/install/apache/appInfo.mdx'

# Step 2: Display the requirements
- filePath: 'src/install/apache/default-requirements.mdx'

# Step 3: Display the instructions to install the infra agent (prerequisite)
- filePath: 'src/install/apache/install-infra.mdx'

# Step 4: Display the Apache integration download and installation instructions
# based on their answer in question 1 above. Note the overrides:
- filePath: "src/install/apache/linux/install-apt.mdx"
overrides:
- filePath: "src/install/apache/linux/install-apt.mdx"
Copy link
Contributor

@akristen akristen Oct 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

line 57 nests install via APT into the default flow for the branching logic. This is persistent throughout all of these OHIs, and it's why all of them have "APT" int he right nav. To fix this, we need to add a new mdx file that's a "default install" step, then shift - filePath: "src/install/apache/linux/install-apt.mdx" as an option, not the default.

I make this fix in /install/microsoft-sql.yml on lines 62-64 for an example. :)

Expand All @@ -76,18 +80,19 @@ steps:
selectedOptions:
- optionType: deployment
options:
- value: "msi"
- filePath: 'src/install/apache/default-install-linux.mdx'
- value: "msi"

# Step 5: Display the configuration options
- filePath: 'src/install/apache/default-configuration-linux.mdx'
overrides:
- filePath: 'src/install/apache/linux/install-linux.mdx'
selectedOptions:
- optionType: dropdown1
options:
- value: 'linux'
- filePath: 'src/install/apache/windows/install-windows.mdx'
- filePath: 'src/install/apache/windows/configure-windows.mdx'
selectedOptions:
- optionType: dropdown1
- optionType: deployment
options:
- value: 'windows'
- value: 'msi'

# Step 6: View your data
- filePath: 'src/install/apache/find-data.mdx'

# Display a reference list of configurations and show some examples
whatsNextFilePath: 'src/install/apache/whatsNext.mdx'
Loading