> [!CAUTION]
> **Caution:** This documentation covers Edge for Private Cloud 4.18.01, which is no longer supported. Google does not provide security patches, bug fixes, or technical support for this version. The current supported version is 4.54.00. See the [Edge for Private Cloud documentation](https://docs.apigee.com/private-cloud/latest/overview) for the current version, or [All versions](https://docs.apigee.com/private-cloud/versions) to compare releases.

*Edge for Private Cloud v4.18.01*

> [!NOTE]
> **Note:** If you performed an All-In-One (AIO) Edge installation, where you install all Edge components on a single node, then you already installed the RPM files for the dashboard. Therefore, you can skip step 1, the install step, of the procedures below and proceed directly to step 2.

## System requirements

You must install `apigee-telegraf` on all the Edge nodes to
collect dashboard data. Therefore, the system requirements for `apigee-telegraf` are
the same as for the Edge
node on which you are installing it.

You can install `apigee-grafana`
on a separate node, or reuse one of the existing Edge nodes such as the Management Server or Edge
UI node.

For `apigee-influxdb`, you can
install it on an existing Edge node, such as the Management Server node or the Edge UI node, with
no change to the system requirements.

If you decide to install `apigee-influxdb` on its own node for
performance reasons, then the node should have the following requirements:

- 2 core CPU
- 4 GB RAM
- 250GB disk space (monitoring data purged after 1 month)
- 1000 or more IOPS

See the
[InfluxData doc](https://docs.influxdata.com/influxdb/v0.11/guides/hardware_sizing/#general-hardware-guidelines-for-clusters)
for more information.

## Port requirements for apigee-influxdb

Ports 8086 and 8183 must be open on the `apigee-influxdb` data nodes for access by the
node running `apigee-grafana` and
`apigee-telegraf`.

## Config files for installing dashboard
components

To install the `apigee-telegraf`
and `apigee-grafana` components,
you pass a config file to the `apigee-service` utility. Store these files in
a directory accessible by the 'apigee' user, such as `/opt/apigee/customer/application`,
and make them owned by the 'apigee' user.

### Configuration parameters for apigee-telegraf

Set these properties in a text file that you pass to the `apigee-telegraf setup`
command. For example, set them in a text file named `sa_telegraf.txt`:

| **Property** | **Description** |
|---|---|
| `INFLUXDB_URL` | Specify the URL of the apigee-influxdb node, including port 8086. For example: ``` http://192.168.0.1:8086 ``` |

### Configuration Parameters for apigee-grafana

Set these properties in a text file that you pass to the `apigee-grafana setup`
command. For example, set them in a text file named `sa_grafana.txt`:

| **Property** | **Description** |
|---|---|
| `INFLUXDB_HOST` | Specify the IP address or DNS name of the InfluxDB node. For Example: ``` 192.168.0.1 ``` |
| `INFLUXDB_PORT` | InfluxDB API port used by Grafana datasource. Specify 8086. |
| `GRAFANA_USERNAME` | Grafana username for logging in to the dashboard UI. |
| `GRAFANA_PASSWORD` | Grafana password for logging in to the dashboard UI. |

## Installation instructions

Follow the instructions below to install the dashboard components in this sequence:

- `apigee-influxdb` (on a central node)
- `apigee-telegraf` (on each node)
- `apigee-grafana` (on a central server)

> [!NOTE]
> **Note:** You must have installed the apigee-service utility on an Edge node to install the dashboard components. For more information on the `apigee-service` utility, including installation instructions for the utility, see [Install the Edge apigee-setup utility](https://docs.apigee.com/private-cloud/v4.18.01/install-edge-apigee-setup-utility).

### Install
apigee-influxdb on a single Edge node or standalone node

On a standalone node, or an Edge node running the Management Server or Edge UI:

1. Install `apigee-influxdb`:

   ```
   > /opt/apigee/apigee-service/bin/apigee-service apigee-influxdb install
   ```
2. Configure the `apigee-influxdb` database:

   ```
   > /opt/apigee/apigee-service/bin/apigee-service apigee-influxdb setup
   ```
3. Start `apigee-influxdb`:

   ```
   > /opt/apigee/apigee-service/bin/apigee-service apigee-influxdb start
   ```

### Install apigee-telegraf on
every Edge node

On every node of your Edge installation:

1. On your first Edge node, install `apigee-telegraf`:

   ```
   > /opt/apigee/apigee-service/bin/apigee-service apigee-telegraf install
   ```
2. Create a config file for `apigee-telegraf` named `sa_telegraf.txt`. Typically, you store this file in a directory accessible by the 'apigee' user, such as `/opt/apigee/customer/application`, and make it owned by the 'apigee' user.

   Set the following property in the file to specify the URL of the apigee-influxdb node,
   including port 8086:

   ```
   INFLUXDB_URL=http://influx_IP:8086
   ```
3. Change the owner to 'apigee':

   ```
   > chown apigee:apigee /opt/apigee/customer/application/sa_telegraf.txt
   ```
4. Configure `apigee-telegraf`:

   ```
   > /opt/apigee/apigee-service/bin/apigee-service apigee-telegraf setup -f
       /opt/apigee/customer/application/sa_telegraf.txt
   ```
5. Restart `apigee-telegraf`:

   ```
   > /opt/apigee/apigee-service/bin/apigee-service apigee-telegraf restart
   ```
6. Repeat this process on all Edge nodes.

### Install apigee-grafana on
a single Edge node

On a single node of your Edge installation, such as the Edge UI node:

1. On your first Edge node, install `apigee-grafana`:

   ```
   > /opt/apigee/apigee-service/bin/apigee-service apigee-grafana install
   ```
2. Create a config file for `apigee-grafana` named `sa_grafana.txt`. Typically, you store this file in a directory accessible by the 'apigee' user, such as `/opt/apigee/customer/application`, and make it owned by the 'apigee' user.

   Set the following properties in the file. These properties are described above:

   ```
   INFLUXDB_HOST=192.168.56.101
   INFLUXDB_PORT=8086
   GRAFANA_USERNAME=admin
   GRAFANA_PASSWORD=admin
   ```
3. Change the owner to 'apigee':

   ```
   > chown apigee:apigee /opt/apigee/customer/application/sa_grafana.txt
   ```
4. Configure `apigee-grafana` using the config file:

   ```
   > /opt/apigee/apigee-service/bin/apigee-service apigee-grafana setup -f
       /opt/apigee/customer/application/sa_grafana.txt
   ```
5. Restart `apigee-grafana`:

   ```
   > /opt/apigee/apigee-service/bin/apigee-service apigee-grafana restart
   ```

To access the dashboard, open the following URL in a browser:

```
http://grafana_IP_or_DNS:3000
```

Log in by using the credentials you specified in the config file for
`apigee-grafana`. In the example shown above
the username/password is admin/admin.

## Troubleshooting installation

If you do not see data appearing in the dashboard, use the following procedure to troubleshoot
your installation:

1. To ensure `apigee-telegraf` is collecting the data
   1. Run the `apigee-service apigee-telegraf setup`, it's idempotent, check for errors, missing dependencies and resolve them.
   2. Restart `apigee-telegraf` and check `/opt/apigee/var/log/apigee-telegraf/apigee-telegraf.log` for any errors
2. To ensure `apigee-influxdb` is receiving data:
   1. Make sure following TCP ports are open on `apigee-influxdb` data nodes: 8086 and 8183.
   2. Use the following URL to open the influxdb UI in a browser:

      ```
      http://influxdb_IP_or_DNS:8183
      ```
      1. In the Query field, enter "show databases". Ensure that the following databases were created: `system, application, events, _internal`.
      2. In the Query field, enter "show servers". Ensure that you see the `apigee-influxdb` nodes are listed.
3. Check the data sources to the dashboard:
   1. Select **Data Sources** in the main menu. You should see icons for three data sources displayed.
   2. For each data source, select the icon.
   3. In the details page for the data source, select the **Save \& Test** button.
   4. If the data source is configured correctly, you should see a message in the form:  
      **Success
      Data source is working**

## Updating the Beta monitoring dashboard

Use one of the two procedures below based on the Edge version that you are upgrading from:

- 4.16.09 and 4.17.0x use the same procedure
- 4.16.05 requires you to uninstall `apigee-collectd` as part of the update.

### Update from version
4.16.09 or 4.17.0x

If you installed the Beta version of the Apigee Monitoring Dashboard in 4.16.09 or 4.17.0x you
can update it to the Beta version for 4.18.01.

To update the Beta monitoring dashboard:

1. Update Edge to 4.18.01 as described at [Update Apigee Edge
   4.17.01/4.17.05 to 4.17.09](https://docs.apigee.com/private-cloud/v4.17.09/update-apigee-edge-4170141705-41709), [Update Apigee Edge 4.16.09 to
   4.17.09](https://docs.apigee.com/private-cloud/v4.17.09/update-apigee-edge-41609-41709), and [Update Apigee Edge 4.16.01/4.16.05 to 4.17.09](https://docs.apigee.com/private-cloud/v4.17.09/update-apigee-edge-4160141605-41709).
2. Update `apigee-influxdb` on the Management Server node:

   ```
   > /opt/apigee/apigee-setup/bin/update.sh -c pp -f configfile
   ```

   where <var translate="no">configFile</var> is the config file you used to install
   `apigee-influx`.

   If you also installed `apigee-grafana` on the Management
   Server node, then this step also updates `apigee-grafana`. Otherwise, update
   `apigee-granfana` as shown in the following step.
3. **If you did not install `apigee-grafana` on the
   Management Server node** , update `apigee-grafana` on the node where you installed it:

   ```
   > /opt/apigee/apigee-setup/bin/update.sh -c pp -f configfile
   ```
4. Update `apigee-telegraf` on node 1:

   ```
   > /opt/apigee/apigee-service/bin/apigee-service apigee-telegraf update
   > /opt/apigee/apigee-service/bin/apigee-service apigee-telegraf setup -f configFile
   > /opt/apigee/apigee-service/bin/apigee-service apigee-telegraf restart
   ```
5. Repeat step 4 for every node.

### Update from version 4.16.05

The 4.16.05 version of the dashboard used `apigee-collectd` instead of
`apigee-telegraf`. As part of updating to 4.18.01 you uninstall
`apigee-collectd` and install `apigee-telegraf`.

To update the Beta monitoring dashboard:

1. Update Edge to 4.18.01 as described at [Update Apigee Edge
   4.16.01/4.16.05 to 4.17.01](https://docs.apigee.com/private-cloud/v4.17.01/update-apigee-edge-4160141605-41701) and [Update Apigee Edge 4.16.09 to
   4.17.01](https://docs.apigee.com/private-cloud/v4.17.01/update-apigee-edge-41701).
2. Update `apigee-influxdb` on the Management Server node:

   ```
   > /opt/apigee/apigee-setup/bin/update.sh -c pp -f configfile
   ```

   where <var translate="no">configFile</var> is the config file you used to install
   `apigee-influx`.

   If you also installed `apigee-grafana` on the Management
   Server node, then this step also updates `apigee-grafana`. Otherwise, update
   `apigee-granfana` as shown in the following step.
3. **If you did not install `apigee-grafana` on the
   Management Server node** , update `apigee-grafana` on the node where you installed it:

   ```
   > /opt/apigee/apigee-setup/bin/update.sh -c pp -f configfile
   ```
4. Install `apigee-telegraf` on node 1:

   ```
   > /opt/apigee/apigee-service/bin/apigee-service apigee-collectd stop
   > /opt/apigee/apigee-service/bin/apigee-service apigee-telegraf install
   > /opt/apigee/apigee-service/bin/apigee-service apigee-telegraf setup -f configFile
   > /opt/apigee/apigee-service/bin/apigee-service apigee-telegraf restart
   > /opt/apigee/apigee-service/bin/apigee-service apigee-collectd uninstall
   ```
5. Repeat step 4 for every node.