Skip to content

Commit

Permalink
feat(OHI IBM MQ): Added branching doc structure
Browse files Browse the repository at this point in the history
  • Loading branch information
nbaenam committed Feb 15, 2024
1 parent fda6b17 commit ee40bf0
Show file tree
Hide file tree
Showing 18 changed files with 3,458 additions and 0 deletions.
98 changes: 98 additions & 0 deletions src/install/config/ibm-mq.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
agentName: ibm-mq
agentType: integration
title: 'IBM MQ monitoring integration'
metaDescription: 'Install the IBM MQ integration'
introFilePath: 'src/install/ibm-mq/intro.mdx'
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"
placeholder: "Choose one:"
options:
- value: "msi"
displayName: "Install using MSI files (Windows)"
logo: 'windows'
recommendedGuided: true
- value: "apt"
displayName: "Install using Apt (Debian, Ubuntu)"
recommendedGuided: true
- value: "yum"
logo: 'linux'
displayName: "Install using Yum (Amazon Linux, CentOS, RHEL)"
recommendedGuided: true
- value: "zypper"
displayName: "Install using Zypper (SLES)"
recommendedGuided: true
logo: 'linux'
- value: "tar"
displayName: "Install from tarball (Other Linux distros)"
recommendedGuided: true
logo: 'linux'
steps:
- filePath: 'src/install/ibm-mq/appInfo.mdx'
- filePath: 'src/install/ibm-mq/default-requirements.mdx'
overrides:
- filePath: 'src/install/ibm-mq/linux/requirements-linux.mdx'
selectedOptions:
- optionType: dropdown1
options:
- value: 'linux'
- filePath: 'src/install/ibm-mq/windows/requirements-windows.mdx'
selectedOptions:
- optionType: dropdown1
options:
- value: 'windows'
- filePath: 'src/install/ibm-mq/install-infra.mdx'
- filePath: "src/install/ibm-mq/linux/install-apt.mdx"
overrides:
- filePath: "src/install/ibm-mq/linux/install-apt.mdx"
selectedOptions:
- optionType: deployment
options:
- value: "apt"
- filePath: "src/install/ibm-mq/linux/install-tarball.mdx"
selectedOptions:
- optionType: deployment
options:
- value: "tar"
- filePath: "src/install/ibm-mq/linux/install-yum.mdx"
selectedOptions:
- optionType: deployment
options:
- value: "yum"
- filePath: "src/install/ibm-mq/linux/install-zypper.mdx"
selectedOptions:
- optionType: deployment
options:
- value: "zypper"
- filePath: "src/install/ibm-mq/windows/install-msi.mdx"
selectedOptions:
- optionType: deployment
options:
- value: "msi"
- filePath: 'src/install/ibm-mq/default-install.mdx'
overrides:
- filePath: 'src/install/ibm-mq/linux/install-linux.mdx'
selectedOptions:
- optionType: dropdown1
options:
- value: 'linux'
- filePath: 'src/install/ibm-mq/windows/install-windows.mdx'
selectedOptions:
- optionType: dropdown1
options:
- value: 'windows'
- filePath: 'src/install/ibm-mq/find-data.mdx'

whatsNextFilePath: 'src/install/ibm-mq/whatsNext.mdx'
9 changes: 9 additions & 0 deletions src/install/ibm-mq/appInfo.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
componentType: appInfoConfig
headingText: Choose your framework
---





6 changes: 6 additions & 0 deletions src/install/ibm-mq/default-install.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
headingText: Install the IBM MQ monitoring integration
componentType: default
---

To install the integration, follow the instructions for your environment:
5 changes: 5 additions & 0 deletions src/install/ibm-mq/default-requirements.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
headingText: Check the compatibility and requirements
componentType: default
---

16 changes: 16 additions & 0 deletions src/install/ibm-mq/find-data.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
componentType: default
headingText: Find and use data
---

Follow these steps:

1. Go to **[one.newrelic.com](https://one.newrelic.com) > Add data** and type **IBM MQ**.
2. Under **Dashboards**, click **IBM MQ dashboard**.
3. A popup window opens.
4. Click **Edit** to change the account.
5. Click **Setup IBM MQ integration** or **Skip this step** if you already setup this datasource.
6. Click **View dashboard** to see your IBM MQ data in New Relic.

For more on how to find and use your data, see how to [understand integration data](/docs/infrastructure/integrations/find-use-infrastructure-integration-data). You can find a full list of metrics and their attributes at the bottom of this doc.

6 changes: 6 additions & 0 deletions src/install/ibm-mq/install-infra.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
componentType: default
headingText: Install the infrastructure agent
---

To use the IBM MQ 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 IBM MQ-specific data such as database and instance metrics.
34 changes: 34 additions & 0 deletions src/install/ibm-mq/intro.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
headingText: Before we start
componentType: default
---

import infrastructureIbmmqDashboard from 'images/infrastructure_screenshot-crop_ibmmq-dashboard.webp'

<Callout title="Public preview">
This feature is currently a public preview.
</Callout>

Our IBM MQ [integration](/docs/integrations/host-integrations/getting-started/introduction-host-integrations)
collects and sends dimensional metrics from [IBM MQ](https://www.ibm.com/products/mq).

You can view this [metric data](#metrics) in pre-built dashboards, create alerts policies, and create custom queries and charts.

<img
title="IBM MQ quickstart dashboard"
alt="Image of the dashboard available through the IBM MQ quickstart"
src={infrastructureIbmmqDashboard}
/>

<figcaption>
Dashboard installed through the [New Relic IBM MQ Monitor quickstart](https://one.newrelic.com/nr1-core?state=c95ed954-7277-e44d-7fd7-351a77b3ff37).
</figcaption>

To get data from IBM MQ infrastructure, our IBM MQ integration uses a third-party [Prometheus exporter](https://github.com/ibm-messaging/mq-metric-samples/tree/master/cmd/mq_prometheus), which exposes Prometheus metrics on the port specified in the configuration. The integration collects these metrics, filters them, and then sends them to New Relic.


<Callout variant="important">
The IBM MQ integration doesn't support ARM64 architecture.
</Callout>

To start set up the IBM MQ integration, follow these steps:
14 changes: 14 additions & 0 deletions src/install/ibm-mq/linux/install-apt.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
componentType: default
headingText: Download using APT
---

In your terminal, run these commands:

```shell
sudo apt-get update
```

```shell
sudo apt-get install nri-ibmmq
```
35 changes: 35 additions & 0 deletions src/install/ibm-mq/linux/install-linux.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
componentType: default
headingText: Configure the IBM MQ monitoring integration
---

1. Change directory to the integrations configuration folder by running:

```shell
cd /etc/newrelic-infra/integrations.d
```

2. Copy the sample configuration file by running:

```shell
sudo cp ibmmq-config.yml.sample ibmmq-config.yml
```

3. Edit the `ibmmq-config.yml` file to collect all metrics and inventory from your local host. See this example:

```yml
integrations:
- name: nri-ibmmq
env:
HOSTNAME: localhost
PORT: 9200
USERNAME: ibmmq_user
PASSWORD: ibmmq_password
CONFIG_PATH: /etc/ibmmq/ibmmq.yml
interval: 15s
labels:
environment: production
inventory_source: config/ibmmq
```

You can find all the config options at the bottom of this doc along with more complex config examples.
32 changes: 32 additions & 0 deletions src/install/ibm-mq/linux/install-tarball.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
componentType: default
headingText: Download using tarball
---


<Callout variant="tip">
We recommend using your distribution package manager to [install the infrastructure agent](/docs/infrastructure/install-configure-manage-infrastructure/linux-installation/install-infrastructure-linux-using-package-manager). If you choose to [manually install the agent](/docs/infrastructure/install-configure-manage-infrastructure/linux-installation/tarball-manual-install-infrastructure-linux), you may also want to install the on-host integrations from the provided tarballs.

The manual install process isn't automated. If you install it manually, you must place the different files in the correct folders, and ensure that the agent has all the permissions to execute the integrations.
</Callout>

To install an integration from a tarball:

1. Download the packaged integration file from the [tarball repository](https://download.newrelic.com/infrastructure_agent/binaries/linux/amd64/).

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 can 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. Download the JMX tool from [our repository](https://download.newrelic.com/infrastructure_agent/binaries/linux/noarch/) and unpack it. Some notes on compatibility:

* 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.

* `nrjmx` requires Java 8 or higher.

* 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.

14 changes: 14 additions & 0 deletions src/install/ibm-mq/linux/install-yum.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
componentType: default
headingText: Download using Yum
---

In your terminal, run these commands:

```shell
sudo yum -q makecache -y --disablerepo='*' --enablerepo='newrelic-infra'
```

```shell
sudo yum install nri-ibmmq
```
14 changes: 14 additions & 0 deletions src/install/ibm-mq/linux/install-zypper.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
componentType: default
headingText: Download using Zypper
---

In your terminal, run these commands:

```shell
sudo zypper -n ref -r newrelic-infra
```

```shell
sudo zypper -n install nri-ibmmq
```
14 changes: 14 additions & 0 deletions src/install/ibm-mq/linux/requirements-linux.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
componentType: default
headingText: Check the compatibility and requirements
---


* Make sure that you have the [IBM MQ Redistributable Client libraries](https://public.dhe.ibm.com/ibmdl/export/pub/software/websphere/messaging/mqdev/redist/) installed on the host where the agent and the integration are running.

* Add the libraries path in the `LD_LIBRARY_PATH` environment variable in Linux.

* Ensure [queue statistics monitoring](https://www.ibm.com/docs/en/capmp/8.1.4?topic=monitoring-enabling-queue-statistics-queue-manager-mq) is enabled on MQ.

* [Create a user](https://www.ibm.com/docs/en/mq-appliance/9.1?topic=commands-usercreate-create-user) in MQ with read-only permissions.

14 changes: 14 additions & 0 deletions src/install/ibm-mq/linux/requirements-tarball.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
componentType: default
headingText: Check the compatibility and requirements
---

* [Install the infrastructure agent](/docs/infrastructure/install-infrastructure-agent/get-started/install-infrastructure-agent-new-relic), minimum version 1.24.0.

* Verify your Linux distribution or Windows version is [compatible with the infrastructure agent](/docs/infrastructure/new-relic-infrastructure/getting-started/compatibility-requirements-new-relic-infrastructure#operating-systems).

* Make sure that you have the [IBM MQ Redistributable Client libraries](https://public.dhe.ibm.com/ibmdl/export/pub/software/websphere/messaging/mqdev/redist/) installed on the host where the agent and the integration are running.

* Ensure [queue statistics monitoring](https://www.ibm.com/docs/en/capmp/8.1.4?topic=monitoring-enabling-queue-statistics-queue-manager-mq) is enabled on MQ.

* [Create a user](https://www.ibm.com/docs/en/mq-appliance/9.1?topic=commands-usercreate-create-user) in MQ with read-only permissions.

0 comments on commit ee40bf0

Please sign in to comment.